/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: 2018-02-10 13:23:58 UTC
  • Revision ID: teddy@recompile.se-20180210132358-8pfvo9vshq9l32y5
Remove unnecessary text left from old example init.d file

* init.d-mandos: Remove unnecessary text left from old example init.d
  file.

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 "2018-02-08">
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>
 
43
      <year>2017</year>
 
44
      <year>2018</year>
36
45
      <holder>Teddy Hogeborn</holder>
37
46
      <holder>Björn Påhlsson</holder>
38
47
    </copyright>
113
122
      <arg><option>--plugin-dir=<replaceable
114
123
      >DIRECTORY</replaceable></option></arg>
115
124
      <sbr/>
 
125
      <arg><option>--plugin-helper-dir=<replaceable
 
126
      >DIRECTORY</replaceable></option></arg>
 
127
      <sbr/>
116
128
      <arg><option>--config-file=<replaceable
117
129
      >FILE</replaceable></option></arg>
118
130
      <sbr/>
260
272
            Disable the plugin named
261
273
            <replaceable>PLUGIN</replaceable>.  The plugin will not be
262
274
            started.
263
 
          </para>       
 
275
          </para>
264
276
        </listitem>
265
277
      </varlistentry>
266
278
      
319
331
      </varlistentry>
320
332
      
321
333
      <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>
322
349
        <term><option>--config-file
323
350
        <replaceable>FILE</replaceable></option></term>
324
351
        <listitem>
425
452
      <para>
426
453
        The plugin will run in the initial RAM disk environment, so
427
454
        care must be taken not to depend on any files or running
428
 
        services not available there.
 
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
460
      </para>
430
461
      <para>
431
462
        The plugin must exit cleanly and free all allocated resources
474
505
      only passes on its environment to all the plugins.  The
475
506
      environment passed to plugins can be modified using the
476
507
      <option>--global-env</option> and <option>--env-for</option>
477
 
      options.
 
508
      options.  Also, the <option>--plugin-helper-dir</option> option
 
509
      will affect the environment variable
 
510
      <envar>MANDOSPLUGINHELPERDIR</envar> for the plugins.
478
511
    </para>
479
512
  </refsect1>
480
513
  
513
546
            </para>
514
547
          </listitem>
515
548
        </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>
516
569
      </variablelist>
517
570
    </para>
518
571
  </refsect1>
523
576
      The <option>--config-file</option> option is ignored when
524
577
      specified from within a configuration file.
525
578
    </para>
 
579
    <xi:include href="bugs.xml"/>
526
580
  </refsect1>
527
581
  
528
582
  <refsect1 id="examples">
571
625
    </informalexample>
572
626
    <informalexample>
573
627
      <para>
574
 
        Run plugins from a different directory, read a different
575
 
        configuration file, and add two options to the
 
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
576
631
        <citerefentry><refentrytitle >mandos-client</refentrytitle>
577
632
        <manvolnum>8mandos</manvolnum></citerefentry> plugin:
578
633
      </para>
579
634
      <para>
580
635
 
581
636
<!-- 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>
 
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
638
 
584
639
      </para>
585
640
    </informalexample>
617
672
  <refsect1 id="see_also">
618
673
    <title>SEE ALSO</title>
619
674
    <para>
 
675
      <citerefentry><refentrytitle>intro</refentrytitle>
 
676
      <manvolnum>8mandos</manvolnum></citerefentry>,
620
677
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
621
678
      <manvolnum>8</manvolnum></citerefentry>,
622
679
      <citerefentry><refentrytitle>crypttab</refentrytitle>