/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-13 10:18:17 UTC
  • mfrom: (237.2.14 mandos-release)
  • Revision ID: teddy@fukt.bsnet.se-20090213101817-3ld1fzg058g9zkfv
Merge from release branch.

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 "2011-08-08">
 
5
<!ENTITY TIMESTAMP "2009-02-09">
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
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 is
 
206
            <quote><literal>eth0</literal></quote>.
213
207
          </para>
214
208
          <para>
215
209
            If the <option>--connect</option> option is used, this
226
220
            by this program.
227
221
          </para>
228
222
          <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.
 
223
            <replaceable>NAME</replaceable> can be the empty string;
 
224
            this will not use any specific interface, and will not
 
225
            bring up an interface on startup.  This is not
 
226
            recommended, and only meant for advanced users.
234
227
          </para>
235
228
        </listitem>
236
229
      </varlistentry>
298
291
          </para>
299
292
        </listitem>
300
293
      </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
294
      
315
295
      <varlistentry>
316
296
        <term><option>--debug</option></term>
389
369
      server could be found and the password received from it could be
390
370
      successfully decrypted and output on standard output.  The
391
371
      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.
 
372
      error occurs.  Otherwise, it will forever connect to new
 
373
      <application>Mandos</application> servers as they appear, trying
 
374
      to get a decryptable password and print it.
395
375
    </para>
396
376
  </refsect1>
397
377
  
536
516
  <refsect1 id="see_also">
537
517
    <title>SEE ALSO</title>
538
518
    <para>
539
 
      <citerefentry><refentrytitle>intro</refentrytitle>
540
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
541
519
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
542
520
      <manvolnum>8</manvolnum></citerefentry>,
543
521
      <citerefentry><refentrytitle>crypttab</refentrytitle>