/mandos/release

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

« back to all changes in this revision

Viewing changes to plugin-runner.xml

Merge general D-Bus annotations support.

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 "2018-02-08">
 
5
<!ENTITY TIMESTAMP "2012-01-01">
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>
37
 
      <year>2011</year>
38
36
      <year>2012</year>
39
 
      <year>2013</year>
40
 
      <year>2014</year>
41
 
      <year>2015</year>
42
 
      <year>2016</year>
43
 
      <year>2017</year>
44
 
      <year>2018</year>
45
37
      <holder>Teddy Hogeborn</holder>
46
38
      <holder>Björn Påhlsson</holder>
47
39
    </copyright>
122
114
      <arg><option>--plugin-dir=<replaceable
123
115
      >DIRECTORY</replaceable></option></arg>
124
116
      <sbr/>
125
 
      <arg><option>--plugin-helper-dir=<replaceable
126
 
      >DIRECTORY</replaceable></option></arg>
127
 
      <sbr/>
128
117
      <arg><option>--config-file=<replaceable
129
118
      >FILE</replaceable></option></arg>
130
119
      <sbr/>
331
320
      </varlistentry>
332
321
      
333
322
      <varlistentry>
334
 
        <term><option>--plugin-helper-dir
335
 
        <replaceable>DIRECTORY</replaceable></option></term>
336
 
        <listitem>
337
 
          <para>
338
 
            Specify a different plugin helper directory.  The default
339
 
            is <filename>/lib/mandos/plugin-helpers</filename>, which
340
 
            will exist in the initial <acronym>RAM</acronym> disk
341
 
            environment.  (This will simply be passed to all plugins
342
 
            via the <envar>MANDOSPLUGINHELPERDIR</envar> environment
343
 
            variable.  See <xref linkend="writing_plugins"/>)
344
 
          </para>
345
 
        </listitem>
346
 
      </varlistentry>
347
 
      
348
 
      <varlistentry>
349
323
        <term><option>--config-file
350
324
        <replaceable>FILE</replaceable></option></term>
351
325
        <listitem>
452
426
      <para>
453
427
        The plugin will run in the initial RAM disk environment, so
454
428
        care must be taken not to depend on any files or running
455
 
        services not available there.  Any helper executables required
456
 
        by the plugin (which are not in the <envar>PATH</envar>) can
457
 
        be placed in the plugin helper directory, the name of which
458
 
        will be made available to the plugin via the
459
 
        <envar>MANDOSPLUGINHELPERDIR</envar> environment variable.
 
429
        services not available there.
460
430
      </para>
461
431
      <para>
462
432
        The plugin must exit cleanly and free all allocated resources
505
475
      only passes on its environment to all the plugins.  The
506
476
      environment passed to plugins can be modified using the
507
477
      <option>--global-env</option> and <option>--env-for</option>
508
 
      options.  Also, the <option>--plugin-helper-dir</option> option
509
 
      will affect the environment variable
510
 
      <envar>MANDOSPLUGINHELPERDIR</envar> for the plugins.
 
478
      options.
511
479
    </para>
512
480
  </refsect1>
513
481
  
546
514
            </para>
547
515
          </listitem>
548
516
        </varlistentry>
549
 
        <varlistentry>
550
 
          <term><filename class="directory"
551
 
          >/lib/mandos/plugins.d</filename></term>
552
 
          <listitem>
553
 
            <para>
554
 
              The default plugin directory; can be changed by the
555
 
              <option>--plugin-dir</option> option.
556
 
            </para>
557
 
          </listitem>
558
 
        </varlistentry>
559
 
        <varlistentry>
560
 
          <term><filename class="directory"
561
 
          >/lib/mandos/plugin-helpers</filename></term>
562
 
          <listitem>
563
 
            <para>
564
 
              The default plugin helper directory; can be changed by
565
 
              the <option>--plugin-helper-dir</option> option.
566
 
            </para>
567
 
          </listitem>
568
 
        </varlistentry>
569
517
      </variablelist>
570
518
    </para>
571
519
  </refsect1>
576
524
      The <option>--config-file</option> option is ignored when
577
525
      specified from within a configuration file.
578
526
    </para>
579
 
    <xi:include href="bugs.xml"/>
580
527
  </refsect1>
581
528
  
582
529
  <refsect1 id="examples">
625
572
    </informalexample>
626
573
    <informalexample>
627
574
      <para>
628
 
        Read a different configuration file, run plugins from a
629
 
        different directory, specify an alternate plugin helper
630
 
        directory and add two options to the
 
575
        Run plugins from a different directory, read a different
 
576
        configuration file, and add two options to the
631
577
        <citerefentry><refentrytitle >mandos-client</refentrytitle>
632
578
        <manvolnum>8mandos</manvolnum></citerefentry> plugin:
633
579
      </para>
634
580
      <para>
635
581
 
636
582
<!-- do not wrap this line -->
637
 
<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>
 
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>
638
584
 
639
585
      </para>
640
586
    </informalexample>