/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-01-31 10:33:17 UTC
  • mfrom: (24.1.129 mandos)
  • Revision ID: teddy@fukt.bsnet.se-20090131103317-wzqvyr532sjcjt7u
Merge from Björn:

* mandos-ctl: New option "--remove-client".  Only default to listing
              clients if no clients were given on the command line.
* plugins.d/mandos-client.c: Lower kernel log level while bringing up
                             network interface.  New option "--delay"
                             to control the maximum delay to wait for
                             running interface.
* plugins.d/mandos-client.xml (SYNOPSIS, OPTIONS): New option
                                                   "--delay".

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugins.d/mandos-client.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 COMMANDNAME "mandos-client">
5
 
<!ENTITY TIMESTAMP "2010-09-26">
 
5
<!ENTITY TIMESTAMP "2009-01-24">
6
6
<!ENTITY % common SYSTEM "../common.ent">
7
7
%common;
8
8
]>
97
97
      </arg>
98
98
      <sbr/>
99
99
      <arg>
100
 
        <option>--retry <replaceable>SECONDS</replaceable></option>
101
 
      </arg>
102
 
      <sbr/>
103
 
      <arg>
104
100
        <option>--debug</option>
105
101
      </arg>
106
102
    </cmdsynopsis>
137
133
      using TLS with an OpenPGP key to ensure authenticity and
138
134
      confidentiality.  This client program keeps running, trying all
139
135
      servers on the network, until it receives a satisfactory reply
140
 
      or a TERM signal.  After all servers have been tried, all
141
 
      servers are periodically retried.  If no servers are found it
142
 
      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.
143
139
    </para>
144
140
    <para>
145
141
      This program is not meant to be run directly; it is really meant
199
195
      </varlistentry>
200
196
      
201
197
      <varlistentry>
202
 
        <term><option>--interface=<replaceable
203
 
        >NAME</replaceable></option></term>
 
198
        <term><option>--interface=
 
199
        <replaceable>NAME</replaceable></option></term>
204
200
        <term><option>-i
205
201
        <replaceable>NAME</replaceable></option></term>
206
202
        <listitem>
207
203
          <para>
208
204
            Network interface that will be brought up and scanned for
209
 
            Mandos servers to connect to.  The default is the empty
210
 
            string, which will automatically choose an appropriate
211
 
            interface.
 
205
            Mandos servers to connect to.  The default it
 
206
            <quote><literal>eth0</literal></quote>.
212
207
          </para>
213
208
          <para>
214
209
            If the <option>--connect</option> option is used, this
224
219
            until much later in the boot process, and can not be used
225
220
            by this program.
226
221
          </para>
227
 
          <para>
228
 
            <replaceable>NAME</replaceable> can be the string
229
 
            <quote><literal>none</literal></quote>; this will not use
230
 
            any specific interface, and will not bring up an interface
231
 
            on startup.  This is not recommended, and only meant for
232
 
            advanced users.
233
 
          </para>
234
222
        </listitem>
235
223
      </varlistentry>
236
224
      
297
285
          </para>
298
286
        </listitem>
299
287
      </varlistentry>
300
 
 
301
 
      <varlistentry>
302
 
        <term><option>--retry=<replaceable
303
 
        >SECONDS</replaceable></option></term>
304
 
        <listitem>
305
 
          <para>
306
 
            All Mandos servers are tried repeatedly until a password
307
 
            is received.  This value specifies, in seconds, how long
308
 
            between each successive try <emphasis>for the same
309
 
            server</emphasis>.  The default is 10 seconds.
310
 
          </para>
311
 
        </listitem>
312
 
      </varlistentry>
313
288
      
314
289
      <varlistentry>
315
290
        <term><option>--debug</option></term>
388
363
      server could be found and the password received from it could be
389
364
      successfully decrypted and output on standard output.  The
390
365
      program will exit with a non-zero exit status only if a critical
391
 
      error occurs.  Otherwise, it will forever connect to any
392
 
      discovered <application>Mandos</application> servers, trying to
393
 
      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.
394
369
    </para>
395
370
  </refsect1>
396
371
  
471
446
    <informalexample>
472
447
      <para>
473
448
        Run in debug mode, with a custom key, and do not use Zeroconf
474
 
        to locate a server; connect directly to the IPv6 link-local
475
 
        address <quote><systemitem class="ipaddress"
476
 
        >fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
477
 
        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:
478
453
      </para>
479
454
      <para>
480
455
 
481
456
<!-- do not wrap this line -->
482
 
<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>
483
458
 
484
459
      </para>
485
460
    </informalexample>