/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-10-29 14:22:26 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 356.
  • Revision ID: teddy@recompile.se-20161029142226-n4s9d70tuk615pg1
Makefile: Clarify message when running client.

* Makefile (run-client): Clarify message.

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 "2011-11-26">
 
5
<!ENTITY TIMESTAMP "2016-07-03">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
35
35
      <year>2009</year>
36
36
      <year>2010</year>
37
37
      <year>2011</year>
 
38
      <year>2012</year>
 
39
      <year>2013</year>
 
40
      <year>2014</year>
 
41
      <year>2015</year>
 
42
      <year>2016</year>
38
43
      <holder>Teddy Hogeborn</holder>
39
44
      <holder>Björn Påhlsson</holder>
40
45
    </copyright>
99
104
      <sbr/>
100
105
      <arg><option>--statedir
101
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>
102
114
    </cmdsynopsis>
103
115
    <cmdsynopsis>
104
116
      <command>&COMMANDNAME;</command>
285
297
        <term><option>--no-restore</option></term>
286
298
        <listitem>
287
299
          <xi:include href="mandos-options.xml" xpointer="restore"/>
 
300
          <para>
 
301
            See also <xref linkend="persistent_state"/>.
 
302
          </para>
288
303
        </listitem>
289
304
      </varlistentry>
290
305
      
295
310
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
296
311
        </listitem>
297
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
      
298
337
    </variablelist>
299
338
  </refsect1>
300
339
  
377
416
      extended timeout, checker program, and interval between checks
378
417
      can be configured both globally and per client; see
379
418
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
380
 
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
381
 
      receiving its password will also be treated as a successful
382
 
      checker run.
 
419
      <manvolnum>5</manvolnum></citerefentry>.
383
420
    </para>
384
421
  </refsect1>
385
422
  
407
444
    <title>LOGGING</title>
408
445
    <para>
409
446
      The server will send log message with various severity levels to
410
 
      <filename>/dev/log</filename>.  With the
 
447
      <filename class="devicefile">/dev/log</filename>.  With the
411
448
      <option>--debug</option> option, it will log even more messages,
412
449
      and also show them on the console.
413
450
    </para>
414
451
  </refsect1>
415
452
  
 
453
  <refsect1 id="persistent_state">
 
454
    <title>PERSISTENT STATE</title>
 
455
    <para>
 
456
      Client settings, initially read from
 
457
      <filename>clients.conf</filename>, are persistent across
 
458
      restarts, and run-time changes will override settings in
 
459
      <filename>clients.conf</filename>.  However, if a setting is
 
460
      <emphasis>changed</emphasis> (or a client added, or removed) in
 
461
      <filename>clients.conf</filename>, this will take precedence.
 
462
    </para>
 
463
  </refsect1>
 
464
  
416
465
  <refsect1 id="dbus_interface">
417
466
    <title>D-BUS INTERFACE</title>
418
467
    <para>
480
529
        </listitem>
481
530
      </varlistentry>
482
531
      <varlistentry>
483
 
        <term><filename>/var/run/mandos.pid</filename></term>
 
532
        <term><filename>/run/mandos.pid</filename></term>
484
533
        <listitem>
485
534
          <para>
486
535
            The file containing the process id of the
487
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.
488
541
          </para>
489
542
        </listitem>
490
543
      </varlistentry>
500
553
        </listitem>
501
554
      </varlistentry>
502
555
      <varlistentry>
503
 
        <term><filename>/dev/log</filename></term>
 
556
        <term><filename class="devicefile">/dev/log</filename></term>
504
557
        <listitem>
505
558
          <para>
506
559
            The Unix domain socket to where local syslog messages are
532
585
      There is no fine-grained control over logging and debug output.
533
586
    </para>
534
587
    <para>
535
 
      Debug mode is conflated with running in the foreground.
536
 
    </para>
537
 
    <para>
538
588
      This server does not check the expire time of clients’ OpenPGP
539
589
      keys.
540
590
    </para>
 
591
    <xi:include href="bugs.xml"/>
541
592
  </refsect1>
542
593
  
543
594
  <refsect1 id="example">
656
707
      </varlistentry>
657
708
      <varlistentry>
658
709
        <term>
659
 
          <ulink url="http://www.gnu.org/software/gnutls/"
660
 
          >GnuTLS</ulink>
 
710
          <ulink url="https://gnutls.org/">GnuTLS</ulink>
661
711
        </term>
662
712
      <listitem>
663
713
        <para>
701
751
      </varlistentry>
702
752
      <varlistentry>
703
753
        <term>
704
 
          RFC 4346: <citetitle>The Transport Layer Security (TLS)
705
 
          Protocol Version 1.1</citetitle>
 
754
          RFC 5246: <citetitle>The Transport Layer Security (TLS)
 
755
          Protocol Version 1.2</citetitle>
706
756
        </term>
707
757
      <listitem>
708
758
        <para>
709
 
          TLS 1.1 is the protocol implemented by GnuTLS.
 
759
          TLS 1.2 is the protocol implemented by GnuTLS.
710
760
        </para>
711
761
      </listitem>
712
762
      </varlistentry>
722
772
      </varlistentry>
723
773
      <varlistentry>
724
774
        <term>
725
 
          RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
726
 
          Security</citetitle>
 
775
          RFC 6091: <citetitle>Using OpenPGP Keys for Transport Layer
 
776
          Security (TLS) Authentication</citetitle>
727
777
        </term>
728
778
      <listitem>
729
779
        <para>