/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

* mandos-ctl (main): Bug fix: Make --secret actually work.

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 "2014-06-15">
 
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
39
      <holder>Teddy Hogeborn</holder>
41
40
      <holder>Björn Påhlsson</holder>
42
41
    </copyright>
101
100
      <sbr/>
102
101
      <arg><option>--statedir
103
102
      <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>
111
103
    </cmdsynopsis>
112
104
    <cmdsynopsis>
113
105
      <command>&COMMANDNAME;</command>
236
228
        <term><option>--priority <replaceable>
237
229
        PRIORITY</replaceable></option></term>
238
230
        <listitem>
239
 
          <xi:include href="mandos-options.xml"
240
 
                      xpointer="priority_compat"/>
 
231
          <xi:include href="mandos-options.xml" xpointer="priority"/>
241
232
        </listitem>
242
233
      </varlistentry>
243
234
      
295
286
        <term><option>--no-restore</option></term>
296
287
        <listitem>
297
288
          <xi:include href="mandos-options.xml" xpointer="restore"/>
298
 
          <para>
299
 
            See also <xref linkend="persistent_state"/>.
300
 
          </para>
301
289
        </listitem>
302
290
      </varlistentry>
303
291
      
308
296
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
309
297
        </listitem>
310
298
      </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
 
      
335
299
    </variablelist>
336
300
  </refsect1>
337
301
  
414
378
      extended timeout, checker program, and interval between checks
415
379
      can be configured both globally and per client; see
416
380
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
417
 
      <manvolnum>5</manvolnum></citerefentry>.
 
381
      <manvolnum>5</manvolnum></citerefentry>.  A client successfully
 
382
      receiving its password will also be treated as a successful
 
383
      checker run.
418
384
    </para>
419
385
  </refsect1>
420
386
  
448
414
    </para>
449
415
  </refsect1>
450
416
  
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
 
  
463
417
  <refsect1 id="dbus_interface">
464
418
    <title>D-BUS INTERFACE</title>
465
419
    <para>
527
481
        </listitem>
528
482
      </varlistentry>
529
483
      <varlistentry>
530
 
        <term><filename>/run/mandos.pid</filename></term>
 
484
        <term><filename>/var/run/mandos.pid</filename></term>
531
485
        <listitem>
532
486
          <para>
533
487
            The file containing the process id of the
534
488
            <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.
539
489
          </para>
540
490
        </listitem>
541
491
      </varlistentry>
586
536
      There is no fine-grained control over logging and debug output.
587
537
    </para>
588
538
    <para>
 
539
      Debug mode is conflated with running in the foreground.
 
540
    </para>
 
541
    <para>
589
542
      This server does not check the expire time of clients’ OpenPGP
590
543
      keys.
591
544
    </para>