/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-01 16:19:32 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080901161932-ostp7tulh9aijulh
* plugin-runner.c (add_environment): Never insert existing environment
                                     variables.
  (main): Rename "--global-envs" to "--global-env" and "--envs-for" to
          "--env-for".

* plugin-runner.xml (SYNOPSIS): Rename "--global-envs" to
                                "--global-env" and "--envs-for" to
                                "--env-for".
  (OPTIONS): Added "--global-env" and "--env-for".
  (FALLBACK): Add id attribute.
  (EXIT STATUS): Add text.
  (ENVIRONMENT): New section.
  (FILES): Document configuration file.

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugin-runner.xml
3
3
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
4
<!ENTITY VERSION "1.0">
5
5
<!ENTITY COMMANDNAME "plugin-runner">
6
 
<!ENTITY TIMESTAMP "2008-09-02">
 
6
<!ENTITY TIMESTAMP "2008-09-01">
7
7
]>
8
8
 
9
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
56
56
        <arg choice="plain"><option>--global-env=<replaceable
57
57
        >VAR</replaceable><literal>=</literal><replaceable
58
58
        >value</replaceable></option></arg>
59
 
        <arg choice="plain"><option>-G
 
59
        <arg choice="plain"><option>-e
60
60
        <replaceable>VAR</replaceable><literal>=</literal><replaceable
61
61
        >value</replaceable> </option></arg>
62
62
      </group>
66
66
        >PLUGIN</replaceable><literal>:</literal><replaceable
67
67
        >ENV</replaceable><literal>=</literal><replaceable
68
68
        >value</replaceable></option></arg>
69
 
        <arg choice="plain"><option>-E<replaceable>
 
69
        <arg choice="plain"><option>-f<replaceable>
70
70
        PLUGIN</replaceable><literal>:</literal><replaceable
71
71
        >ENV</replaceable><literal>=</literal><replaceable
72
72
        >value</replaceable> </option></arg>
83
83
        <arg choice="plain"><option>--options-for=<replaceable
84
84
        >PLUGIN</replaceable><literal>:</literal><replaceable
85
85
        >OPTIONS</replaceable></option></arg>
86
 
        <arg choice="plain"><option>-o<replaceable>
 
86
        <arg choice="plain"><option>-f<replaceable>
87
87
        PLUGIN</replaceable><literal>:</literal><replaceable
88
88
        >OPTIONS</replaceable> </option></arg>
89
89
      </group>
95
95
        <replaceable>PLUGIN</replaceable> </option></arg>
96
96
      </group>
97
97
      <sbr/>
98
 
      <group rep="repeat">
99
 
        <arg choice="plain"><option>--enable=<replaceable
100
 
        >PLUGIN</replaceable></option></arg>
101
 
        <arg choice="plain"><option>-e
102
 
        <replaceable>PLUGIN</replaceable> </option></arg>
103
 
      </group>
104
 
      <sbr/>
105
98
      <arg><option>--groupid=<replaceable
106
99
      >ID</replaceable></option></arg>
107
100
      <sbr/>
111
104
      <arg><option>--plugin-dir=<replaceable
112
105
      >DIRECTORY</replaceable></option></arg>
113
106
      <sbr/>
114
 
      <arg><option>--config-file=<replaceable
115
 
      >FILE</replaceable></option></arg>
116
 
      <sbr/>
117
107
      <arg><option>--debug</option></arg>
118
108
    </cmdsynopsis>
119
109
    <cmdsynopsis>
177
167
        >value</replaceable></option></term>
178
168
        <listitem>
179
169
          <para>
180
 
            This option will add an environment variable setting to
181
 
            all plugins.  This will override any inherited environment
182
 
            variable.
 
170
            
183
171
          </para>
184
172
        </listitem>
185
173
      </varlistentry>
195
183
        ><replaceable>value</replaceable></option></term>
196
184
        <listitem>
197
185
          <para>
198
 
            This option will add an environment variable setting to
199
 
            the <replaceable>PLUGIN</replaceable> plugin.  This will
200
 
            override any inherited environment variables or
201
 
            environment variables specified using
202
 
            <option>--global-env</option>.
203
186
          </para>
204
187
        </listitem>
205
188
      </varlistentry>
249
232
      </varlistentry>
250
233
 
251
234
      <varlistentry>
252
 
        <term><option>--disable
 
235
        <term><option> --disable
253
236
        <replaceable>PLUGIN</replaceable></option></term>
254
237
        <term><option>-d
255
238
        <replaceable>PLUGIN</replaceable></option></term>
263
246
      </varlistentry>
264
247
 
265
248
      <varlistentry>
266
 
        <term><option>--enable
267
 
        <replaceable>PLUGIN</replaceable></option></term>
268
 
        <term><option>-e
269
 
        <replaceable>PLUGIN</replaceable></option></term>
270
 
        <listitem>
271
 
          <para>
272
 
            Re-enable the plugin named
273
 
            <replaceable>PLUGIN</replaceable>.  This is only useful to
274
 
            undo a previous <option>--disable</option> option, maybe
275
 
            from the config file.
276
 
          </para>
277
 
        </listitem>
278
 
      </varlistentry>
279
 
 
280
 
      <varlistentry>
281
249
        <term><option>--groupid
282
250
        <replaceable>ID</replaceable></option></term>
283
251
        <listitem>
317
285
      </varlistentry>
318
286
      
319
287
      <varlistentry>
320
 
        <term><option>--config-file
321
 
        <replaceable>FILE</replaceable></option></term>
322
 
        <listitem>
323
 
          <para>
324
 
            Specify a different file to read additional options from.
325
 
            See <xref linkend="files"/>.  Other command line options
326
 
            will override options specified in the file.
327
 
          </para>
328
 
        </listitem>
329
 
      </varlistentry>
330
 
      
331
 
      <varlistentry>
332
288
        <term><option>--debug</option></term>
333
289
        <listitem>
334
290
          <para>
430
386
  <refsect1 id="environment">
431
387
    <title>ENVIRONMENT</title>
432
388
    <para>
433
 
      This program does not use any environment variables itself, it
434
 
      only passes on its environment to all the plugins.  The
435
 
      environment passed to plugins can be modified using the
436
 
      <option>--global-env</option> and <option>--env-for</option>
437
 
      optins.
 
389
      
438
390
    </para>
439
391
  </refsect1>
440
392
  
441
 
  <refsect1 id="files">
 
393
  <refsect1 id="file">
442
394
    <title>FILES</title>
443
395
    <para>
444
396
      <variablelist>
455
407
              everything from a <quote>#</quote> character to the end
456
408
              of a line is ignored.
457
409
            </para>
458
 
            <para>
459
 
              This program is meant to run in the initial RAM disk
460
 
              environment, so that is where this file is assumed to
461
 
              exist.  The file does not need to exist in the normal
462
 
              file system.
463
 
            </para>
464
 
            <para>
465
 
              This file will be processed <emphasis>before</emphasis>
466
 
              the normal command line options, so the latter can
467
 
              override the former, if need be.
468
 
            </para>
469
 
            <para>
470
 
              This file name is the default; the file to read for
471
 
              arguments can be changed using the
472
 
              <option>--config-file</option> option.
473
 
            </para>
474
410
          </listitem>
475
411
        </varlistentry>
476
412
      </variablelist>