/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: 2012-01-01 20:56:41 UTC
  • Revision ID: teddy@recompile.se-20120101205641-1ug6xdxwzv2rld8r
Tags: version-1.5.1-1
* Makefile (version): Changed to "1.5.1".
* NEWS (Version 1.5.1): New entry.
* debian/changelog (1.5.1-1): - '' -

Show diffs side-by-side

added added

removed removed

Lines of Context:
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 "2016-03-05">
 
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
37
      <holder>Teddy Hogeborn</holder>
44
38
      <holder>Björn Påhlsson</holder>
45
39
    </copyright>
120
114
      <arg><option>--plugin-dir=<replaceable
121
115
      >DIRECTORY</replaceable></option></arg>
122
116
      <sbr/>
123
 
      <arg><option>--plugin-helper-dir=<replaceable
124
 
      >DIRECTORY</replaceable></option></arg>
125
 
      <sbr/>
126
117
      <arg><option>--config-file=<replaceable
127
118
      >FILE</replaceable></option></arg>
128
119
      <sbr/>
329
320
      </varlistentry>
330
321
      
331
322
      <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>
347
323
        <term><option>--config-file
348
324
        <replaceable>FILE</replaceable></option></term>
349
325
        <listitem>
450
426
      <para>
451
427
        The plugin will run in the initial RAM disk environment, so
452
428
        care must be taken not to depend on any files or running
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
        services not available there.
458
430
      </para>
459
431
      <para>
460
432
        The plugin must exit cleanly and free all allocated resources
503
475
      only passes on its environment to all the plugins.  The
504
476
      environment passed to plugins can be modified using the
505
477
      <option>--global-env</option> and <option>--env-for</option>
506
 
      options.  Also, the <option>--plugin-helper-dir</option> option
507
 
      will affect the environment variable
508
 
      <envar>MANDOSPLUGINHELPERDIR</envar> for the plugins.
 
478
      options.
509
479
    </para>
510
480
  </refsect1>
511
481
  
554
524
      The <option>--config-file</option> option is ignored when
555
525
      specified from within a configuration file.
556
526
    </para>
557
 
    <xi:include href="bugs.xml"/>
558
527
  </refsect1>
559
528
  
560
529
  <refsect1 id="examples">
603
572
    </informalexample>
604
573
    <informalexample>
605
574
      <para>
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
 
575
        Run plugins from a different directory, read a different
 
576
        configuration file, and add two options to the
609
577
        <citerefentry><refentrytitle >mandos-client</refentrytitle>
610
578
        <manvolnum>8mandos</manvolnum></citerefentry> plugin:
611
579
      </para>
612
580
      <para>
613
581
 
614
582
<!-- do not wrap this line -->
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
<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>
616
584
 
617
585
      </para>
618
586
    </informalexample>