/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

  • Committer: Björn Påhlsson
  • Date: 2009-02-08 01:50:24 UTC
  • mto: (237.7.1 mandos) (24.1.154 mandos)
  • mto: This revision was merged to the branch mainline in revision 250.
  • Revision ID: belorn@braxen-20090208015024-jewaulcqtxvbopq6
Fixed a bug in fallback handling

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 "2009-01-17">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
19
19
        <firstname>Björn</firstname>
20
20
        <surname>Påhlsson</surname>
21
21
        <address>
22
 
          <email>belorn@recompile.se</email>
 
22
          <email>belorn@fukt.bsnet.se</email>
23
23
        </address>
24
24
      </author>
25
25
      <author>
26
26
        <firstname>Teddy</firstname>
27
27
        <surname>Hogeborn</surname>
28
28
        <address>
29
 
          <email>teddy@recompile.se</email>
 
29
          <email>teddy@fukt.bsnet.se</email>
30
30
        </address>
31
31
      </author>
32
32
    </authorgroup>
33
33
    <copyright>
34
34
      <year>2008</year>
35
35
      <year>2009</year>
36
 
      <year>2010</year>
37
 
      <year>2011</year>
38
 
      <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
36
      <holder>Teddy Hogeborn</holder>
46
37
      <holder>Björn Påhlsson</holder>
47
38
    </copyright>
122
113
      <arg><option>--plugin-dir=<replaceable
123
114
      >DIRECTORY</replaceable></option></arg>
124
115
      <sbr/>
125
 
      <arg><option>--plugin-helper-dir=<replaceable
126
 
      >DIRECTORY</replaceable></option></arg>
127
 
      <sbr/>
128
116
      <arg><option>--config-file=<replaceable
129
117
      >FILE</replaceable></option></arg>
130
118
      <sbr/>
272
260
            Disable the plugin named
273
261
            <replaceable>PLUGIN</replaceable>.  The plugin will not be
274
262
            started.
275
 
          </para>
 
263
          </para>       
276
264
        </listitem>
277
265
      </varlistentry>
278
266
      
331
319
      </varlistentry>
332
320
      
333
321
      <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
322
        <term><option>--config-file
350
323
        <replaceable>FILE</replaceable></option></term>
351
324
        <listitem>
452
425
      <para>
453
426
        The plugin will run in the initial RAM disk environment, so
454
427
        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.
 
428
        services not available there.
460
429
      </para>
461
430
      <para>
462
431
        The plugin must exit cleanly and free all allocated resources
505
474
      only passes on its environment to all the plugins.  The
506
475
      environment passed to plugins can be modified using the
507
476
      <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.
 
477
      options.
511
478
    </para>
512
479
  </refsect1>
513
480
  
546
513
            </para>
547
514
          </listitem>
548
515
        </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
516
      </variablelist>
570
517
    </para>
571
518
  </refsect1>
576
523
      The <option>--config-file</option> option is ignored when
577
524
      specified from within a configuration file.
578
525
    </para>
579
 
    <xi:include href="bugs.xml"/>
580
526
  </refsect1>
581
527
  
582
528
  <refsect1 id="examples">
625
571
    </informalexample>
626
572
    <informalexample>
627
573
      <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
 
574
        Run plugins from a different directory, read a different
 
575
        configuration file, and add two options to the
631
576
        <citerefentry><refentrytitle >mandos-client</refentrytitle>
632
577
        <manvolnum>8mandos</manvolnum></citerefentry> plugin:
633
578
      </para>
634
579
      <para>
635
580
 
636
581
<!-- 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>
 
582
<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
583
 
639
584
      </para>
640
585
    </informalexample>
672
617
  <refsect1 id="see_also">
673
618
    <title>SEE ALSO</title>
674
619
    <para>
675
 
      <citerefentry><refentrytitle>intro</refentrytitle>
676
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
677
620
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
678
621
      <manvolnum>8</manvolnum></citerefentry>,
679
622
      <citerefentry><refentrytitle>crypttab</refentrytitle>