/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 08:29:23 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080901082923-i2liq6t7warmu9xe
* mandos.xml: Enclose "RAM" with <acronym>.
* overview.xml: - '' -

* plugin-runner.xml (DESCRIPTION): Improved wording.
  (PURPOSE): New section.
  (OPTIONS): Improved wording.
  (OVERVIEW, PLUGINS): New section.
  (FALLBACK): New empty placeholder section.

* plugins.d/password-prompt.xml: Enclose "RAM" with <acronym>.

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-env=<replaceable
 
56
        <arg choice="plain"><option>--global-envs=<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>--env-for=<replaceable
 
65
        <arg choice="plain"><option>--envs-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
 
            
171
 
          </para>
172
 
        </listitem>
173
 
      </varlistentry>
174
 
      
175
 
      <varlistentry>
176
 
        <term><option>--env-for
177
 
        <replaceable>PLUGIN</replaceable><literal>:</literal
178
 
        ><replaceable>ENV</replaceable><literal>=</literal
179
 
        ><replaceable>value</replaceable></option></term>
180
 
        <term><option>-f
181
 
        <replaceable>PLUGIN</replaceable><literal>:</literal
182
 
        ><replaceable>ENV</replaceable><literal>=</literal
183
 
        ><replaceable>value</replaceable></option></term>
184
 
        <listitem>
185
 
          <para>
186
 
          </para>
187
 
        </listitem>
188
 
      </varlistentry>
189
 
      
190
 
      <varlistentry>
191
162
        <term><option>--global-options
192
163
        <replaceable>OPTIONS</replaceable></option></term>
193
164
        <term><option>-g
355
326
      <filename>/lib/mandos/plugins.d</filename>, but this can be
356
327
      changed with the <option>--plugin-dir</option> option.  The
357
328
      plugins are started in parallel, and the first plugin to output
358
 
      a password <emphasis>and</emphasis> exit with a successful exit
359
 
      code will make this plugin-runner output the password from that
360
 
      plugin, stop any other plugins, and exit.
 
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.
361
332
    </para>
362
333
  </refsect1>
363
334
  
364
 
  <refsect1 id="fallback">
 
335
  <refsect1>
365
336
    <title>FALLBACK</title>
366
337
    <para>
367
 
      If no plugins succeed, this program will, as a fallback, ask for
368
 
      a password on the console using <citerefentry><refentrytitle
369
 
      >getpass</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
370
 
      and output it.  This is not meant to be the normal mode of
371
 
      operation, as there is a separate plugin for getting a password
372
 
      from the console.
373
338
    </para>
374
339
  </refsect1>
375
 
  
376
340
  <refsect1 id="exit_status">
377
341
    <title>EXIT STATUS</title>
378
342
    <para>
379
 
      Exit status of this program is zero if no errors were
380
 
      encountered, and otherwise not.  The fallback (see <xref
381
 
      linkend="fallback"/>) may or may not have succeeded in either
382
 
      case.
383
 
    </para>
384
 
  </refsect1>
385
 
  
386
 
  <refsect1 id="environment">
387
 
    <title>ENVIRONMENT</title>
388
 
    <para>
389
 
      
390
 
    </para>
391
 
  </refsect1>
392
 
  
 
343
    </para>
 
344
  </refsect1>
 
345
 
393
346
  <refsect1 id="file">
394
347
    <title>FILES</title>
395
348
    <para>
396
 
      <variablelist>
397
 
        <varlistentry>
398
 
          <term><filename
399
 
          >/conf/conf.d/mandos/plugin-runner.conf</filename></term>
400
 
          <listitem>
401
 
            <para>
402
 
              Since this program will be run as a keyscript, there is
403
 
              little to no opportunity to pass command line arguments
404
 
              to it.  Therefore, it will <emphasis>also</emphasis>
405
 
              read this file and use its contents as
406
 
              whitespace-separated command line options.  Also,
407
 
              everything from a <quote>#</quote> character to the end
408
 
              of a line is ignored.
409
 
            </para>
410
 
          </listitem>
411
 
        </varlistentry>
412
 
      </variablelist>
 
349
    </para>
 
350
  </refsect1>
 
351
 
 
352
  <refsect1 id="notes">
 
353
    <title>NOTES</title>
 
354
    <para>
413
355
    </para>
414
356
  </refsect1>
415
357
  
418
360
    <para>
419
361
    </para>
420
362
  </refsect1>
421
 
  
 
363
 
422
364
  <refsect1 id="examples">
423
365
    <title>EXAMPLE</title>
424
366
    <para>
425
367
    </para>
426
368
  </refsect1>
427
 
  
 
369
 
428
370
  <refsect1 id="security">
429
371
    <title>SECURITY</title>
430
372
    <para>
431
373
    </para>
432
374
  </refsect1>
433
 
  
 
375
 
434
376
  <refsect1 id="see_also">
435
377
    <title>SEE ALSO</title>
436
378
    <para>
444
386
      <manvolnum>8mandos</manvolnum></citerefentry>
445
387
    </para>
446
388
  </refsect1>
447
 
  
 
389
 
448
390
</refentry>
449
391
<!-- Local Variables: -->
450
392
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->