/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: 2012-05-26 22:56:38 UTC
  • mfrom: (589.1.1 socket-option)
  • Revision ID: teddy@recompile.se-20120526225638-4hvqyrvmj0036lfn
Merge "--socket" option for server.

This is suggested by the GNU Coding Standards' Table of Long Options,
and will probably also allow socket activation (e.g. by systemd(8)).

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 "2017-02-23">
 
5
<!ENTITY TIMESTAMP "2012-05-26">
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
39
      <holder>Teddy Hogeborn</holder>
45
40
      <holder>Björn Påhlsson</holder>
46
41
    </copyright>
108
103
      <sbr/>
109
104
      <arg><option>--socket
110
105
      <replaceable>FD</replaceable></option></arg>
111
 
      <sbr/>
112
 
      <arg><option>--foreground</option></arg>
113
 
      <sbr/>
114
 
      <arg><option>--no-zeroconf</option></arg>
115
106
    </cmdsynopsis>
116
107
    <cmdsynopsis>
117
108
      <command>&COMMANDNAME;</command>
320
311
        </listitem>
321
312
      </varlistentry>
322
313
      
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
 
      
338
314
    </variablelist>
339
315
  </refsect1>
340
316
  
530
506
        </listitem>
531
507
      </varlistentry>
532
508
      <varlistentry>
533
 
        <term><filename>/run/mandos.pid</filename></term>
 
509
        <term><filename>/var/run/mandos.pid</filename></term>
534
510
        <listitem>
535
511
          <para>
536
512
            The file containing the process id of the
537
513
            <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.
542
514
          </para>
543
515
        </listitem>
544
516
      </varlistentry>
545
517
      <varlistentry>
 
518
        <term><filename class="devicefile">/dev/log</filename></term>
 
519
      </varlistentry>
 
520
      <varlistentry>
546
521
        <term><filename
547
522
        class="directory">/var/lib/mandos</filename></term>
548
523
        <listitem>
554
529
        </listitem>
555
530
      </varlistentry>
556
531
      <varlistentry>
557
 
        <term><filename class="devicefile">/dev/log</filename></term>
 
532
        <term><filename>/dev/log</filename></term>
558
533
        <listitem>
559
534
          <para>
560
535
            The Unix domain socket to where local syslog messages are
586
561
      There is no fine-grained control over logging and debug output.
587
562
    </para>
588
563
    <para>
 
564
      Debug mode is conflated with running in the foreground.
 
565
    </para>
 
566
    <para>
589
567
      This server does not check the expire time of clients’ OpenPGP
590
568
      keys.
591
569
    </para>
592
 
    <xi:include href="bugs.xml"/>
593
570
  </refsect1>
594
571
  
595
572
  <refsect1 id="example">
708
685
      </varlistentry>
709
686
      <varlistentry>
710
687
        <term>
711
 
          <ulink url="https://gnutls.org/">GnuTLS</ulink>
 
688
          <ulink url="http://www.gnu.org/software/gnutls/"
 
689
          >GnuTLS</ulink>
712
690
        </term>
713
691
      <listitem>
714
692
        <para>
752
730
      </varlistentry>
753
731
      <varlistentry>
754
732
        <term>
755
 
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
756
 
          Protocol Version 1.2</citetitle>
 
733
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
 
734
          Protocol Version 1.1</citetitle>
757
735
        </term>
758
736
      <listitem>
759
737
        <para>
760
 
          TLS 1.2 is the protocol implemented by GnuTLS.
 
738
          TLS 1.1 is the protocol implemented by GnuTLS.
761
739
        </para>
762
740
      </listitem>
763
741
      </varlistentry>
773
751
      </varlistentry>
774
752
      <varlistentry>
775
753
        <term>
776
 
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
777
 
          Security (TLS) Authentication</citetitle>
 
754
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
 
755
          Security</citetitle>
778
756
        </term>
779
757
      <listitem>
780
758
        <para>