/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

  • Committer: Björn Påhlsson
  • Date: 2011-09-26 18:47:38 UTC
  • mto: (237.7.50 mandos)
  • mto: This revision was merged to the branch mainline in revision 286.
  • Revision ID: belorn@fukt.bsnet.se-20110926184738-ee8kz5vc9pb3393m
updated TODO

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-02-09">
 
5
<!ENTITY TIMESTAMP "2011-08-08">
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>
36
37
      <holder>Teddy Hogeborn</holder>
37
38
      <holder>Björn Påhlsson</holder>
38
39
    </copyright>
97
98
      </arg>
98
99
      <sbr/>
99
100
      <arg>
 
101
        <option>--retry <replaceable>SECONDS</replaceable></option>
 
102
      </arg>
 
103
      <sbr/>
 
104
      <arg>
100
105
        <option>--debug</option>
101
106
      </arg>
102
107
    </cmdsynopsis>
133
138
      using TLS with an OpenPGP key to ensure authenticity and
134
139
      confidentiality.  This client program keeps running, trying all
135
140
      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.
 
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.
139
144
    </para>
140
145
    <para>
141
146
      This program is not meant to be run directly; it is really meant
202
207
        <listitem>
203
208
          <para>
204
209
            Network interface that will be brought up and scanned for
205
 
            Mandos servers to connect to.  The default is
206
 
            <quote><literal>eth0</literal></quote>.
 
210
            Mandos servers to connect to.  The default is the empty
 
211
            string, which will automatically choose an appropriate
 
212
            interface.
207
213
          </para>
208
214
          <para>
209
215
            If the <option>--connect</option> option is used, this
220
226
            by this program.
221
227
          </para>
222
228
          <para>
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.
 
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.
227
234
          </para>
228
235
        </listitem>
229
236
      </varlistentry>
291
298
          </para>
292
299
        </listitem>
293
300
      </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>
294
314
      
295
315
      <varlistentry>
296
316
        <term><option>--debug</option></term>
369
389
      server could be found and the password received from it could be
370
390
      successfully decrypted and output on standard output.  The
371
391
      program will exit with a non-zero exit status only if a critical
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.
 
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.
375
395
    </para>
376
396
  </refsect1>
377
397
  
516
536
  <refsect1 id="see_also">
517
537
    <title>SEE ALSO</title>
518
538
    <para>
 
539
      <citerefentry><refentrytitle>intro</refentrytitle>
 
540
      <manvolnum>8mandos</manvolnum></citerefentry>,
519
541
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
520
542
      <manvolnum>8</manvolnum></citerefentry>,
521
543
      <citerefentry><refentrytitle>crypttab</refentrytitle>