/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: Teddy Hogeborn
  • Date: 2016-03-08 00:52:12 UTC
  • mfrom: (338 release)
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 339.
  • Revision ID: teddy@recompile.se-20160308005212-o5m2eaphq6ze5bb0
Merge from release branch

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 "2009-01-17">
 
5
<!ENTITY TIMESTAMP "2016-03-05">
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@fukt.bsnet.se</email>
 
22
          <email>belorn@recompile.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@fukt.bsnet.se</email>
 
29
          <email>teddy@recompile.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>
36
43
      <holder>Teddy Hogeborn</holder>
37
44
      <holder>Björn Påhlsson</holder>
38
45
    </copyright>
113
120
      <arg><option>--plugin-dir=<replaceable
114
121
      >DIRECTORY</replaceable></option></arg>
115
122
      <sbr/>
 
123
      <arg><option>--plugin-helper-dir=<replaceable
 
124
      >DIRECTORY</replaceable></option></arg>
 
125
      <sbr/>
116
126
      <arg><option>--config-file=<replaceable
117
127
      >FILE</replaceable></option></arg>
118
128
      <sbr/>
260
270
            Disable the plugin named
261
271
            <replaceable>PLUGIN</replaceable>.  The plugin will not be
262
272
            started.
263
 
          </para>       
 
273
          </para>
264
274
        </listitem>
265
275
      </varlistentry>
266
276
      
319
329
      </varlistentry>
320
330
      
321
331
      <varlistentry>
 
332
        <term><option>--plugin-helper-dir
 
333
        <replaceable>DIRECTORY</replaceable></option></term>
 
334
        <listitem>
 
335
          <para>
 
336
            Specify a different plugin helper directory.  The default
 
337
            is <filename>/lib/mandos/plugin-helpers</filename>, which
 
338
            will exist in the initial <acronym>RAM</acronym> disk
 
339
            environment.  (This will simply be passed to all plugins
 
340
            via the <envar>MANDOSPLUGINHELPERDIR</envar> environment
 
341
            variable.  See <xref linkend="writing_plugins"/>)
 
342
          </para>
 
343
        </listitem>
 
344
      </varlistentry>
 
345
      
 
346
      <varlistentry>
322
347
        <term><option>--config-file
323
348
        <replaceable>FILE</replaceable></option></term>
324
349
        <listitem>
425
450
      <para>
426
451
        The plugin will run in the initial RAM disk environment, so
427
452
        care must be taken not to depend on any files or running
428
 
        services not available there.
 
453
        services not available there.  Any helper executables required
 
454
        by the plugin (which are not in the <envar>PATH</envar>) can
 
455
        be placed in the plugin helper directory, the name of which
 
456
        will be made available to the plugin via the
 
457
        <envar>MANDOSPLUGINHELPERDIR</envar> environment variable.
429
458
      </para>
430
459
      <para>
431
460
        The plugin must exit cleanly and free all allocated resources
474
503
      only passes on its environment to all the plugins.  The
475
504
      environment passed to plugins can be modified using the
476
505
      <option>--global-env</option> and <option>--env-for</option>
477
 
      options.
 
506
      options.  Also, the <option>--plugin-helper-dir</option> option
 
507
      will affect the environment variable
 
508
      <envar>MANDOSPLUGINHELPERDIR</envar> for the plugins.
478
509
    </para>
479
510
  </refsect1>
480
511
  
523
554
      The <option>--config-file</option> option is ignored when
524
555
      specified from within a configuration file.
525
556
    </para>
 
557
    <xi:include href="bugs.xml"/>
526
558
  </refsect1>
527
559
  
528
560
  <refsect1 id="examples">
571
603
    </informalexample>
572
604
    <informalexample>
573
605
      <para>
574
 
        Run plugins from a different directory, read a different
575
 
        configuration file, and add two options to the
 
606
        Read a different configuration file, run plugins from a
 
607
        different directory, specify an alternate plugin helper
 
608
        directory and add two options to the
576
609
        <citerefentry><refentrytitle >mandos-client</refentrytitle>
577
610
        <manvolnum>8mandos</manvolnum></citerefentry> plugin:
578
611
      </para>
579
612
      <para>
580
613
 
581
614
<!-- do not wrap this line -->
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>
 
615
<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
616
 
584
617
      </para>
585
618
    </informalexample>
617
650
  <refsect1 id="see_also">
618
651
    <title>SEE ALSO</title>
619
652
    <para>
 
653
      <citerefentry><refentrytitle>intro</refentrytitle>
 
654
      <manvolnum>8mandos</manvolnum></citerefentry>,
620
655
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
621
656
      <manvolnum>8</manvolnum></citerefentry>,
622
657
      <citerefentry><refentrytitle>crypttab</refentrytitle>