/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 plugins.d/password-request.xml

  • Committer: Teddy Hogeborn
  • Date: 2008-09-03 13:59:58 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080903135958-k0he2xucqmx7nz4b
* plugins.d/password-request.xml (OPTIONS): Improved wording.
  (FILES): Add text about public and secret key files.
  (BUGS): Commented out.
  (EXAMPLE): Added examples.

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugins.d/password-request.xml
217
217
            Mandos servers to connect to.  The default it
218
218
            <quote><literal>eth0</literal></quote>.
219
219
          </para>
 
220
          <para>
 
221
            If the <option>--connect</option> option is used, this
 
222
            specifies the interface to use to connect to the address
 
223
            given.
 
224
          </para>
220
225
        </listitem>
221
226
      </varlistentry>
222
227
      
361
366
  
362
367
  <refsect1 id="file">
363
368
    <title>FILES</title>
364
 
    <para>
365
 
    </para>
 
369
    <variablelist>
 
370
      <varlistentry>
 
371
        <term><filename>/conf/conf.d/mandos/pubkey.txt</filename
 
372
        ></term>
 
373
        <term><filename>/conf/conf.d/mandos/seckey.txt</filename
 
374
        ></term>
 
375
        <listitem>
 
376
          <para>
 
377
            OpenPGP public and private key files, in <quote>ASCII
 
378
            Armor</quote> format.  These are the default file names,
 
379
            they can be changed with the <option>--pubkey</option> and
 
380
            <option>--seckey</option> options.
 
381
          </para>
 
382
        </listitem>
 
383
      </varlistentry>
 
384
    </variablelist>
366
385
  </refsect1>
367
386
  
368
 
  <refsect1 id="bugs">
369
 
    <title>BUGS</title>
370
 
    <para>
371
 
    </para>
372
 
  </refsect1>
 
387
<!--   <refsect1 id="bugs"> -->
 
388
<!--     <title>BUGS</title> -->
 
389
<!--     <para> -->
 
390
<!--     </para> -->
 
391
<!--   </refsect1> -->
373
392
 
374
393
  <refsect1 id="example">
375
394
    <title>EXAMPLE</title>
376
395
    <para>
 
396
      Note that normally, command line options will not be given
 
397
      directly, but via options for the Mandos <citerefentry
 
398
      ><refentrytitle>plugin-runner</refentrytitle>
 
399
      <manvolnum>8mandos</manvolnum></citerefentry>.
377
400
    </para>
 
401
    <informalexample>
 
402
      <para>
 
403
        Normal invocation needs no options, if the network interface
 
404
        is <quote>eth0</quote>:
 
405
      </para>
 
406
      <para>
 
407
        <userinput>&COMMANDNAME;</userinput>
 
408
      </para>
 
409
    </informalexample>
 
410
    <informalexample>
 
411
      <para>
 
412
        Search for Mandos servers on another interface:
 
413
      </para>
 
414
      <para>
 
415
        <!-- do not wrap this line -->
 
416
        <userinput>&COMMANDNAME; --interface eth1</userinput>
 
417
      </para>
 
418
    </informalexample>
 
419
    <informalexample>
 
420
      <para>
 
421
        Run in debug mode, and use a custom key directory:
 
422
      </para>
 
423
      <para>
 
424
        <!-- do not wrap this line -->
 
425
        <userinput>&COMMANDNAME; --debug --keydir keydir</userinput>
 
426
      </para>
 
427
    </informalexample>
 
428
    <informalexample>
 
429
      <para>
 
430
        Run in debug mode, with a custom key directory, and do not use
 
431
        Zeroconf to locate a server; connect directly to the IPv6
 
432
        address <quote><systemitem class="ipaddress"
 
433
        >2001:db8:f983:bd0b:30de:ae4a:71f2:f672</systemitem></quote>,
 
434
        port 4711, using interface eth2:
 
435
      </para>
 
436
      <para>
 
437
 
 
438
<!-- do not wrap this line -->
 
439
<userinput>&COMMANDNAME; --debug --keydir keydir --connect 2001:db8:f983:bd0b:30de:ae4a:71f2:f672:4711 --interface eth2</userinput>
 
440
 
 
441
      </para>
 
442
    </informalexample>
378
443
  </refsect1>
379
444
 
380
445
  <refsect1 id="security">