/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: 2017-08-20 14:08:59 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 360.
  • Revision ID: teddy@recompile.se-20170820140859-6niaa0ebf6bdovfn
Use || instead of -o in shell scripts.

* mandos-keygen: Use || instead of -o.
* network-hooks.d/bridge: - '' -

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>
286
298
        <term><option>--no-restore</option></term>
287
299
        <listitem>
288
300
          <xi:include href="mandos-options.xml" xpointer="restore"/>
 
301
          <para>
 
302
            See also <xref linkend="persistent_state"/>.
 
303
          </para>
289
304
        </listitem>
290
305
      </varlistentry>
291
306
      
296
311
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
297
312
        </listitem>
298
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
      
299
338
    </variablelist>
300
339
  </refsect1>
301
340
  
378
417
      extended timeout, checker program, and interval between checks
379
418
      can be configured both globally and per client; see
380
419
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
381
 
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
382
 
      receiving its password will also be treated as a successful
383
 
      checker run.
 
420
      <manvolnum>5</manvolnum></citerefentry>.
384
421
    </para>
385
422
  </refsect1>
386
423
  
414
451
    </para>
415
452
  </refsect1>
416
453
  
 
454
  <refsect1 id="persistent_state">
 
455
    <title>PERSISTENT STATE</title>
 
456
    <para>
 
457
      Client settings, initially read from
 
458
      <filename>clients.conf</filename>, are persistent across
 
459
      restarts, and run-time changes will override settings in
 
460
      <filename>clients.conf</filename>.  However, if a setting is
 
461
      <emphasis>changed</emphasis> (or a client added, or removed) in
 
462
      <filename>clients.conf</filename>, this will take precedence.
 
463
    </para>
 
464
  </refsect1>
 
465
  
417
466
  <refsect1 id="dbus_interface">
418
467
    <title>D-BUS INTERFACE</title>
419
468
    <para>
481
530
        </listitem>
482
531
      </varlistentry>
483
532
      <varlistentry>
484
 
        <term><filename>/var/run/mandos.pid</filename></term>
 
533
        <term><filename>/run/mandos.pid</filename></term>
485
534
        <listitem>
486
535
          <para>
487
536
            The file containing the process id of the
488
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.
489
542
          </para>
490
543
        </listitem>
491
544
      </varlistentry>
492
545
      <varlistentry>
493
 
        <term><filename class="devicefile">/dev/log</filename></term>
494
 
      </varlistentry>
495
 
      <varlistentry>
496
546
        <term><filename
497
547
        class="directory">/var/lib/mandos</filename></term>
498
548
        <listitem>
504
554
        </listitem>
505
555
      </varlistentry>
506
556
      <varlistentry>
507
 
        <term><filename>/dev/log</filename></term>
 
557
        <term><filename class="devicefile">/dev/log</filename></term>
508
558
        <listitem>
509
559
          <para>
510
560
            The Unix domain socket to where local syslog messages are
536
586
      There is no fine-grained control over logging and debug output.
537
587
    </para>
538
588
    <para>
539
 
      Debug mode is conflated with running in the foreground.
540
 
    </para>
541
 
    <para>
542
589
      This server does not check the expire time of clients’ OpenPGP
543
590
      keys.
544
591
    </para>
 
592
    <xi:include href="bugs.xml"/>
545
593
  </refsect1>
546
594
  
547
595
  <refsect1 id="example">
660
708
      </varlistentry>
661
709
      <varlistentry>
662
710
        <term>
663
 
          <ulink url="http://www.gnu.org/software/gnutls/"
664
 
          >GnuTLS</ulink>
 
711
          <ulink url="https://gnutls.org/">GnuTLS</ulink>
665
712
        </term>
666
713
      <listitem>
667
714
        <para>
705
752
      </varlistentry>
706
753
      <varlistentry>
707
754
        <term>
708
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
709
 
          Protocol Version 1.1</citetitle>
 
755
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
 
756
          Protocol Version 1.2</citetitle>
710
757
        </term>
711
758
      <listitem>
712
759
        <para>
713
 
          TLS 1.1 is the protocol implemented by GnuTLS.
 
760
          TLS 1.2 is the protocol implemented by GnuTLS.
714
761
        </para>
715
762
      </listitem>
716
763
      </varlistentry>
726
773
      </varlistentry>
727
774
      <varlistentry>
728
775
        <term>
729
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
730
 
          Security</citetitle>
 
776
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
 
777
          Security (TLS) Authentication</citetitle>
731
778
        </term>
732
779
      <listitem>
733
780
        <para>