/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: 2011-12-31 23:05:34 UTC
  • Revision ID: teddy@recompile.se-20111231230534-o5w0uhwx30gwhmk7
Updated year in copyright notices.

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-07-03">
 
5
<!ENTITY TIMESTAMP "2012-01-01">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
36
36
      <year>2010</year>
37
37
      <year>2011</year>
38
38
      <year>2012</year>
39
 
      <year>2013</year>
40
 
      <year>2014</year>
41
 
      <year>2015</year>
42
 
      <year>2016</year>
43
39
      <holder>Teddy Hogeborn</holder>
44
40
      <holder>Björn Påhlsson</holder>
45
41
    </copyright>
104
100
      <sbr/>
105
101
      <arg><option>--statedir
106
102
      <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
103
    </cmdsynopsis>
115
104
    <cmdsynopsis>
116
105
      <command>&COMMANDNAME;</command>
297
286
        <term><option>--no-restore</option></term>
298
287
        <listitem>
299
288
          <xi:include href="mandos-options.xml" xpointer="restore"/>
300
 
          <para>
301
 
            See also <xref linkend="persistent_state"/>.
302
 
          </para>
303
289
        </listitem>
304
290
      </varlistentry>
305
291
      
310
296
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
311
297
        </listitem>
312
298
      </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
299
    </variablelist>
338
300
  </refsect1>
339
301
  
416
378
      extended timeout, checker program, and interval between checks
417
379
      can be configured both globally and per client; see
418
380
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
419
 
      <manvolnum>5</manvolnum></citerefentry>.
 
381
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
 
382
      receiving its password will also be treated as a successful
 
383
      checker run.
420
384
    </para>
421
385
  </refsect1>
422
386
  
450
414
    </para>
451
415
  </refsect1>
452
416
  
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
417
  <refsect1 id="dbus_interface">
466
418
    <title>D-BUS INTERFACE</title>
467
419
    <para>
529
481
        </listitem>
530
482
      </varlistentry>
531
483
      <varlistentry>
532
 
        <term><filename>/run/mandos.pid</filename></term>
 
484
        <term><filename>/var/run/mandos.pid</filename></term>
533
485
        <listitem>
534
486
          <para>
535
487
            The file containing the process id of the
536
488
            <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
489
          </para>
542
490
        </listitem>
543
491
      </varlistentry>
544
492
      <varlistentry>
 
493
        <term><filename class="devicefile">/dev/log</filename></term>
 
494
      </varlistentry>
 
495
      <varlistentry>
545
496
        <term><filename
546
497
        class="directory">/var/lib/mandos</filename></term>
547
498
        <listitem>
553
504
        </listitem>
554
505
      </varlistentry>
555
506
      <varlistentry>
556
 
        <term><filename class="devicefile">/dev/log</filename></term>
 
507
        <term><filename>/dev/log</filename></term>
557
508
        <listitem>
558
509
          <para>
559
510
            The Unix domain socket to where local syslog messages are
585
536
      There is no fine-grained control over logging and debug output.
586
537
    </para>
587
538
    <para>
 
539
      Debug mode is conflated with running in the foreground.
 
540
    </para>
 
541
    <para>
588
542
      This server does not check the expire time of clients’ OpenPGP
589
543
      keys.
590
544
    </para>
591
 
    <xi:include href="bugs.xml"/>
592
545
  </refsect1>
593
546
  
594
547
  <refsect1 id="example">
707
660
      </varlistentry>
708
661
      <varlistentry>
709
662
        <term>
710
 
          <ulink url="https://gnutls.org/">GnuTLS</ulink>
 
663
          <ulink url="http://www.gnu.org/software/gnutls/"
 
664
          >GnuTLS</ulink>
711
665
        </term>
712
666
      <listitem>
713
667
        <para>
751
705
      </varlistentry>
752
706
      <varlistentry>
753
707
        <term>
754
 
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
755
 
          Protocol Version 1.2</citetitle>
 
708
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
709
          Protocol Version 1.1</citetitle>
756
710
        </term>
757
711
      <listitem>
758
712
        <para>
759
 
          TLS 1.2 is the protocol implemented by GnuTLS.
 
713
          TLS 1.1 is the protocol implemented by GnuTLS.
760
714
        </para>
761
715
      </listitem>
762
716
      </varlistentry>
772
726
      </varlistentry>
773
727
      <varlistentry>
774
728
        <term>
775
 
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
776
 
          Security (TLS) Authentication</citetitle>
 
729
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
730
          Security</citetitle>
777
731
        </term>
778
732
      <listitem>
779
733
        <para>