/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:
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 "2015-07-20">
 
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
39
      <holder>Teddy Hogeborn</holder>
41
40
      <holder>Björn Påhlsson</holder>
42
41
    </copyright>
101
100
      <sbr/>
102
101
      <arg><option>--statedir
103
102
      <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>
109
 
      <sbr/>
110
 
      <arg><option>--no-zeroconf</option></arg>
111
103
    </cmdsynopsis>
112
104
    <cmdsynopsis>
113
105
      <command>&COMMANDNAME;</command>
294
286
        <term><option>--no-restore</option></term>
295
287
        <listitem>
296
288
          <xi:include href="mandos-options.xml" xpointer="restore"/>
297
 
          <para>
298
 
            See also <xref linkend="persistent_state"/>.
299
 
          </para>
300
289
        </listitem>
301
290
      </varlistentry>
302
291
      
307
296
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
308
297
        </listitem>
309
298
      </varlistentry>
310
 
      
311
 
      <varlistentry>
312
 
        <term><option>--socket
313
 
        <replaceable>FD</replaceable></option></term>
314
 
        <listitem>
315
 
          <xi:include href="mandos-options.xml" xpointer="socket"/>
316
 
        </listitem>
317
 
      </varlistentry>
318
 
      
319
 
      <varlistentry>
320
 
        <term><option>--foreground</option></term>
321
 
        <listitem>
322
 
          <xi:include href="mandos-options.xml"
323
 
                      xpointer="foreground"/>
324
 
        </listitem>
325
 
      </varlistentry>
326
 
      
327
 
      <varlistentry>
328
 
        <term><option>--no-zeroconf</option></term>
329
 
        <listitem>
330
 
          <xi:include href="mandos-options.xml" xpointer="zeroconf"/>
331
 
        </listitem>
332
 
      </varlistentry>
333
 
      
334
299
    </variablelist>
335
300
  </refsect1>
336
301
  
413
378
      extended timeout, checker program, and interval between checks
414
379
      can be configured both globally and per client; see
415
380
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
416
 
      <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.
417
384
    </para>
418
385
  </refsect1>
419
386
  
447
414
    </para>
448
415
  </refsect1>
449
416
  
450
 
  <refsect1 id="persistent_state">
451
 
    <title>PERSISTENT STATE</title>
452
 
    <para>
453
 
      Client settings, initially read from
454
 
      <filename>clients.conf</filename>, are persistent across
455
 
      restarts, and run-time changes will override settings in
456
 
      <filename>clients.conf</filename>.  However, if a setting is
457
 
      <emphasis>changed</emphasis> (or a client added, or removed) in
458
 
      <filename>clients.conf</filename>, this will take precedence.
459
 
    </para>
460
 
  </refsect1>
461
 
  
462
417
  <refsect1 id="dbus_interface">
463
418
    <title>D-BUS INTERFACE</title>
464
419
    <para>
526
481
        </listitem>
527
482
      </varlistentry>
528
483
      <varlistentry>
529
 
        <term><filename>/run/mandos.pid</filename></term>
 
484
        <term><filename>/var/run/mandos.pid</filename></term>
530
485
        <listitem>
531
486
          <para>
532
487
            The file containing the process id of the
533
488
            <command>&COMMANDNAME;</command> process started last.
534
 
            <emphasis >Note:</emphasis> If the <filename
535
 
            class="directory">/run</filename> directory does not
536
 
            exist, <filename>/var/run/mandos.pid</filename> will be
537
 
            used instead.
538
489
          </para>
539
490
        </listitem>
540
491
      </varlistentry>
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>
706
660
      </varlistentry>
707
661
      <varlistentry>
708
662
        <term>
709
 
          <ulink url="http://gnutls.org/">GnuTLS</ulink>
 
663
          <ulink url="http://www.gnu.org/software/gnutls/"
 
664
          >GnuTLS</ulink>
710
665
        </term>
711
666
      <listitem>
712
667
        <para>
750
705
      </varlistentry>
751
706
      <varlistentry>
752
707
        <term>
753
 
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
754
 
          Protocol Version 1.2</citetitle>
 
708
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
709
          Protocol Version 1.1</citetitle>
755
710
        </term>
756
711
      <listitem>
757
712
        <para>
758
 
          TLS 1.2 is the protocol implemented by GnuTLS.
 
713
          TLS 1.1 is the protocol implemented by GnuTLS.
759
714
        </para>
760
715
      </listitem>
761
716
      </varlistentry>
771
726
      </varlistentry>
772
727
      <varlistentry>
773
728
        <term>
774
 
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
775
 
          Security (TLS) Authentication</citetitle>
 
729
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
730
          Security</citetitle>
776
731
        </term>
777
732
      <listitem>
778
733
        <para>