/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

merge

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 "2016-02-28">
 
5
<!ENTITY TIMESTAMP "2011-11-26">
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>
40
 
      <year>2014</year>
41
 
      <year>2015</year>
42
 
      <year>2016</year>
43
38
      <holder>Teddy Hogeborn</holder>
44
39
      <holder>Björn Påhlsson</holder>
45
40
    </copyright>
104
99
      <sbr/>
105
100
      <arg><option>--statedir
106
101
      <replaceable>DIRECTORY</replaceable></option></arg>
107
 
      <sbr/>
108
 
      <arg><option>--socket
109
 
      <replaceable>FD</replaceable></option></arg>
110
 
      <sbr/>
111
 
      <arg><option>--foreground</option></arg>
112
 
      <sbr/>
113
 
      <arg><option>--no-zeroconf</option></arg>
114
102
    </cmdsynopsis>
115
103
    <cmdsynopsis>
116
104
      <command>&COMMANDNAME;</command>
297
285
        <term><option>--no-restore</option></term>
298
286
        <listitem>
299
287
          <xi:include href="mandos-options.xml" xpointer="restore"/>
300
 
          <para>
301
 
            See also <xref linkend="persistent_state"/>.
302
 
          </para>
303
288
        </listitem>
304
289
      </varlistentry>
305
290
      
310
295
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
311
296
        </listitem>
312
297
      </varlistentry>
313
 
      
314
 
      <varlistentry>
315
 
        <term><option>--socket
316
 
        <replaceable>FD</replaceable></option></term>
317
 
        <listitem>
318
 
          <xi:include href="mandos-options.xml" xpointer="socket"/>
319
 
        </listitem>
320
 
      </varlistentry>
321
 
      
322
 
      <varlistentry>
323
 
        <term><option>--foreground</option></term>
324
 
        <listitem>
325
 
          <xi:include href="mandos-options.xml"
326
 
                      xpointer="foreground"/>
327
 
        </listitem>
328
 
      </varlistentry>
329
 
      
330
 
      <varlistentry>
331
 
        <term><option>--no-zeroconf</option></term>
332
 
        <listitem>
333
 
          <xi:include href="mandos-options.xml" xpointer="zeroconf"/>
334
 
        </listitem>
335
 
      </varlistentry>
336
 
      
337
298
    </variablelist>
338
299
  </refsect1>
339
300
  
416
377
      extended timeout, checker program, and interval between checks
417
378
      can be configured both globally and per client; see
418
379
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
419
 
      <manvolnum>5</manvolnum></citerefentry>.
 
380
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
 
381
      receiving its password will also be treated as a successful
 
382
      checker run.
420
383
    </para>
421
384
  </refsect1>
422
385
  
444
407
    <title>LOGGING</title>
445
408
    <para>
446
409
      The server will send log message with various severity levels to
447
 
      <filename class="devicefile">/dev/log</filename>.  With the
 
410
      <filename>/dev/log</filename>.  With the
448
411
      <option>--debug</option> option, it will log even more messages,
449
412
      and also show them on the console.
450
413
    </para>
451
414
  </refsect1>
452
415
  
453
 
  <refsect1 id="persistent_state">
454
 
    <title>PERSISTENT STATE</title>
455
 
    <para>
456
 
      Client settings, initially read from
457
 
      <filename>clients.conf</filename>, are persistent across
458
 
      restarts, and run-time changes will override settings in
459
 
      <filename>clients.conf</filename>.  However, if a setting is
460
 
      <emphasis>changed</emphasis> (or a client added, or removed) in
461
 
      <filename>clients.conf</filename>, this will take precedence.
462
 
    </para>
463
 
  </refsect1>
464
 
  
465
416
  <refsect1 id="dbus_interface">
466
417
    <title>D-BUS INTERFACE</title>
467
418
    <para>
529
480
        </listitem>
530
481
      </varlistentry>
531
482
      <varlistentry>
532
 
        <term><filename>/run/mandos.pid</filename></term>
 
483
        <term><filename>/var/run/mandos.pid</filename></term>
533
484
        <listitem>
534
485
          <para>
535
486
            The file containing the process id of the
536
487
            <command>&COMMANDNAME;</command> process started last.
537
 
            <emphasis >Note:</emphasis> If the <filename
538
 
            class="directory">/run</filename> directory does not
539
 
            exist, <filename>/var/run/mandos.pid</filename> will be
540
 
            used instead.
541
488
          </para>
542
489
        </listitem>
543
490
      </varlistentry>
553
500
        </listitem>
554
501
      </varlistentry>
555
502
      <varlistentry>
556
 
        <term><filename class="devicefile">/dev/log</filename></term>
 
503
        <term><filename>/dev/log</filename></term>
557
504
        <listitem>
558
505
          <para>
559
506
            The Unix domain socket to where local syslog messages are
585
532
      There is no fine-grained control over logging and debug output.
586
533
    </para>
587
534
    <para>
 
535
      Debug mode is conflated with running in the foreground.
 
536
    </para>
 
537
    <para>
588
538
      This server does not check the expire time of clients’ OpenPGP
589
539
      keys.
590
540
    </para>
706
656
      </varlistentry>
707
657
      <varlistentry>
708
658
        <term>
709
 
          <ulink url="http://gnutls.org/">GnuTLS</ulink>
 
659
          <ulink url="http://www.gnu.org/software/gnutls/"
 
660
          >GnuTLS</ulink>
710
661
        </term>
711
662
      <listitem>
712
663
        <para>
750
701
      </varlistentry>
751
702
      <varlistentry>
752
703
        <term>
753
 
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
754
 
          Protocol Version 1.2</citetitle>
 
704
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
705
          Protocol Version 1.1</citetitle>
755
706
        </term>
756
707
      <listitem>
757
708
        <para>
758
 
          TLS 1.2 is the protocol implemented by GnuTLS.
 
709
          TLS 1.1 is the protocol implemented by GnuTLS.
759
710
        </para>
760
711
      </listitem>
761
712
      </varlistentry>
771
722
      </varlistentry>
772
723
      <varlistentry>
773
724
        <term>
774
 
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
775
 
          Security (TLS) Authentication</citetitle>
 
725
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
726
          Security</citetitle>
776
727
        </term>
777
728
      <listitem>
778
729
        <para>