/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: 2008-09-02 10:27:08 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080902102708-j5k6ec3lcgkaeipv
* plugin-runner.xml: Changed short option for "--global-env" to "-G",
                     changed short option for "--env-for" to "-E".
                     added new options "--enable" ("-e") and
                     "--config-file".
  (ENVIRONMENT): Added text.
  (FILES): Changed id to "files".  Improved wording and add more text.

Show diffs side-by-side

added added

removed removed

Lines of Context:
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-01">
 
6
<!ENTITY TIMESTAMP "2008-09-02">
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>-e
 
59
        <arg choice="plain"><option>-G
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>-f<replaceable>
 
69
        <arg choice="plain"><option>-E<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>-f<replaceable>
 
86
        <arg choice="plain"><option>-o<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/>
98
105
      <arg><option>--groupid=<replaceable
99
106
      >ID</replaceable></option></arg>
100
107
      <sbr/>
104
111
      <arg><option>--plugin-dir=<replaceable
105
112
      >DIRECTORY</replaceable></option></arg>
106
113
      <sbr/>
 
114
      <arg><option>--config-file=<replaceable
 
115
      >FILE</replaceable></option></arg>
 
116
      <sbr/>
107
117
      <arg><option>--debug</option></arg>
108
118
    </cmdsynopsis>
109
119
    <cmdsynopsis>
239
249
      </varlistentry>
240
250
 
241
251
      <varlistentry>
242
 
        <term><option> --disable
 
252
        <term><option>--disable
243
253
        <replaceable>PLUGIN</replaceable></option></term>
244
254
        <term><option>-d
245
255
        <replaceable>PLUGIN</replaceable></option></term>
253
263
      </varlistentry>
254
264
 
255
265
      <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>
256
281
        <term><option>--groupid
257
282
        <replaceable>ID</replaceable></option></term>
258
283
        <listitem>
292
317
      </varlistentry>
293
318
      
294
319
      <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>
295
332
        <term><option>--debug</option></term>
296
333
        <listitem>
297
334
          <para>
393
430
  <refsect1 id="environment">
394
431
    <title>ENVIRONMENT</title>
395
432
    <para>
396
 
      
 
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.
397
438
    </para>
398
439
  </refsect1>
399
440
  
400
 
  <refsect1 id="file">
 
441
  <refsect1 id="files">
401
442
    <title>FILES</title>
402
443
    <para>
403
444
      <variablelist>
415
456
              of a line is ignored.
416
457
            </para>
417
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>
418
465
              This file will be processed <emphasis>before</emphasis>
419
466
              the normal command line options, so the latter can
420
467
              override the former, if need be.
421
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>
422
474
          </listitem>
423
475
        </varlistentry>
424
476
      </variablelist>
428
480
  <refsect1 id="bugs">
429
481
    <title>BUGS</title>
430
482
    <para>
431
 
      There is no <option>--enable</option> option to enable disabled
432
 
      plugins.
433
483
    </para>
434
484
  </refsect1>
435
485