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