/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/watch: Also watch for "*.tar.xz" files.

* plugins.d/plymouth.c (getargv): Use argz_count() and argz_extract().
* plugins.d/usplash.c (main): - '' -

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 "2009-01-04">
 
5
<!ENTITY TIMESTAMP "2009-02-09">
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>
122
126
      <command>&COMMANDNAME;</command> is a client program that
123
127
      communicates with <citerefentry><refentrytitle
124
128
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
125
 
      to get a password.  It uses IPv6 link-local addresses to get
126
 
      network connectivity, Zeroconf to find servers, and TLS with an
127
 
      OpenPGP key to ensure authenticity and confidentiality.  It
128
 
      keeps running, trying all servers on the network, until it
129
 
      receives a satisfactory reply or a TERM signal is received.
 
129
      to get a password.  In slightly more detail, this client program
 
130
      brings up a network interface, uses the interface’s IPv6
 
131
      link-local address to get network connectivity, uses Zeroconf to
 
132
      find servers on the local network, and communicates with servers
 
133
      using TLS with an OpenPGP key to ensure authenticity and
 
134
      confidentiality.  This client program keeps running, trying all
 
135
      servers on the network, until it receives a satisfactory reply
 
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.
130
139
    </para>
131
140
    <para>
132
141
      This program is not meant to be run directly; it is really meant
186
195
      </varlistentry>
187
196
      
188
197
      <varlistentry>
189
 
        <term><option>--interface=
190
 
        <replaceable>NAME</replaceable></option></term>
 
198
        <term><option>--interface=<replaceable
 
199
        >NAME</replaceable></option></term>
191
200
        <term><option>-i
192
201
        <replaceable>NAME</replaceable></option></term>
193
202
        <listitem>
194
203
          <para>
195
204
            Network interface that will be brought up and scanned for
196
 
            Mandos servers to connect to.  The default it
197
 
            <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.
198
208
          </para>
199
209
          <para>
200
210
            If the <option>--connect</option> option is used, this
201
211
            specifies the interface to use to connect to the address
202
212
            given.
203
213
          </para>
 
214
          <para>
 
215
            Note that since this program will normally run in the
 
216
            initial RAM disk environment, the interface must be an
 
217
            interface which exists at that stage.  Thus, the interface
 
218
            can not be a pseudo-interface such as <quote>br0</quote>
 
219
            or <quote>tun0</quote>; such interfaces will not exist
 
220
            until much later in the boot process, and can not be used
 
221
            by this program.
 
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>
204
230
        </listitem>
205
231
      </varlistentry>
206
232
      
251
277
          </para>
252
278
        </listitem>
253
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>
254
296
      
255
297
      <varlistentry>
256
298
        <term><option>--debug</option></term>
412
454
    <informalexample>
413
455
      <para>
414
456
        Run in debug mode, with a custom key, and do not use Zeroconf
415
 
        to locate a server; connect directly to the IPv6 address
416
 
        <quote><systemitem class="ipaddress"
417
 
        >2001:db8:f983:bd0b:30de:ae4a:71f2:f672</systemitem></quote>,
418
 
        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:
419
461
      </para>
420
462
      <para>
421
463
 
422
464
<!-- do not wrap this line -->
423
 
<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>
424
466
 
425
467
      </para>
426
468
    </informalexample>