/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: 2014-10-05 20:08:58 UTC
  • mto: This revision was merged to the branch mainline in revision 736.
  • Revision ID: teddy@recompile.se-20141005200858-uw6lfgqq8lod1edf
Tags: version-1.6.9-1
http://bugs.debian.org/762349
* Makefile (version): Changed to "1.6.9".
* NEWS (Version 1.6.9): New entry.
* debian/changelog (1.6.9-1): - '' -

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 "2014-06-15">
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>
39
40
      <holder>Teddy Hogeborn</holder>
40
41
      <holder>Björn Påhlsson</holder>
41
42
    </copyright>
100
101
      <sbr/>
101
102
      <arg><option>--statedir
102
103
      <replaceable>DIRECTORY</replaceable></option></arg>
 
104
      <sbr/>
 
105
      <arg><option>--socket
 
106
      <replaceable>FD</replaceable></option></arg>
 
107
      <sbr/>
 
108
      <arg><option>--foreground</option></arg>
 
109
      <sbr/>
 
110
      <arg><option>--no-zeroconf</option></arg>
103
111
    </cmdsynopsis>
104
112
    <cmdsynopsis>
105
113
      <command>&COMMANDNAME;</command>
228
236
        <term><option>--priority <replaceable>
229
237
        PRIORITY</replaceable></option></term>
230
238
        <listitem>
231
 
          <xi:include href="mandos-options.xml" xpointer="priority"/>
 
239
          <xi:include href="mandos-options.xml"
 
240
                      xpointer="priority_compat"/>
232
241
        </listitem>
233
242
      </varlistentry>
234
243
      
286
295
        <term><option>--no-restore</option></term>
287
296
        <listitem>
288
297
          <xi:include href="mandos-options.xml" xpointer="restore"/>
 
298
          <para>
 
299
            See also <xref linkend="persistent_state"/>.
 
300
          </para>
289
301
        </listitem>
290
302
      </varlistentry>
291
303
      
296
308
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
297
309
        </listitem>
298
310
      </varlistentry>
 
311
      
 
312
      <varlistentry>
 
313
        <term><option>--socket
 
314
        <replaceable>FD</replaceable></option></term>
 
315
        <listitem>
 
316
          <xi:include href="mandos-options.xml" xpointer="socket"/>
 
317
        </listitem>
 
318
      </varlistentry>
 
319
      
 
320
      <varlistentry>
 
321
        <term><option>--foreground</option></term>
 
322
        <listitem>
 
323
          <xi:include href="mandos-options.xml"
 
324
                      xpointer="foreground"/>
 
325
        </listitem>
 
326
      </varlistentry>
 
327
      
 
328
      <varlistentry>
 
329
        <term><option>--no-zeroconf</option></term>
 
330
        <listitem>
 
331
          <xi:include href="mandos-options.xml" xpointer="zeroconf"/>
 
332
        </listitem>
 
333
      </varlistentry>
 
334
      
299
335
    </variablelist>
300
336
  </refsect1>
301
337
  
378
414
      extended timeout, checker program, and interval between checks
379
415
      can be configured both globally and per client; see
380
416
      <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.
 
417
      <manvolnum>5</manvolnum></citerefentry>.
384
418
    </para>
385
419
  </refsect1>
386
420
  
414
448
    </para>
415
449
  </refsect1>
416
450
  
 
451
  <refsect1 id="persistent_state">
 
452
    <title>PERSISTENT STATE</title>
 
453
    <para>
 
454
      Client settings, initially read from
 
455
      <filename>clients.conf</filename>, are persistent across
 
456
      restarts, and run-time changes will override settings in
 
457
      <filename>clients.conf</filename>.  However, if a setting is
 
458
      <emphasis>changed</emphasis> (or a client added, or removed) in
 
459
      <filename>clients.conf</filename>, this will take precedence.
 
460
    </para>
 
461
  </refsect1>
 
462
  
417
463
  <refsect1 id="dbus_interface">
418
464
    <title>D-BUS INTERFACE</title>
419
465
    <para>
481
527
        </listitem>
482
528
      </varlistentry>
483
529
      <varlistentry>
484
 
        <term><filename>/var/run/mandos.pid</filename></term>
 
530
        <term><filename>/run/mandos.pid</filename></term>
485
531
        <listitem>
486
532
          <para>
487
533
            The file containing the process id of the
488
534
            <command>&COMMANDNAME;</command> process started last.
 
535
            <emphasis >Note:</emphasis> If the <filename
 
536
            class="directory">/run</filename> directory does not
 
537
            exist, <filename>/var/run/mandos.pid</filename> will be
 
538
            used instead.
489
539
          </para>
490
540
        </listitem>
491
541
      </varlistentry>
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>