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

  • Committer: Teddy Hogeborn
  • Date: 2013-10-22 19:46:35 UTC
  • Revision ID: teddy@recompile.se-20131022194635-ll6jyg1snrxwe94o
* TODO

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 "2011-11-26">
 
5
<!ENTITY TIMESTAMP "2013-10-20">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
35
35
      <year>2009</year>
36
36
      <year>2010</year>
37
37
      <year>2011</year>
 
38
      <year>2012</year>
 
39
      <year>2013</year>
38
40
      <holder>Teddy Hogeborn</holder>
39
41
      <holder>Björn Påhlsson</holder>
40
42
    </copyright>
99
101
      <sbr/>
100
102
      <arg><option>--statedir
101
103
      <replaceable>DIRECTORY</replaceable></option></arg>
 
104
      <sbr/>
 
105
      <arg><option>--socket
 
106
      <replaceable>FD</replaceable></option></arg>
 
107
      <sbr/>
 
108
      <arg><option>--foreground</option></arg>
102
109
    </cmdsynopsis>
103
110
    <cmdsynopsis>
104
111
      <command>&COMMANDNAME;</command>
285
292
        <term><option>--no-restore</option></term>
286
293
        <listitem>
287
294
          <xi:include href="mandos-options.xml" xpointer="restore"/>
 
295
          <para>
 
296
            See also <xref linkend="persistent_state"/>.
 
297
          </para>
288
298
        </listitem>
289
299
      </varlistentry>
290
300
      
295
305
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
296
306
        </listitem>
297
307
      </varlistentry>
 
308
      
 
309
      <varlistentry>
 
310
        <term><option>--socket
 
311
        <replaceable>FD</replaceable></option></term>
 
312
        <listitem>
 
313
          <xi:include href="mandos-options.xml" xpointer="socket"/>
 
314
        </listitem>
 
315
      </varlistentry>
 
316
      
 
317
      <varlistentry>
 
318
        <term><option>--foreground</option></term>
 
319
        <listitem>
 
320
          <xi:include href="mandos-options.xml"
 
321
                      xpointer="foreground"/>
 
322
        </listitem>
 
323
      </varlistentry>
 
324
      
298
325
    </variablelist>
299
326
  </refsect1>
300
327
  
377
404
      extended timeout, checker program, and interval between checks
378
405
      can be configured both globally and per client; see
379
406
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
380
 
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
381
 
      receiving its password will also be treated as a successful
382
 
      checker run.
 
407
      <manvolnum>5</manvolnum></citerefentry>.
383
408
    </para>
384
409
  </refsect1>
385
410
  
407
432
    <title>LOGGING</title>
408
433
    <para>
409
434
      The server will send log message with various severity levels to
410
 
      <filename>/dev/log</filename>.  With the
 
435
      <filename class="devicefile">/dev/log</filename>.  With the
411
436
      <option>--debug</option> option, it will log even more messages,
412
437
      and also show them on the console.
413
438
    </para>
414
439
  </refsect1>
415
440
  
 
441
  <refsect1 id="persistent_state">
 
442
    <title>PERSISTENT STATE</title>
 
443
    <para>
 
444
      Client settings, initially read from
 
445
      <filename>clients.conf</filename>, are persistent across
 
446
      restarts, and run-time changes will override settings in
 
447
      <filename>clients.conf</filename>.  However, if a setting is
 
448
      <emphasis>changed</emphasis> (or a client added, or removed) in
 
449
      <filename>clients.conf</filename>, this will take precedence.
 
450
    </para>
 
451
  </refsect1>
 
452
  
416
453
  <refsect1 id="dbus_interface">
417
454
    <title>D-BUS INTERFACE</title>
418
455
    <para>
480
517
        </listitem>
481
518
      </varlistentry>
482
519
      <varlistentry>
483
 
        <term><filename>/var/run/mandos.pid</filename></term>
 
520
        <term><filename>/run/mandos.pid</filename></term>
484
521
        <listitem>
485
522
          <para>
486
523
            The file containing the process id of the
489
526
        </listitem>
490
527
      </varlistentry>
491
528
      <varlistentry>
 
529
        <term><filename class="devicefile">/dev/log</filename></term>
 
530
      </varlistentry>
 
531
      <varlistentry>
492
532
        <term><filename
493
533
        class="directory">/var/lib/mandos</filename></term>
494
534
        <listitem>
532
572
      There is no fine-grained control over logging and debug output.
533
573
    </para>
534
574
    <para>
535
 
      Debug mode is conflated with running in the foreground.
536
 
    </para>
537
 
    <para>
538
575
      This server does not check the expire time of clients’ OpenPGP
539
576
      keys.
540
577
    </para>