/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: 2018-01-29 19:43:17 UTC
  • Revision ID: teddy@recompile.se-20180129194317-07fz89jdxefuphq1
Use "simply expanded" variables in Makefile

* (Makefile): Use "simply expanded" variables where possible.

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 "2012-01-01">
 
5
<!ENTITY TIMESTAMP "2017-02-23">
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>
39
44
      <holder>Teddy Hogeborn</holder>
40
45
      <holder>Björn Påhlsson</holder>
41
46
    </copyright>
100
105
      <sbr/>
101
106
      <arg><option>--statedir
102
107
      <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>
103
115
    </cmdsynopsis>
104
116
    <cmdsynopsis>
105
117
      <command>&COMMANDNAME;</command>
299
311
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
300
312
        </listitem>
301
313
      </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
      
302
338
    </variablelist>
303
339
  </refsect1>
304
340
  
381
417
      extended timeout, checker program, and interval between checks
382
418
      can be configured both globally and per client; see
383
419
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
384
 
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
385
 
      receiving its password will also be treated as a successful
386
 
      checker run.
 
420
      <manvolnum>5</manvolnum></citerefentry>.
387
421
    </para>
388
422
  </refsect1>
389
423
  
496
530
        </listitem>
497
531
      </varlistentry>
498
532
      <varlistentry>
499
 
        <term><filename>/var/run/mandos.pid</filename></term>
 
533
        <term><filename>/run/mandos.pid</filename></term>
500
534
        <listitem>
501
535
          <para>
502
536
            The file containing the process id of the
503
537
            <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.
504
542
          </para>
505
543
        </listitem>
506
544
      </varlistentry>
507
545
      <varlistentry>
508
 
        <term><filename class="devicefile">/dev/log</filename></term>
509
 
      </varlistentry>
510
 
      <varlistentry>
511
546
        <term><filename
512
547
        class="directory">/var/lib/mandos</filename></term>
513
548
        <listitem>
519
554
        </listitem>
520
555
      </varlistentry>
521
556
      <varlistentry>
522
 
        <term><filename>/dev/log</filename></term>
 
557
        <term><filename class="devicefile">/dev/log</filename></term>
523
558
        <listitem>
524
559
          <para>
525
560
            The Unix domain socket to where local syslog messages are
551
586
      There is no fine-grained control over logging and debug output.
552
587
    </para>
553
588
    <para>
554
 
      Debug mode is conflated with running in the foreground.
555
 
    </para>
556
 
    <para>
557
589
      This server does not check the expire time of clients’ OpenPGP
558
590
      keys.
559
591
    </para>
 
592
    <xi:include href="bugs.xml"/>
560
593
  </refsect1>
561
594
  
562
595
  <refsect1 id="example">
675
708
      </varlistentry>
676
709
      <varlistentry>
677
710
        <term>
678
 
          <ulink url="http://www.gnu.org/software/gnutls/"
679
 
          >GnuTLS</ulink>
 
711
          <ulink url="https://gnutls.org/">GnuTLS</ulink>
680
712
        </term>
681
713
      <listitem>
682
714
        <para>
720
752
      </varlistentry>
721
753
      <varlistentry>
722
754
        <term>
723
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
724
 
          Protocol Version 1.1</citetitle>
 
755
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
 
756
          Protocol Version 1.2</citetitle>
725
757
        </term>
726
758
      <listitem>
727
759
        <para>
728
 
          TLS 1.1 is the protocol implemented by GnuTLS.
 
760
          TLS 1.2 is the protocol implemented by GnuTLS.
729
761
        </para>
730
762
      </listitem>
731
763
      </varlistentry>
741
773
      </varlistentry>
742
774
      <varlistentry>
743
775
        <term>
744
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
745
 
          Security</citetitle>
 
776
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
 
777
          Security (TLS) Authentication</citetitle>
746
778
        </term>
747
779
      <listitem>
748
780
        <para>