/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: 2009-02-05 03:04:47 UTC
  • Revision ID: teddy@fukt.bsnet.se-20090205030447-k1039txjutilj00d
* plugin-runner.c (struct plugin.completed): Changed type to "volatile
                                             sig_atomic_t"; all uses
                                             changed.

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 COMMANDNAME "mandos-client">
5
 
<!ENTITY TIMESTAMP "2011-08-08">
 
5
<!ENTITY TIMESTAMP "2009-01-24">
6
6
<!ENTITY % common SYSTEM "../common.ent">
7
7
%common;
8
8
]>
33
33
    <copyright>
34
34
      <year>2008</year>
35
35
      <year>2009</year>
36
 
      <year>2011</year>
37
36
      <holder>Teddy Hogeborn</holder>
38
37
      <holder>Björn Påhlsson</holder>
39
38
    </copyright>
98
97
      </arg>
99
98
      <sbr/>
100
99
      <arg>
101
 
        <option>--retry <replaceable>SECONDS</replaceable></option>
102
 
      </arg>
103
 
      <sbr/>
104
 
      <arg>
105
100
        <option>--debug</option>
106
101
      </arg>
107
102
    </cmdsynopsis>
138
133
      using TLS with an OpenPGP key to ensure authenticity and
139
134
      confidentiality.  This client program keeps running, trying all
140
135
      servers on the network, until it receives a satisfactory reply
141
 
      or a TERM signal.  After all servers have been tried, all
142
 
      servers are periodically retried.  If no servers are found it
143
 
      will wait indefinitely for new servers to appear.
 
136
      or a TERM signal is received.  If no servers are found, or after
 
137
      all servers have been tried, it waits indefinitely for new
 
138
      servers to appear.
144
139
    </para>
145
140
    <para>
146
141
      This program is not meant to be run directly; it is really meant
200
195
      </varlistentry>
201
196
      
202
197
      <varlistentry>
203
 
        <term><option>--interface=<replaceable
204
 
        >NAME</replaceable></option></term>
 
198
        <term><option>--interface=
 
199
        <replaceable>NAME</replaceable></option></term>
205
200
        <term><option>-i
206
201
        <replaceable>NAME</replaceable></option></term>
207
202
        <listitem>
208
203
          <para>
209
204
            Network interface that will be brought up and scanned for
210
 
            Mandos servers to connect to.  The default is the empty
211
 
            string, which will automatically choose an appropriate
212
 
            interface.
 
205
            Mandos servers to connect to.  The default it
 
206
            <quote><literal>eth0</literal></quote>.
213
207
          </para>
214
208
          <para>
215
209
            If the <option>--connect</option> option is used, this
225
219
            until much later in the boot process, and can not be used
226
220
            by this program.
227
221
          </para>
228
 
          <para>
229
 
            <replaceable>NAME</replaceable> can be the string
230
 
            <quote><literal>none</literal></quote>; this will not use
231
 
            any specific interface, and will not bring up an interface
232
 
            on startup.  This is not recommended, and only meant for
233
 
            advanced users.
234
 
          </para>
235
222
        </listitem>
236
223
      </varlistentry>
237
224
      
298
285
          </para>
299
286
        </listitem>
300
287
      </varlistentry>
301
 
 
302
 
      <varlistentry>
303
 
        <term><option>--retry=<replaceable
304
 
        >SECONDS</replaceable></option></term>
305
 
        <listitem>
306
 
          <para>
307
 
            All Mandos servers are tried repeatedly until a password
308
 
            is received.  This value specifies, in seconds, how long
309
 
            between each successive try <emphasis>for the same
310
 
            server</emphasis>.  The default is 10 seconds.
311
 
          </para>
312
 
        </listitem>
313
 
      </varlistentry>
314
288
      
315
289
      <varlistentry>
316
290
        <term><option>--debug</option></term>
389
363
      server could be found and the password received from it could be
390
364
      successfully decrypted and output on standard output.  The
391
365
      program will exit with a non-zero exit status only if a critical
392
 
      error occurs.  Otherwise, it will forever connect to any
393
 
      discovered <application>Mandos</application> servers, trying to
394
 
      get a decryptable password and print it.
 
366
      error occurs.  Otherwise, it will forever connect to new
 
367
      <application>Mandos</application> servers as they appear, trying
 
368
      to get a decryptable password and print it.
395
369
    </para>
396
370
  </refsect1>
397
371
  
472
446
    <informalexample>
473
447
      <para>
474
448
        Run in debug mode, with a custom key, and do not use Zeroconf
475
 
        to locate a server; connect directly to the IPv6 link-local
476
 
        address <quote><systemitem class="ipaddress"
477
 
        >fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
478
 
        using interface eth2:
 
449
        to locate a server; connect directly to the IPv6 address
 
450
        <quote><systemitem class="ipaddress"
 
451
        >2001:db8:f983:bd0b:30de:ae4a:71f2:f672</systemitem></quote>,
 
452
        port 4711, using interface eth2:
479
453
      </para>
480
454
      <para>
481
455
 
482
456
<!-- do not wrap this line -->
483
 
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect fe80::aede:48ff:fe71:f6f2:4711 --interface eth2</userinput>
 
457
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect 2001:db8:f983:bd0b:30de:ae4a:71f2:f672:4711 --interface eth2</userinput>
484
458
 
485
459
      </para>
486
460
    </informalexample>
536
510
  <refsect1 id="see_also">
537
511
    <title>SEE ALSO</title>
538
512
    <para>
539
 
      <citerefentry><refentrytitle>intro</refentrytitle>
540
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
541
513
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
542
514
      <manvolnum>8</manvolnum></citerefentry>,
543
515
      <citerefentry><refentrytitle>crypttab</refentrytitle>