/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

  • Committer: Teddy Hogeborn
  • Date: 2016-03-05 21:46:00 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 335.
  • Revision ID: teddy@recompile.se-20160305214600-2d7peg8qb5xhpi64
Fix incorrect documentation of minor limitation

* mandos-monitor.xml (BUGS): The name which is hard-coded is the D-Bus
                             *bus* name, not the service name.  Fix
                             the documentation.

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 "2016-03-05">
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>
39
43
      <holder>Teddy Hogeborn</holder>
40
44
      <holder>Björn Påhlsson</holder>
41
45
    </copyright>
100
104
      <sbr/>
101
105
      <arg><option>--statedir
102
106
      <replaceable>DIRECTORY</replaceable></option></arg>
 
107
      <sbr/>
 
108
      <arg><option>--socket
 
109
      <replaceable>FD</replaceable></option></arg>
 
110
      <sbr/>
 
111
      <arg><option>--foreground</option></arg>
 
112
      <sbr/>
 
113
      <arg><option>--no-zeroconf</option></arg>
103
114
    </cmdsynopsis>
104
115
    <cmdsynopsis>
105
116
      <command>&COMMANDNAME;</command>
299
310
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
300
311
        </listitem>
301
312
      </varlistentry>
 
313
      
 
314
      <varlistentry>
 
315
        <term><option>--socket
 
316
        <replaceable>FD</replaceable></option></term>
 
317
        <listitem>
 
318
          <xi:include href="mandos-options.xml" xpointer="socket"/>
 
319
        </listitem>
 
320
      </varlistentry>
 
321
      
 
322
      <varlistentry>
 
323
        <term><option>--foreground</option></term>
 
324
        <listitem>
 
325
          <xi:include href="mandos-options.xml"
 
326
                      xpointer="foreground"/>
 
327
        </listitem>
 
328
      </varlistentry>
 
329
      
 
330
      <varlistentry>
 
331
        <term><option>--no-zeroconf</option></term>
 
332
        <listitem>
 
333
          <xi:include href="mandos-options.xml" xpointer="zeroconf"/>
 
334
        </listitem>
 
335
      </varlistentry>
 
336
      
302
337
    </variablelist>
303
338
  </refsect1>
304
339
  
381
416
      extended timeout, checker program, and interval between checks
382
417
      can be configured both globally and per client; see
383
418
      <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.
 
419
      <manvolnum>5</manvolnum></citerefentry>.
387
420
    </para>
388
421
  </refsect1>
389
422
  
496
529
        </listitem>
497
530
      </varlistentry>
498
531
      <varlistentry>
499
 
        <term><filename>/var/run/mandos.pid</filename></term>
 
532
        <term><filename>/run/mandos.pid</filename></term>
500
533
        <listitem>
501
534
          <para>
502
535
            The file containing the process id of the
503
536
            <command>&COMMANDNAME;</command> process started last.
 
537
            <emphasis >Note:</emphasis> If the <filename
 
538
            class="directory">/run</filename> directory does not
 
539
            exist, <filename>/var/run/mandos.pid</filename> will be
 
540
            used instead.
504
541
          </para>
505
542
        </listitem>
506
543
      </varlistentry>
507
544
      <varlistentry>
508
 
        <term><filename class="devicefile">/dev/log</filename></term>
509
 
      </varlistentry>
510
 
      <varlistentry>
511
545
        <term><filename
512
546
        class="directory">/var/lib/mandos</filename></term>
513
547
        <listitem>
519
553
        </listitem>
520
554
      </varlistentry>
521
555
      <varlistentry>
522
 
        <term><filename>/dev/log</filename></term>
 
556
        <term><filename class="devicefile">/dev/log</filename></term>
523
557
        <listitem>
524
558
          <para>
525
559
            The Unix domain socket to where local syslog messages are
551
585
      There is no fine-grained control over logging and debug output.
552
586
    </para>
553
587
    <para>
554
 
      Debug mode is conflated with running in the foreground.
555
 
    </para>
556
 
    <para>
557
588
      This server does not check the expire time of clients’ OpenPGP
558
589
      keys.
559
590
    </para>
 
591
    <xi:include href="bugs.xml"/>
560
592
  </refsect1>
561
593
  
562
594
  <refsect1 id="example">
675
707
      </varlistentry>
676
708
      <varlistentry>
677
709
        <term>
678
 
          <ulink url="http://www.gnu.org/software/gnutls/"
679
 
          >GnuTLS</ulink>
 
710
          <ulink url="http://gnutls.org/">GnuTLS</ulink>
680
711
        </term>
681
712
      <listitem>
682
713
        <para>
720
751
      </varlistentry>
721
752
      <varlistentry>
722
753
        <term>
723
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
724
 
          Protocol Version 1.1</citetitle>
 
754
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
 
755
          Protocol Version 1.2</citetitle>
725
756
        </term>
726
757
      <listitem>
727
758
        <para>
728
 
          TLS 1.1 is the protocol implemented by GnuTLS.
 
759
          TLS 1.2 is the protocol implemented by GnuTLS.
729
760
        </para>
730
761
      </listitem>
731
762
      </varlistentry>
741
772
      </varlistentry>
742
773
      <varlistentry>
743
774
        <term>
744
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
745
 
          Security</citetitle>
 
775
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
 
776
          Security (TLS) Authentication</citetitle>
746
777
        </term>
747
778
      <listitem>
748
779
        <para>