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

* debian/control (Standards-Version): Updated to "3.9.1".
* mandos-keygen: Use "set -e" as per Debian Policy section 10.4.

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 "2009-01-24">
 
5
<!ENTITY TIMESTAMP "2010-09-26">
6
6
<!ENTITY % common SYSTEM "../common.ent">
7
7
%common;
8
8
]>
93
93
      </arg>
94
94
      <sbr/>
95
95
      <arg>
 
96
        <option>--delay <replaceable>SECONDS</replaceable></option>
 
97
      </arg>
 
98
      <sbr/>
 
99
      <arg>
96
100
        <option>--debug</option>
97
101
      </arg>
98
102
    </cmdsynopsis>
191
195
      </varlistentry>
192
196
      
193
197
      <varlistentry>
194
 
        <term><option>--interface=
195
 
        <replaceable>NAME</replaceable></option></term>
 
198
        <term><option>--interface=<replaceable
 
199
        >NAME</replaceable></option></term>
196
200
        <term><option>-i
197
201
        <replaceable>NAME</replaceable></option></term>
198
202
        <listitem>
199
203
          <para>
200
204
            Network interface that will be brought up and scanned for
201
 
            Mandos servers to connect to.  The default it
202
 
            <quote><literal>eth0</literal></quote>.
 
205
            Mandos servers to connect to.  The default is the empty
 
206
            string, which will automatically choose an appropriate
 
207
            interface.
203
208
          </para>
204
209
          <para>
205
210
            If the <option>--connect</option> option is used, this
215
220
            until much later in the boot process, and can not be used
216
221
            by this program.
217
222
          </para>
 
223
          <para>
 
224
            <replaceable>NAME</replaceable> can be the string
 
225
            <quote><literal>none</literal></quote>; this will not use
 
226
            any specific interface, and will not bring up an interface
 
227
            on startup.  This is not recommended, and only meant for
 
228
            advanced users.
 
229
          </para>
218
230
        </listitem>
219
231
      </varlistentry>
220
232
      
265
277
          </para>
266
278
        </listitem>
267
279
      </varlistentry>
 
280
 
 
281
      <varlistentry>
 
282
        <term><option>--delay=<replaceable
 
283
        >SECONDS</replaceable></option></term>
 
284
        <listitem>
 
285
          <para>
 
286
            After bringing the network interface up, the program waits
 
287
            for the interface to arrive in a <quote>running</quote>
 
288
            state before proceeding.  During this time, the kernel log
 
289
            level will be lowered to reduce clutter on the system
 
290
            console, alleviating any other plugins which might be
 
291
            using the system console.  This option sets the upper
 
292
            limit of seconds to wait.  The default is 2.5 seconds.
 
293
          </para>
 
294
        </listitem>
 
295
      </varlistentry>
268
296
      
269
297
      <varlistentry>
270
298
        <term><option>--debug</option></term>
426
454
    <informalexample>
427
455
      <para>
428
456
        Run in debug mode, with a custom key, and do not use Zeroconf
429
 
        to locate a server; connect directly to the IPv6 address
430
 
        <quote><systemitem class="ipaddress"
431
 
        >2001:db8:f983:bd0b:30de:ae4a:71f2:f672</systemitem></quote>,
432
 
        port 4711, using interface eth2:
 
457
        to locate a server; connect directly to the IPv6 link-local
 
458
        address <quote><systemitem class="ipaddress"
 
459
        >fe80::aede:48ff:fe71:f6f2</systemitem></quote>, port 4711,
 
460
        using interface eth2:
433
461
      </para>
434
462
      <para>
435
463
 
436
464
<!-- do not wrap this line -->
437
 
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect 2001:db8:f983:bd0b:30de:ae4a:71f2:f672:4711 --interface eth2</userinput>
 
465
<userinput>&COMMANDNAME; --debug --pubkey keydir/pubkey.txt --seckey keydir/seckey.txt --connect fe80::aede:48ff:fe71:f6f2:4711 --interface eth2</userinput>
438
466
 
439
467
      </para>
440
468
    </informalexample>