/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: Björn Påhlsson
  • Date: 2011-08-08 16:46:13 UTC
  • mfrom: (492 trunk)
  • mto: This revision was merged to the branch mainline in revision 497.
  • Revision ID: belorn@fukt.bsnet.se-20110808164613-k5bplla57ofg2wa1
merge

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-02-09">
 
5
<!ENTITY TIMESTAMP "2010-09-26">
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>
100
104
        <option>--debug</option>
101
105
      </arg>
102
106
    </cmdsynopsis>
133
137
      using TLS with an OpenPGP key to ensure authenticity and
134
138
      confidentiality.  This client program keeps running, trying all
135
139
      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.
 
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.
139
143
    </para>
140
144
    <para>
141
145
      This program is not meant to be run directly; it is really meant
202
206
        <listitem>
203
207
          <para>
204
208
            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>.
 
209
            Mandos servers to connect to.  The default is the empty
 
210
            string, which will automatically choose an appropriate
 
211
            interface.
207
212
          </para>
208
213
          <para>
209
214
            If the <option>--connect</option> option is used, this
220
225
            by this program.
221
226
          </para>
222
227
          <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.
 
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.
227
233
          </para>
228
234
        </listitem>
229
235
      </varlistentry>
291
297
          </para>
292
298
        </listitem>
293
299
      </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>
294
313
      
295
314
      <varlistentry>
296
315
        <term><option>--debug</option></term>
369
388
      server could be found and the password received from it could be
370
389
      successfully decrypted and output on standard output.  The
371
390
      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.
 
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.
375
394
    </para>
376
395
  </refsect1>
377
396