/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: 2008-09-13 15:36:18 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080913153618-atp386q2bqj0ku99
* Makefile (install-client-nokey): Do "&&" instead of ";" to catch
                                   errors.

* README: Kill the straight quotes.  Add copyright notice.

* overview.xml: Improved wording.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
<?xml version="1.0" encoding="UTF-8"?>
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
<!ENTITY VERSION "1.0">
4
5
<!ENTITY COMMANDNAME "plugin-runner">
5
 
<!ENTITY TIMESTAMP "2016-03-05">
6
 
<!ENTITY % common SYSTEM "common.ent">
7
 
%common;
 
6
<!ENTITY TIMESTAMP "2008-09-12">
8
7
]>
9
8
 
10
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
12
11
    <title>Mandos Manual</title>
13
12
    <!-- Nwalsh’s docbook scripts use this to generate the footer: -->
14
13
    <productname>Mandos</productname>
15
 
    <productnumber>&version;</productnumber>
 
14
    <productnumber>&VERSION;</productnumber>
16
15
    <date>&TIMESTAMP;</date>
17
16
    <authorgroup>
18
17
      <author>
19
18
        <firstname>Björn</firstname>
20
19
        <surname>Påhlsson</surname>
21
20
        <address>
22
 
          <email>belorn@recompile.se</email>
 
21
          <email>belorn@fukt.bsnet.se</email>
23
22
        </address>
24
23
      </author>
25
24
      <author>
26
25
        <firstname>Teddy</firstname>
27
26
        <surname>Hogeborn</surname>
28
27
        <address>
29
 
          <email>teddy@recompile.se</email>
 
28
          <email>teddy@fukt.bsnet.se</email>
30
29
        </address>
31
30
      </author>
32
31
    </authorgroup>
33
32
    <copyright>
34
33
      <year>2008</year>
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
34
      <holder>Teddy Hogeborn</holder>
44
35
      <holder>Björn Påhlsson</holder>
45
36
    </copyright>
63
54
      <command>&COMMANDNAME;</command>
64
55
      <group rep="repeat">
65
56
        <arg choice="plain"><option>--global-env=<replaceable
66
 
        >ENV</replaceable><literal>=</literal><replaceable
 
57
        >VAR</replaceable><literal>=</literal><replaceable
67
58
        >value</replaceable></option></arg>
68
59
        <arg choice="plain"><option>-G
69
 
        <replaceable>ENV</replaceable><literal>=</literal><replaceable
 
60
        <replaceable>VAR</replaceable><literal>=</literal><replaceable
70
61
        >value</replaceable> </option></arg>
71
62
      </group>
72
63
      <sbr/>
120
111
      <arg><option>--plugin-dir=<replaceable
121
112
      >DIRECTORY</replaceable></option></arg>
122
113
      <sbr/>
123
 
      <arg><option>--plugin-helper-dir=<replaceable
124
 
      >DIRECTORY</replaceable></option></arg>
125
 
      <sbr/>
126
114
      <arg><option>--config-file=<replaceable
127
115
      >FILE</replaceable></option></arg>
128
116
      <sbr/>
182
170
    <variablelist>
183
171
      <varlistentry>
184
172
        <term><option>--global-env
185
 
        <replaceable>ENV</replaceable><literal>=</literal><replaceable
 
173
        <replaceable>VAR</replaceable><literal>=</literal><replaceable
186
174
        >value</replaceable></option></term>
187
175
        <term><option>-G
188
 
        <replaceable>ENV</replaceable><literal>=</literal><replaceable
 
176
        <replaceable>VAR</replaceable><literal>=</literal><replaceable
189
177
        >value</replaceable></option></term>
190
178
        <listitem>
191
179
          <para>
270
258
            Disable the plugin named
271
259
            <replaceable>PLUGIN</replaceable>.  The plugin will not be
272
260
            started.
273
 
          </para>
 
261
          </para>       
274
262
        </listitem>
275
263
      </varlistentry>
276
264
      
329
317
      </varlistentry>
330
318
      
331
319
      <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
320
        <term><option>--config-file
348
321
        <replaceable>FILE</replaceable></option></term>
349
322
        <listitem>
450
423
      <para>
451
424
        The plugin will run in the initial RAM disk environment, so
452
425
        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.
 
426
        services not available there.
458
427
      </para>
459
428
      <para>
460
429
        The plugin must exit cleanly and free all allocated resources
503
472
      only passes on its environment to all the plugins.  The
504
473
      environment passed to plugins can be modified using the
505
474
      <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.
 
475
      options.
509
476
    </para>
510
477
  </refsect1>
511
478
  
554
521
      The <option>--config-file</option> option is ignored when
555
522
      specified from within a configuration file.
556
523
    </para>
557
 
    <xi:include href="bugs.xml"/>
558
524
  </refsect1>
559
525
  
560
526
  <refsect1 id="examples">
603
569
    </informalexample>
604
570
    <informalexample>
605
571
      <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
 
572
        Run plugins from a different directory, read a different
 
573
        configuration file, and add two options to the
609
574
        <citerefentry><refentrytitle >mandos-client</refentrytitle>
610
575
        <manvolnum>8mandos</manvolnum></citerefentry> plugin:
611
576
      </para>
612
577
      <para>
613
578
 
614
579
<!-- 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>
 
580
<userinput>&COMMANDNAME;  --config-file=/etc/mandos/plugin-runner.conf --plugin-dir /usr/lib/mandos/plugins.d --options-for=mandos-client:--pubkey=/etc/keys/mandos/pubkey.txt,--seckey=/etc/keys/mandos/seckey.txt</userinput>
616
581
 
617
582
      </para>
618
583
    </informalexample>
650
615
  <refsect1 id="see_also">
651
616
    <title>SEE ALSO</title>
652
617
    <para>
653
 
      <citerefentry><refentrytitle>intro</refentrytitle>
654
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
655
618
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
656
619
      <manvolnum>8</manvolnum></citerefentry>,
657
620
      <citerefentry><refentrytitle>crypttab</refentrytitle>