/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

merge

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugins.d/password-request.xml
3
3
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
4
<!ENTITY VERSION "1.0">
5
5
<!ENTITY COMMANDNAME "password-request">
6
 
<!ENTITY TIMESTAMP "2008-09-04">
 
6
<!ENTITY TIMESTAMP "2008-09-03">
7
7
]>
8
8
 
9
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
54
54
      <command>&COMMANDNAME;</command>
55
55
      <group>
56
56
        <arg choice="plain"><option>--connect
57
 
        <replaceable>ADDRESS</replaceable><literal>:</literal
 
57
        <replaceable>IPADDR</replaceable><literal>:</literal
58
58
        ><replaceable>PORT</replaceable></option></arg>
59
59
        <arg choice="plain"><option>-c
60
 
        <replaceable>ADDRESS</replaceable><literal>:</literal
 
60
        <replaceable>IPADDR</replaceable><literal>:</literal
61
61
        ><replaceable>PORT</replaceable></option></arg>
62
62
      </group>
63
63
      <sbr/>
64
64
      <group>
 
65
        <arg choice="plain"><option>--keydir
 
66
        <replaceable>DIRECTORY</replaceable></option></arg>
 
67
        <arg choice="plain"><option>-d
 
68
        <replaceable>DIRECTORY</replaceable></option></arg>
 
69
      </group>
 
70
      <sbr/>
 
71
      <group>
65
72
        <arg choice="plain"><option>--interface
66
73
        <replaceable>NAME</replaceable></option></arg>
67
74
        <arg choice="plain"><option>-i
124
131
      network connectivity, Zeroconf to find servers, and TLS with an
125
132
      OpenPGP key to ensure authenticity and confidentiality.  It
126
133
      keeps running, trying all servers on the network, until it
127
 
      receives a satisfactory reply or a TERM signal is received.
 
134
      receives a satisfactory reply or a TERM signal is recieved.
128
135
    </para>
129
136
    <para>
130
137
      This program is not meant to be run directly; it is really meant
184
191
      </varlistentry>
185
192
      
186
193
      <varlistentry>
 
194
        <term><option>--keydir=<replaceable
 
195
        >DIRECTORY</replaceable></option></term>
 
196
        <term><option>-d
 
197
        <replaceable>DIRECTORY</replaceable></option></term>
 
198
        <listitem>
 
199
          <para>
 
200
            Directory to read the OpenPGP key files
 
201
            <filename>pubkey.txt</filename> and
 
202
            <filename>seckey.txt</filename> from.  The default is
 
203
            <filename>/conf/conf.d/mandos</filename> (in the initial
 
204
            <acronym>RAM</acronym> disk environment).
 
205
          </para>
 
206
        </listitem>
 
207
      </varlistentry>
 
208
 
 
209
      <varlistentry>
187
210
        <term><option>--interface=
188
211
        <replaceable>NAME</replaceable></option></term>
189
212
        <term><option>-i
209
232
        <replaceable>FILE</replaceable></option></term>
210
233
        <listitem>
211
234
          <para>
212
 
            OpenPGP public key file name.  The default name is
213
 
            <quote><filename>/conf/conf.d/mandos/pubkey.txt</filename
214
 
            ></quote>.
 
235
            OpenPGP public key file base name.  This will be combined
 
236
            with the directory from the <option>--keydir</option>
 
237
            option to form an absolute file name.  The default name is
 
238
            <quote><literal>pubkey.txt</literal></quote>.
215
239
          </para>
216
240
        </listitem>
217
241
      </varlistentry>
223
247
        <replaceable>FILE</replaceable></option></term>
224
248
        <listitem>
225
249
          <para>
226
 
            OpenPGP secret key file name.  The default name is
227
 
            <quote><filename>/conf/conf.d/mandos/seckey.txt</filename
228
 
            ></quote>.
 
250
            OpenPGP secret key file base name.  This will be combined
 
251
            with the directory from the <option>--keydir</option>
 
252
            option to form an absolute file name.  The default name is
 
253
            <quote><literal>seckey.txt</literal></quote>.
229
254
          </para>
230
255
        </listitem>
231
256
      </varlistentry>
314
339
      at all.  This is why a separate plugin (<citerefentry>
315
340
      <refentrytitle>password-prompt</refentrytitle>
316
341
      <manvolnum>8mandos</manvolnum></citerefentry>) does that, which
317
 
      will be run in parallel to this one by the plugin runner.
 
342
      will be run in parallell to this one by the plugin runner.
318
343
    </para>
319
344
  </refsect1>
320
345
  
395
420
    </informalexample>
396
421
    <informalexample>
397
422
      <para>
398
 
        Run in debug mode, and use a custom key:
 
423
        Run in debug mode, and use a custom key directory:
399
424
      </para>
400
425
      <para>
401
 
 
402
 
<!-- do not wrap this line -->
403
 
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt</userinput>
404
 
 
 
426
        <!-- do not wrap this line -->
 
427
        <userinput>&COMMANDNAME; --debug --keydir keydir</userinput>
405
428
      </para>
406
429
    </informalexample>
407
430
    <informalexample>
408
431
      <para>
409
 
        Run in debug mode, with a custom key, and do not use Zeroconf
410
 
        to locate a server; connect directly to the IPv6 address
411
 
        <quote><systemitem class="ipaddress"
 
432
        Run in debug mode, with a custom key directory, and do not use
 
433
        Zeroconf to locate a server; connect directly to the IPv6
 
434
        address <quote><systemitem class="ipaddress"
412
435
        >2001:db8:f983:bd0b:30de:ae4a:71f2:f672</systemitem></quote>,
413
436
        port 4711, using interface eth2:
414
437
      </para>
415
438
      <para>
416
439
 
417
440
<!-- do not wrap this line -->
418
 
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect 2001:db8:f983:bd0b:30de:ae4a:71f2:f672:4711 --interface eth2</userinput>
 
441
<userinput>&COMMANDNAME; --debug --keydir keydir --connect 2001:db8:f983:bd0b:30de:ae4a:71f2:f672:4711 --interface eth2</userinput>
419
442
 
420
443
      </para>
421
444
    </informalexample>