/mandos/trunk

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/trunk

« back to all changes in this revision

Viewing changes to plugin-runner.xml

  • Committer: Teddy Hogeborn
  • Date: 2015-12-05 01:29:53 UTC
  • mto: This revision was merged to the branch mainline in revision 794.
  • Revision ID: teddy@recompile.se-20151205012953-oi5hosp5yqhrmudh
Tags: version-1.7.1-2
http://bugs.debian.org/804967
http://bugs.debian.org/806073
* debian/changelog (1.7.1-2): New entry.

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugin-runner.xml
2
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
3
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
4
<!ENTITY COMMANDNAME "plugin-runner">
5
 
<!ENTITY TIMESTAMP "2011-10-05">
 
5
<!ENTITY TIMESTAMP "2015-07-20">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
33
33
    <copyright>
34
34
      <year>2008</year>
35
35
      <year>2009</year>
 
36
      <year>2010</year>
36
37
      <year>2011</year>
 
38
      <year>2012</year>
 
39
      <year>2013</year>
 
40
      <year>2014</year>
 
41
      <year>2015</year>
37
42
      <holder>Teddy Hogeborn</holder>
38
43
      <holder>Björn Påhlsson</holder>
39
44
    </copyright>
114
119
      <arg><option>--plugin-dir=<replaceable
115
120
      >DIRECTORY</replaceable></option></arg>
116
121
      <sbr/>
 
122
      <arg><option>--plugin-helper-dir=<replaceable
 
123
      >DIRECTORY</replaceable></option></arg>
 
124
      <sbr/>
117
125
      <arg><option>--config-file=<replaceable
118
126
      >FILE</replaceable></option></arg>
119
127
      <sbr/>
320
328
      </varlistentry>
321
329
      
322
330
      <varlistentry>
 
331
        <term><option>--plugin-helper-dir
 
332
        <replaceable>DIRECTORY</replaceable></option></term>
 
333
        <listitem>
 
334
          <para>
 
335
            Specify a different plugin helper directory.  The default
 
336
            is <filename>/lib/mandos/plugin-helpers</filename>, which
 
337
            will exist in the initial <acronym>RAM</acronym> disk
 
338
            environment.  (This will simply be passed to all plugins
 
339
            via the <envar>MANDOSPLUGINHELPERDIR</envar> environment
 
340
            variable.  See <xref linkend="writing_plugins"/>)
 
341
          </para>
 
342
        </listitem>
 
343
      </varlistentry>
 
344
      
 
345
      <varlistentry>
323
346
        <term><option>--config-file
324
347
        <replaceable>FILE</replaceable></option></term>
325
348
        <listitem>
426
449
      <para>
427
450
        The plugin will run in the initial RAM disk environment, so
428
451
        care must be taken not to depend on any files or running
429
 
        services not available there.
 
452
        services not available there.  Any helper executables required
 
453
        by the plugin (which are not in the <envar>PATH</envar>) can
 
454
        be placed in the plugin helper directory, the name of which
 
455
        will be made available to the plugin via the
 
456
        <envar>MANDOSPLUGINHELPERDIR</envar> environment variable.
430
457
      </para>
431
458
      <para>
432
459
        The plugin must exit cleanly and free all allocated resources
475
502
      only passes on its environment to all the plugins.  The
476
503
      environment passed to plugins can be modified using the
477
504
      <option>--global-env</option> and <option>--env-for</option>
478
 
      options.
 
505
      options.  Also, the <option>--plugin-helper-dir</option> option
 
506
      will affect the environment variable
 
507
      <envar>MANDOSPLUGINHELPERDIR</envar> for the plugins.
479
508
    </para>
480
509
  </refsect1>
481
510
  
572
601
    </informalexample>
573
602
    <informalexample>
574
603
      <para>
575
 
        Run plugins from a different directory, read a different
576
 
        configuration file, and add two options to the
 
604
        Read a different configuration file, run plugins from a
 
605
        different directory, specify an alternate plugin helper
 
606
        directory and add two options to the
577
607
        <citerefentry><refentrytitle >mandos-client</refentrytitle>
578
608
        <manvolnum>8mandos</manvolnum></citerefentry> plugin:
579
609
      </para>
580
610
      <para>
581
611
 
582
612
<!-- do not wrap this line -->
583
 
<userinput>cd /etc/keys/mandos; &COMMANDNAME;  --config-file=/etc/mandos/plugin-runner.conf --plugin-dir /usr/lib/mandos/plugins.d --options-for=mandos-client:--pubkey=pubkey.txt,--seckey=seckey.txt</userinput>
 
613
<userinput>cd /etc/keys/mandos; &COMMANDNAME;  --config-file=/etc/mandos/plugin-runner.conf --plugin-dir /usr/lib/x86_64-linux-gnu/mandos/plugins.d --plugin-helper-dir /usr/lib/x86_64-linux-gnu/mandos/plugin-helpers --options-for=mandos-client:--pubkey=pubkey.txt,--seckey=seckey.txt</userinput>
584
614
 
585
615
      </para>
586
616
    </informalexample>