/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: 2011-11-26 22:22:20 UTC
  • mto: (518.1.8 mandos-persistent)
  • mto: This revision was merged to the branch mainline in revision 524.
  • Revision ID: teddy@recompile.se-20111126222220-1ubwjpb5ugqnrhec
Directory with persistent state can now be changed with the "statedir"
option.  The state directory /var/lib/mandos now gets created on
installation.  Added documentation about "restore" and "statedir"
options.

* Makefile (USER, GROUP, STATEDIR): New.
  (maintainer-clean): Also remove "statedir".
  (run-server): Replaced "--no-restore" with "--statedir=statedir".
  (statedir): New.
  (install-server): Make $(STATEDIR) directory.
* debian/mandos.dirs (var/lib/mandos): Added.
* debian/mandos.postinst: Fix ownership of /var/lib/mandos.
* mandos: New --statedir option.
  (stored_state_path): Not global anymore.
  (stored_state_file): New global.
* mandos.conf: Fix whitespace.
  (restore, statedir): Added.
* mandos.conf.xml (OPTIONS, EXAMPLE): Added "restore" and "statedir".
  mandos.xml (SYNOPSIS, OPTIONS): Added "--statedir".
  (FILES): Added "/var/lib/mandos".

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 "2013-10-26">
 
5
<!ENTITY TIMESTAMP "2011-11-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>
40
38
      <holder>Teddy Hogeborn</holder>
41
39
      <holder>Björn Påhlsson</holder>
42
40
    </copyright>
101
99
      <sbr/>
102
100
      <arg><option>--statedir
103
101
      <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
102
    </cmdsynopsis>
110
103
    <cmdsynopsis>
111
104
      <command>&COMMANDNAME;</command>
234
227
        <term><option>--priority <replaceable>
235
228
        PRIORITY</replaceable></option></term>
236
229
        <listitem>
237
 
          <xi:include href="mandos-options.xml"
238
 
                      xpointer="priority_compat"/>
 
230
          <xi:include href="mandos-options.xml" xpointer="priority"/>
239
231
        </listitem>
240
232
      </varlistentry>
241
233
      
293
285
        <term><option>--no-restore</option></term>
294
286
        <listitem>
295
287
          <xi:include href="mandos-options.xml" xpointer="restore"/>
296
 
          <para>
297
 
            See also <xref linkend="persistent_state"/>.
298
 
          </para>
299
288
        </listitem>
300
289
      </varlistentry>
301
290
      
306
295
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
307
296
        </listitem>
308
297
      </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
 
      
326
298
    </variablelist>
327
299
  </refsect1>
328
300
  
405
377
      extended timeout, checker program, and interval between checks
406
378
      can be configured both globally and per client; see
407
379
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
408
 
      <manvolnum>5</manvolnum></citerefentry>.
 
380
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
 
381
      receiving its password will also be treated as a successful
 
382
      checker run.
409
383
    </para>
410
384
  </refsect1>
411
385
  
433
407
    <title>LOGGING</title>
434
408
    <para>
435
409
      The server will send log message with various severity levels to
436
 
      <filename class="devicefile">/dev/log</filename>.  With the
 
410
      <filename>/dev/log</filename>.  With the
437
411
      <option>--debug</option> option, it will log even more messages,
438
412
      and also show them on the console.
439
413
    </para>
440
414
  </refsect1>
441
415
  
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
 
  
454
416
  <refsect1 id="dbus_interface">
455
417
    <title>D-BUS INTERFACE</title>
456
418
    <para>
518
480
        </listitem>
519
481
      </varlistentry>
520
482
      <varlistentry>
521
 
        <term><filename>/run/mandos.pid</filename></term>
 
483
        <term><filename>/var/run/mandos.pid</filename></term>
522
484
        <listitem>
523
485
          <para>
524
486
            The file containing the process id of the
525
487
            <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.
530
488
          </para>
531
489
        </listitem>
532
490
      </varlistentry>
533
491
      <varlistentry>
534
 
        <term><filename class="devicefile">/dev/log</filename></term>
535
 
      </varlistentry>
536
 
      <varlistentry>
537
492
        <term><filename
538
493
        class="directory">/var/lib/mandos</filename></term>
539
494
        <listitem>
577
532
      There is no fine-grained control over logging and debug output.
578
533
    </para>
579
534
    <para>
 
535
      Debug mode is conflated with running in the foreground.
 
536
    </para>
 
537
    <para>
580
538
      This server does not check the expire time of clients’ OpenPGP
581
539
      keys.
582
540
    </para>