/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/mandos-client.xml

  • Committer: Teddy Hogeborn
  • Date: 2008-09-19 13:50:22 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080919135022-214t21hetv8jgv0y
* debian/mandos-client.docs: New.  Add README and TODO file.
* debian/mandos.docs: - '' -

* debian/mandos-client.links: New.  Create plugin-runner.conf(5) link.

* debian/rules (DH_VERBOSE): Commented out.
               Removed commented-out unused dh_* stuff.  Removed
               "dh_makeshlibs".

Show diffs side-by-side

added added

removed removed

Lines of Context:
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 "password-request">
6
 
<!ENTITY TIMESTAMP "2008-09-03">
 
5
<!ENTITY COMMANDNAME "mandos-client">
 
6
<!ENTITY TIMESTAMP "2008-09-12">
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 mandos
 
48
      Client for <application>Mandos</application>
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>IPADDR</replaceable><literal>:</literal
 
57
        <replaceable>ADDRESS</replaceable><literal>:</literal
58
58
        ><replaceable>PORT</replaceable></option></arg>
59
59
        <arg choice="plain"><option>-c
60
 
        <replaceable>IPADDR</replaceable><literal>:</literal
 
60
        <replaceable>ADDRESS</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 recieved.
 
127
      receives a satisfactory reply or a TERM signal is received.
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 (<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.
 
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.
318
320
    </para>
319
321
  </refsect1>
320
322
  
327
329
      program will exit with a non-zero exit status only if a critical
328
330
      error occurs.  Otherwise, it will forever connect to new
329
331
      <application>Mandos</application> servers as they appear, trying
330
 
      to get a decryptable password.
 
332
      to get a decryptable password and print it.
331
333
    </para>
332
334
  </refsect1>
333
335
  
366
368
<!--     <para> -->
367
369
<!--     </para> -->
368
370
<!--   </refsect1> -->
369
 
 
 
371
  
370
372
  <refsect1 id="example">
371
373
    <title>EXAMPLE</title>
372
374
    <para>
386
388
    </informalexample>
387
389
    <informalexample>
388
390
      <para>
389
 
        Search for Mandos servers on another interface:
 
391
        Search for Mandos servers (and connect to them) using another
 
392
        interface:
390
393
      </para>
391
394
      <para>
392
395
        <!-- do not wrap this line -->
420
423
      </para>
421
424
    </informalexample>
422
425
  </refsect1>
423
 
 
 
426
  
424
427
  <refsect1 id="security">
425
428
    <title>SECURITY</title>
426
429
    <para>
467
470
      confidential.
468
471
    </para>
469
472
  </refsect1>
470
 
 
 
473
  
471
474
  <refsect1 id="see_also">
472
475
    <title>SEE ALSO</title>
473
476
    <para>
598
601
      </varlistentry>
599
602
    </variablelist>
600
603
  </refsect1>
601
 
 
602
604
</refentry>
 
605
 
603
606
<!-- Local Variables: -->
604
607
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
605
608
<!-- time-stamp-end: "[\"']>" -->