/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

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 "2018-02-08">
 
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
 
      <year>2017</year>
44
 
      <year>2018</year>
45
39
      <holder>Teddy Hogeborn</holder>
46
40
      <holder>Björn Påhlsson</holder>
47
41
    </copyright>
106
100
      <sbr/>
107
101
      <arg><option>--statedir
108
102
      <replaceable>DIRECTORY</replaceable></option></arg>
109
 
      <sbr/>
110
 
      <arg><option>--socket
111
 
      <replaceable>FD</replaceable></option></arg>
112
 
      <sbr/>
113
 
      <arg><option>--foreground</option></arg>
114
 
      <sbr/>
115
 
      <arg><option>--no-zeroconf</option></arg>
116
103
    </cmdsynopsis>
117
104
    <cmdsynopsis>
118
105
      <command>&COMMANDNAME;</command>
299
286
        <term><option>--no-restore</option></term>
300
287
        <listitem>
301
288
          <xi:include href="mandos-options.xml" xpointer="restore"/>
302
 
          <para>
303
 
            See also <xref linkend="persistent_state"/>.
304
 
          </para>
305
289
        </listitem>
306
290
      </varlistentry>
307
291
      
312
296
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
313
297
        </listitem>
314
298
      </varlistentry>
315
 
      
316
 
      <varlistentry>
317
 
        <term><option>--socket
318
 
        <replaceable>FD</replaceable></option></term>
319
 
        <listitem>
320
 
          <xi:include href="mandos-options.xml" xpointer="socket"/>
321
 
        </listitem>
322
 
      </varlistentry>
323
 
      
324
 
      <varlistentry>
325
 
        <term><option>--foreground</option></term>
326
 
        <listitem>
327
 
          <xi:include href="mandos-options.xml"
328
 
                      xpointer="foreground"/>
329
 
        </listitem>
330
 
      </varlistentry>
331
 
      
332
 
      <varlistentry>
333
 
        <term><option>--no-zeroconf</option></term>
334
 
        <listitem>
335
 
          <xi:include href="mandos-options.xml" xpointer="zeroconf"/>
336
 
        </listitem>
337
 
      </varlistentry>
338
 
      
339
299
    </variablelist>
340
300
  </refsect1>
341
301
  
418
378
      extended timeout, checker program, and interval between checks
419
379
      can be configured both globally and per client; see
420
380
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
421
 
      <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.
422
384
    </para>
423
385
  </refsect1>
424
386
  
452
414
    </para>
453
415
  </refsect1>
454
416
  
455
 
  <refsect1 id="persistent_state">
456
 
    <title>PERSISTENT STATE</title>
457
 
    <para>
458
 
      Client settings, initially read from
459
 
      <filename>clients.conf</filename>, are persistent across
460
 
      restarts, and run-time changes will override settings in
461
 
      <filename>clients.conf</filename>.  However, if a setting is
462
 
      <emphasis>changed</emphasis> (or a client added, or removed) in
463
 
      <filename>clients.conf</filename>, this will take precedence.
464
 
    </para>
465
 
  </refsect1>
466
 
  
467
417
  <refsect1 id="dbus_interface">
468
418
    <title>D-BUS INTERFACE</title>
469
419
    <para>
531
481
        </listitem>
532
482
      </varlistentry>
533
483
      <varlistentry>
534
 
        <term><filename>/run/mandos.pid</filename></term>
 
484
        <term><filename>/var/run/mandos.pid</filename></term>
535
485
        <listitem>
536
486
          <para>
537
487
            The file containing the process id of the
538
488
            <command>&COMMANDNAME;</command> process started last.
539
 
            <emphasis >Note:</emphasis> If the <filename
540
 
            class="directory">/run</filename> directory does not
541
 
            exist, <filename>/var/run/mandos.pid</filename> will be
542
 
            used instead.
543
489
          </para>
544
490
        </listitem>
545
491
      </varlistentry>
546
492
      <varlistentry>
 
493
        <term><filename class="devicefile">/dev/log</filename></term>
 
494
      </varlistentry>
 
495
      <varlistentry>
547
496
        <term><filename
548
497
        class="directory">/var/lib/mandos</filename></term>
549
498
        <listitem>
555
504
        </listitem>
556
505
      </varlistentry>
557
506
      <varlistentry>
558
 
        <term><filename class="devicefile">/dev/log</filename></term>
 
507
        <term><filename>/dev/log</filename></term>
559
508
        <listitem>
560
509
          <para>
561
510
            The Unix domain socket to where local syslog messages are
587
536
      There is no fine-grained control over logging and debug output.
588
537
    </para>
589
538
    <para>
 
539
      Debug mode is conflated with running in the foreground.
 
540
    </para>
 
541
    <para>
590
542
      This server does not check the expire time of clients’ OpenPGP
591
543
      keys.
592
544
    </para>
593
 
    <xi:include href="bugs.xml"/>
594
545
  </refsect1>
595
546
  
596
547
  <refsect1 id="example">
709
660
      </varlistentry>
710
661
      <varlistentry>
711
662
        <term>
712
 
          <ulink url="https://gnutls.org/">GnuTLS</ulink>
 
663
          <ulink url="http://www.gnu.org/software/gnutls/"
 
664
          >GnuTLS</ulink>
713
665
        </term>
714
666
      <listitem>
715
667
        <para>
753
705
      </varlistentry>
754
706
      <varlistentry>
755
707
        <term>
756
 
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
757
 
          Protocol Version 1.2</citetitle>
 
708
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
709
          Protocol Version 1.1</citetitle>
758
710
        </term>
759
711
      <listitem>
760
712
        <para>
761
 
          TLS 1.2 is the protocol implemented by GnuTLS.
 
713
          TLS 1.1 is the protocol implemented by GnuTLS.
762
714
        </para>
763
715
      </listitem>
764
716
      </varlistentry>
774
726
      </varlistentry>
775
727
      <varlistentry>
776
728
        <term>
777
 
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
778
 
          Security (TLS) Authentication</citetitle>
 
729
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
730
          Security</citetitle>
779
731
        </term>
780
732
      <listitem>
781
733
        <para>