/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-01-01 04:02:00 UTC
  • Revision ID: teddy@recompile.se-20120101040200-8wgma707v4gi7hxn
* debian/rules (binary-common): Exclude network-hooks.d from
                                dh_fixperms.
* mandos (DBusObjectWithProperties.Set): Bug fix: handle byte arrays.
* mandos-clients.conf.xml (DESCRIPTION): Add reference to persistent
                                         state.
* mandos-options.xml (restore): Adjust wording slightly.
* mandos.xml (OPTIONS/--no-restore): Refer to "PERSISTENT STATE"
                                     section.
  (PERSISTENT STATE): New section.

Show diffs side-by-side

added added

removed removed

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