/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: 2014-01-06 15:56:54 UTC
  • mto: (237.7.272 trunk)
  • mto: This revision was merged to the branch mainline in revision 307.
  • Revision ID: teddy@recompile.se-20140106155654-urx23ytuvy0nxzwp
Update init script to modern standards.

* init.d-mandos (status): Moved to standard location.  Re-added use of
                          -p switch compared to skeleton file.
  (*): Update message to include "status".

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 "2013-10-26">
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>
38
40
      <holder>Teddy Hogeborn</holder>
39
41
      <holder>Björn Påhlsson</holder>
40
42
    </copyright>
99
101
      <sbr/>
100
102
      <arg><option>--statedir
101
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>
102
109
    </cmdsynopsis>
103
110
    <cmdsynopsis>
104
111
      <command>&COMMANDNAME;</command>
227
234
        <term><option>--priority <replaceable>
228
235
        PRIORITY</replaceable></option></term>
229
236
        <listitem>
230
 
          <xi:include href="mandos-options.xml" xpointer="priority"/>
 
237
          <xi:include href="mandos-options.xml"
 
238
                      xpointer="priority_compat"/>
231
239
        </listitem>
232
240
      </varlistentry>
233
241
      
285
293
        <term><option>--no-restore</option></term>
286
294
        <listitem>
287
295
          <xi:include href="mandos-options.xml" xpointer="restore"/>
 
296
          <para>
 
297
            See also <xref linkend="persistent_state"/>.
 
298
          </para>
288
299
        </listitem>
289
300
      </varlistentry>
290
301
      
295
306
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
296
307
        </listitem>
297
308
      </varlistentry>
 
309
      
 
310
      <varlistentry>
 
311
        <term><option>--socket
 
312
        <replaceable>FD</replaceable></option></term>
 
313
        <listitem>
 
314
          <xi:include href="mandos-options.xml" xpointer="socket"/>
 
315
        </listitem>
 
316
      </varlistentry>
 
317
      
 
318
      <varlistentry>
 
319
        <term><option>--foreground</option></term>
 
320
        <listitem>
 
321
          <xi:include href="mandos-options.xml"
 
322
                      xpointer="foreground"/>
 
323
        </listitem>
 
324
      </varlistentry>
 
325
      
298
326
    </variablelist>
299
327
  </refsect1>
300
328
  
377
405
      extended timeout, checker program, and interval between checks
378
406
      can be configured both globally and per client; see
379
407
      <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.
 
408
      <manvolnum>5</manvolnum></citerefentry>.
383
409
    </para>
384
410
  </refsect1>
385
411
  
407
433
    <title>LOGGING</title>
408
434
    <para>
409
435
      The server will send log message with various severity levels to
410
 
      <filename>/dev/log</filename>.  With the
 
436
      <filename class="devicefile">/dev/log</filename>.  With the
411
437
      <option>--debug</option> option, it will log even more messages,
412
438
      and also show them on the console.
413
439
    </para>
414
440
  </refsect1>
415
441
  
 
442
  <refsect1 id="persistent_state">
 
443
    <title>PERSISTENT STATE</title>
 
444
    <para>
 
445
      Client settings, initially read from
 
446
      <filename>clients.conf</filename>, are persistent across
 
447
      restarts, and run-time changes will override settings in
 
448
      <filename>clients.conf</filename>.  However, if a setting is
 
449
      <emphasis>changed</emphasis> (or a client added, or removed) in
 
450
      <filename>clients.conf</filename>, this will take precedence.
 
451
    </para>
 
452
  </refsect1>
 
453
  
416
454
  <refsect1 id="dbus_interface">
417
455
    <title>D-BUS INTERFACE</title>
418
456
    <para>
480
518
        </listitem>
481
519
      </varlistentry>
482
520
      <varlistentry>
483
 
        <term><filename>/var/run/mandos.pid</filename></term>
 
521
        <term><filename>/run/mandos.pid</filename></term>
484
522
        <listitem>
485
523
          <para>
486
524
            The file containing the process id of the
487
525
            <command>&COMMANDNAME;</command> process started last.
 
526
            <emphasis >Note:</emphasis> If the <filename
 
527
            class="directory">/run</filename> directory does not
 
528
            exist, <filename>/var/run/mandos.pid</filename> will be
 
529
            used instead.
488
530
          </para>
489
531
        </listitem>
490
532
      </varlistentry>
491
533
      <varlistentry>
 
534
        <term><filename class="devicefile">/dev/log</filename></term>
 
535
      </varlistentry>
 
536
      <varlistentry>
492
537
        <term><filename
493
538
        class="directory">/var/lib/mandos</filename></term>
494
539
        <listitem>
532
577
      There is no fine-grained control over logging and debug output.
533
578
    </para>
534
579
    <para>
535
 
      Debug mode is conflated with running in the foreground.
536
 
    </para>
537
 
    <para>
538
580
      This server does not check the expire time of clients’ OpenPGP
539
581
      keys.
540
582
    </para>