/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-02-18 01:29:21 UTC
  • Revision ID: teddy@recompile.se-20180218012921-itiazxid50ycv77o
Correct comments

* plugin-helpers/mandos-client-iprouteadddel.c: Comment change only.

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