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

merge

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugins.d/password-request.xml
2
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
3
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
4
<!ENTITY VERSION "1.0">
5
 
<!ENTITY COMMANDNAME "mandos-client">
6
 
<!ENTITY TIMESTAMP "2008-09-12">
 
5
<!ENTITY COMMANDNAME "password-request">
 
6
<!ENTITY TIMESTAMP "2008-09-03">
7
7
]>
8
8
 
9
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
36
36
    </copyright>
37
37
    <xi:include href="../legalnotice.xml"/>
38
38
  </refentryinfo>
39
 
  
 
39
 
40
40
  <refmeta>
41
41
    <refentrytitle>&COMMANDNAME;</refentrytitle>
42
42
    <manvolnum>8mandos</manvolnum>
45
45
  <refnamediv>
46
46
    <refname><command>&COMMANDNAME;</command></refname>
47
47
    <refpurpose>
48
 
      Client for <application>Mandos</application>
 
48
      Client for mandos
49
49
    </refpurpose>
50
50
  </refnamediv>
51
 
  
 
51
 
52
52
  <refsynopsisdiv>
53
53
    <cmdsynopsis>
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/>
113
113
      </group>
114
114
    </cmdsynopsis>
115
115
  </refsynopsisdiv>
116
 
  
 
116
 
117
117
  <refsect1 id="description">
118
118
    <title>DESCRIPTION</title>
119
119
    <para>
124
124
      network connectivity, Zeroconf to find servers, and TLS with an
125
125
      OpenPGP key to ensure authenticity and confidentiality.  It
126
126
      keeps running, trying all servers on the network, until it
127
 
      receives a satisfactory reply or a TERM signal is received.
 
127
      receives a satisfactory reply or a TERM signal is recieved.
128
128
    </para>
129
129
    <para>
130
130
      This program is not meant to be run directly; it is really meant
215
215
          </para>
216
216
        </listitem>
217
217
      </varlistentry>
218
 
      
 
218
 
219
219
      <varlistentry>
220
220
        <term><option>--seckey=<replaceable
221
221
        >FILE</replaceable></option></term>
238
238
                      xpointer="priority"/>
239
239
        </listitem>
240
240
      </varlistentry>
241
 
      
 
241
 
242
242
      <varlistentry>
243
243
        <term><option>--dh-bits=<replaceable
244
244
        >BITS</replaceable></option></term>
284
284
          </para>
285
285
        </listitem>
286
286
      </varlistentry>
287
 
      
 
287
 
288
288
      <varlistentry>
289
289
        <term><option>--version</option></term>
290
290
        <term><option>-V</option></term>
296
296
      </varlistentry>
297
297
    </variablelist>
298
298
  </refsect1>
299
 
  
 
299
 
300
300
  <refsect1 id="overview">
301
301
    <title>OVERVIEW</title>
302
302
    <xi:include href="../overview.xml"/>
311
311
      <filename>/etc/crypttab</filename>, but it would then be
312
312
      impossible to enter a password for the encrypted root disk at
313
313
      the console, since this program does not read from the console
314
 
      at all.  This is why a separate plugin runner (<citerefentry>
315
 
      <refentrytitle>plugin-runner</refentrytitle>
316
 
      <manvolnum>8mandos</manvolnum></citerefentry>) is used to run
317
 
      both this program and others in in parallel,
318
 
      <emphasis>one</emphasis> of which will prompt for passwords on
319
 
      the system console.
 
314
      at all.  This is why a separate plugin (<citerefentry>
 
315
      <refentrytitle>password-prompt</refentrytitle>
 
316
      <manvolnum>8mandos</manvolnum></citerefentry>) does that, which
 
317
      will be run in parallell to this one by the plugin runner.
320
318
    </para>
321
319
  </refsect1>
322
320
  
329
327
      program will exit with a non-zero exit status only if a critical
330
328
      error occurs.  Otherwise, it will forever connect to new
331
329
      <application>Mandos</application> servers as they appear, trying
332
 
      to get a decryptable password and print it.
 
330
      to get a decryptable password.
333
331
    </para>
334
332
  </refsect1>
335
333
  
368
366
<!--     <para> -->
369
367
<!--     </para> -->
370
368
<!--   </refsect1> -->
371
 
  
 
369
 
372
370
  <refsect1 id="example">
373
371
    <title>EXAMPLE</title>
374
372
    <para>
388
386
    </informalexample>
389
387
    <informalexample>
390
388
      <para>
391
 
        Search for Mandos servers (and connect to them) using another
392
 
        interface:
 
389
        Search for Mandos servers on another interface:
393
390
      </para>
394
391
      <para>
395
392
        <!-- do not wrap this line -->
423
420
      </para>
424
421
    </informalexample>
425
422
  </refsect1>
426
 
  
 
423
 
427
424
  <refsect1 id="security">
428
425
    <title>SECURITY</title>
429
426
    <para>
470
467
      confidential.
471
468
    </para>
472
469
  </refsect1>
473
 
  
 
470
 
474
471
  <refsect1 id="see_also">
475
472
    <title>SEE ALSO</title>
476
473
    <para>
601
598
      </varlistentry>
602
599
    </variablelist>
603
600
  </refsect1>
 
601
 
604
602
</refentry>
605
 
 
606
603
<!-- Local Variables: -->
607
604
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
608
605
<!-- time-stamp-end: "[\"']>" -->