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

* plugins.d/mandos-client.xml (EXAMPLE): Doc fix: Network interface is
                                         now automatically determined,
                                         not always "eth0".

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos.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">
5
 
<!ENTITY TIMESTAMP "2012-01-01">
 
5
<!ENTITY TIMESTAMP "2012-05-26">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
100
100
      <sbr/>
101
101
      <arg><option>--statedir
102
102
      <replaceable>DIRECTORY</replaceable></option></arg>
 
103
      <sbr/>
 
104
      <arg><option>--socket
 
105
      <replaceable>FD</replaceable></option></arg>
103
106
    </cmdsynopsis>
104
107
    <cmdsynopsis>
105
108
      <command>&COMMANDNAME;</command>
286
289
        <term><option>--no-restore</option></term>
287
290
        <listitem>
288
291
          <xi:include href="mandos-options.xml" xpointer="restore"/>
 
292
          <para>
 
293
            See also <xref linkend="persistent_state"/>.
 
294
          </para>
289
295
        </listitem>
290
296
      </varlistentry>
291
297
      
296
302
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
297
303
        </listitem>
298
304
      </varlistentry>
 
305
      
 
306
      <varlistentry>
 
307
        <term><option>--socket
 
308
        <replaceable>FD</replaceable></option></term>
 
309
        <listitem>
 
310
          <xi:include href="mandos-options.xml" xpointer="socket"/>
 
311
        </listitem>
 
312
      </varlistentry>
 
313
      
299
314
    </variablelist>
300
315
  </refsect1>
301
316
  
378
393
      extended timeout, checker program, and interval between checks
379
394
      can be configured both globally and per client; see
380
395
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
381
 
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
382
 
      receiving its password will also be treated as a successful
383
 
      checker run.
 
396
      <manvolnum>5</manvolnum></citerefentry>.
384
397
    </para>
385
398
  </refsect1>
386
399
  
414
427
    </para>
415
428
  </refsect1>
416
429
  
 
430
  <refsect1 id="persistent_state">
 
431
    <title>PERSISTENT STATE</title>
 
432
    <para>
 
433
      Client settings, initially read from
 
434
      <filename>clients.conf</filename>, are persistent across
 
435
      restarts, and run-time changes will override settings in
 
436
      <filename>clients.conf</filename>.  However, if a setting is
 
437
      <emphasis>changed</emphasis> (or a client added, or removed) in
 
438
      <filename>clients.conf</filename>, this will take precedence.
 
439
    </para>
 
440
  </refsect1>
 
441
  
417
442
  <refsect1 id="dbus_interface">
418
443
    <title>D-BUS INTERFACE</title>
419
444
    <para>