/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 06:13:47 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080902061347-psw61eqt17j425sq
* plugin-runner.c: Changed short option for "--global-env" to "-G",
                   changed short option for "--env-for" to "-E",
                   added new option "--enable" ("-e").

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugin-runner.xml
53
53
    <cmdsynopsis>
54
54
      <command>&COMMANDNAME;</command>
55
55
      <group rep="repeat">
56
 
        <arg choice="plain"><option>--global-envs=<replaceable
 
56
        <arg choice="plain"><option>--global-env=<replaceable
57
57
        >VAR</replaceable><literal>=</literal><replaceable
58
58
        >value</replaceable></option></arg>
59
59
        <arg choice="plain"><option>-e
62
62
      </group>
63
63
      <sbr/>
64
64
      <group rep="repeat">
65
 
        <arg choice="plain"><option>--envs-for=<replaceable
 
65
        <arg choice="plain"><option>--env-for=<replaceable
66
66
        >PLUGIN</replaceable><literal>:</literal><replaceable
67
67
        >ENV</replaceable><literal>=</literal><replaceable
68
68
        >value</replaceable></option></arg>
159
159
    <title>OPTIONS</title>
160
160
    <variablelist>
161
161
      <varlistentry>
 
162
        <term><option>--global-env
 
163
        <replaceable>VAR</replaceable><literal>=</literal><replaceable
 
164
        >value</replaceable></option></term>
 
165
        <term><option>-e
 
166
        <replaceable>VAR</replaceable><literal>=</literal><replaceable
 
167
        >value</replaceable></option></term>
 
168
        <listitem>
 
169
          <para>
 
170
            This option will add an environment variable setting to
 
171
            all plugins.  This will override any inherited environment
 
172
            variable.
 
173
          </para>
 
174
        </listitem>
 
175
      </varlistentry>
 
176
      
 
177
      <varlistentry>
 
178
        <term><option>--env-for
 
179
        <replaceable>PLUGIN</replaceable><literal>:</literal
 
180
        ><replaceable>ENV</replaceable><literal>=</literal
 
181
        ><replaceable>value</replaceable></option></term>
 
182
        <term><option>-f
 
183
        <replaceable>PLUGIN</replaceable><literal>:</literal
 
184
        ><replaceable>ENV</replaceable><literal>=</literal
 
185
        ><replaceable>value</replaceable></option></term>
 
186
        <listitem>
 
187
          <para>
 
188
            This option will add an environment variable setting to
 
189
            the <replaceable>PLUGIN</replaceable> plugin.  This will
 
190
            override any inherited environment variables or
 
191
            environment variables specified using
 
192
            <option>--global-env</option>.
 
193
          </para>
 
194
        </listitem>
 
195
      </varlistentry>
 
196
      
 
197
      <varlistentry>
162
198
        <term><option>--global-options
163
199
        <replaceable>OPTIONS</replaceable></option></term>
164
200
        <term><option>-g
326
362
      <filename>/lib/mandos/plugins.d</filename>, but this can be
327
363
      changed with the <option>--plugin-dir</option> option.  The
328
364
      plugins are started in parallel, and the first plugin to output
329
 
      a password and exit with a successful exit code will make this
330
 
      plugin-runner output that password, stop any other plugins, and
331
 
      exit.
 
365
      a password <emphasis>and</emphasis> exit with a successful exit
 
366
      code will make this plugin-runner output the password from that
 
367
      plugin, stop any other plugins, and exit.
332
368
    </para>
333
369
  </refsect1>
334
370
  
335
 
  <refsect1>
 
371
  <refsect1 id="fallback">
336
372
    <title>FALLBACK</title>
337
373
    <para>
 
374
      If no plugins succeed, this program will, as a fallback, ask for
 
375
      a password on the console using <citerefentry><refentrytitle
 
376
      >getpass</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
 
377
      and output it.  This is not meant to be the normal mode of
 
378
      operation, as there is a separate plugin for getting a password
 
379
      from the console.
338
380
    </para>
339
381
  </refsect1>
 
382
  
340
383
  <refsect1 id="exit_status">
341
384
    <title>EXIT STATUS</title>
342
385
    <para>
343
 
    </para>
344
 
  </refsect1>
345
 
 
 
386
      Exit status of this program is zero if no errors were
 
387
      encountered, and otherwise not.  The fallback (see <xref
 
388
      linkend="fallback"/>) may or may not have succeeded in either
 
389
      case.
 
390
    </para>
 
391
  </refsect1>
 
392
  
 
393
  <refsect1 id="environment">
 
394
    <title>ENVIRONMENT</title>
 
395
    <para>
 
396
      
 
397
    </para>
 
398
  </refsect1>
 
399
  
346
400
  <refsect1 id="file">
347
401
    <title>FILES</title>
348
402
    <para>
349
 
    </para>
350
 
  </refsect1>
351
 
 
352
 
  <refsect1 id="notes">
353
 
    <title>NOTES</title>
354
 
    <para>
 
403
      <variablelist>
 
404
        <varlistentry>
 
405
          <term><filename
 
406
          >/conf/conf.d/mandos/plugin-runner.conf</filename></term>
 
407
          <listitem>
 
408
            <para>
 
409
              Since this program will be run as a keyscript, there is
 
410
              little to no opportunity to pass command line arguments
 
411
              to it.  Therefore, it will <emphasis>also</emphasis>
 
412
              read this file and use its contents as
 
413
              whitespace-separated command line options.  Also,
 
414
              everything from a <quote>#</quote> character to the end
 
415
              of a line is ignored.
 
416
            </para>
 
417
            <para>
 
418
              This file will be processed <emphasis>before</emphasis>
 
419
              the normal command line options, so the latter can
 
420
              override the former, if need be.
 
421
            </para>
 
422
          </listitem>
 
423
        </varlistentry>
 
424
      </variablelist>
355
425
    </para>
356
426
  </refsect1>
357
427
  
358
428
  <refsect1 id="bugs">
359
429
    <title>BUGS</title>
360
430
    <para>
 
431
      There is no <option>--enable</option> option to enable disabled
 
432
      plugins.
361
433
    </para>
362
434
  </refsect1>
363
 
 
 
435
  
364
436
  <refsect1 id="examples">
365
437
    <title>EXAMPLE</title>
366
438
    <para>
367
439
    </para>
368
440
  </refsect1>
369
 
 
 
441
  
370
442
  <refsect1 id="security">
371
443
    <title>SECURITY</title>
372
444
    <para>
373
445
    </para>
374
446
  </refsect1>
375
 
 
 
447
  
376
448
  <refsect1 id="see_also">
377
449
    <title>SEE ALSO</title>
378
450
    <para>
386
458
      <manvolnum>8mandos</manvolnum></citerefentry>
387
459
    </para>
388
460
  </refsect1>
389
 
 
 
461
  
390
462
</refentry>
391
463
<!-- Local Variables: -->
392
464
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->