/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

* README: Hint that the intro(8mandos) manual page is in the server
          package.

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 "2015-01-25">
 
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>
236
228
        <term><option>--priority <replaceable>
237
229
        PRIORITY</replaceable></option></term>
238
230
        <listitem>
239
 
          <xi:include href="mandos-options.xml"
240
 
                      xpointer="priority_compat"/>
 
231
          <xi:include href="mandos-options.xml" xpointer="priority"/>
241
232
        </listitem>
242
233
      </varlistentry>
243
234
      
308
299
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
309
300
        </listitem>
310
301
      </varlistentry>
311
 
      
312
 
      <varlistentry>
313
 
        <term><option>--socket
314
 
        <replaceable>FD</replaceable></option></term>
315
 
        <listitem>
316
 
          <xi:include href="mandos-options.xml" xpointer="socket"/>
317
 
        </listitem>
318
 
      </varlistentry>
319
 
      
320
 
      <varlistentry>
321
 
        <term><option>--foreground</option></term>
322
 
        <listitem>
323
 
          <xi:include href="mandos-options.xml"
324
 
                      xpointer="foreground"/>
325
 
        </listitem>
326
 
      </varlistentry>
327
 
      
328
 
      <varlistentry>
329
 
        <term><option>--no-zeroconf</option></term>
330
 
        <listitem>
331
 
          <xi:include href="mandos-options.xml" xpointer="zeroconf"/>
332
 
        </listitem>
333
 
      </varlistentry>
334
 
      
335
302
    </variablelist>
336
303
  </refsect1>
337
304
  
414
381
      extended timeout, checker program, and interval between checks
415
382
      can be configured both globally and per client; see
416
383
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
417
 
      <manvolnum>5</manvolnum></citerefentry>.
 
384
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
 
385
      receiving its password will also be treated as a successful
 
386
      checker run.
418
387
    </para>
419
388
  </refsect1>
420
389
  
527
496
        </listitem>
528
497
      </varlistentry>
529
498
      <varlistentry>
530
 
        <term><filename>/run/mandos.pid</filename></term>
 
499
        <term><filename>/var/run/mandos.pid</filename></term>
531
500
        <listitem>
532
501
          <para>
533
502
            The file containing the process id of the
534
503
            <command>&COMMANDNAME;</command> process started last.
535
 
            <emphasis >Note:</emphasis> If the <filename
536
 
            class="directory">/run</filename> directory does not
537
 
            exist, <filename>/var/run/mandos.pid</filename> will be
538
 
            used instead.
539
504
          </para>
540
505
        </listitem>
541
506
      </varlistentry>
586
551
      There is no fine-grained control over logging and debug output.
587
552
    </para>
588
553
    <para>
 
554
      Debug mode is conflated with running in the foreground.
 
555
    </para>
 
556
    <para>
589
557
      This server does not check the expire time of clients’ OpenPGP
590
558
      keys.
591
559
    </para>
707
675
      </varlistentry>
708
676
      <varlistentry>
709
677
        <term>
710
 
          <ulink url="http://gnutls.org/">GnuTLS</ulink>
 
678
          <ulink url="http://www.gnu.org/software/gnutls/"
 
679
          >GnuTLS</ulink>
711
680
        </term>
712
681
      <listitem>
713
682
        <para>
751
720
      </varlistentry>
752
721
      <varlistentry>
753
722
        <term>
754
 
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
755
 
          Protocol Version 1.2</citetitle>
 
723
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
724
          Protocol Version 1.1</citetitle>
756
725
        </term>
757
726
      <listitem>
758
727
        <para>
759
 
          TLS 1.2 is the protocol implemented by GnuTLS.
 
728
          TLS 1.1 is the protocol implemented by GnuTLS.
760
729
        </para>
761
730
      </listitem>
762
731
      </varlistentry>
772
741
      </varlistentry>
773
742
      <varlistentry>
774
743
        <term>
775
 
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
776
 
          Security (TLS) Authentication</citetitle>
 
744
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
745
          Security</citetitle>
777
746
        </term>
778
747
      <listitem>
779
748
        <para>