/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 (MandosServer.Quit): New.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos.xml
1
1
<?xml version="1.0" encoding="UTF-8"?>
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
 
<!ENTITY VERSION "1.0">
5
4
<!ENTITY COMMANDNAME "mandos">
6
 
<!ENTITY TIMESTAMP "2008-09-21">
 
5
<!ENTITY TIMESTAMP "2009-01-04">
 
6
<!ENTITY % common SYSTEM "common.ent">
 
7
%common;
7
8
]>
8
9
 
9
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
10
 
  <refentryinfo>
 
11
   <refentryinfo>
11
12
    <title>Mandos Manual</title>
12
13
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
13
14
    <productname>Mandos</productname>
14
 
    <productnumber>&VERSION;</productnumber>
 
15
    <productnumber>&version;</productnumber>
15
16
    <date>&TIMESTAMP;</date>
16
17
    <authorgroup>
17
18
      <author>
83
84
      <replaceable>DIRECTORY</replaceable></option></arg>
84
85
      <sbr/>
85
86
      <arg><option>--debug</option></arg>
 
87
      <sbr/>
 
88
      <arg><option>--no-dbus</option></arg>
86
89
    </cmdsynopsis>
87
90
    <cmdsynopsis>
88
91
      <command>&COMMANDNAME;</command>
227
230
          </para>
228
231
        </listitem>
229
232
      </varlistentry>
 
233
      
 
234
      <varlistentry>
 
235
        <term><option>--no-dbus</option></term>
 
236
        <listitem>
 
237
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
 
238
          <para>
 
239
            See also <xref linkend="dbus_interface"/>.
 
240
          </para>
 
241
        </listitem>
 
242
      </varlistentry>
230
243
    </variablelist>
231
244
  </refsect1>
232
245
  
322
335
    </para>
323
336
  </refsect1>
324
337
  
 
338
  <refsect1 id="dbus_interface">
 
339
    <title>D-BUS INTERFACE</title>
 
340
    <para>
 
341
      The server will by default provide a D-Bus system bus interface.
 
342
      This interface will only be accessible by the root user or a
 
343
      Mandos-specific user, if such a user exists.
 
344
      <!-- XXX -->
 
345
    </para>
 
346
  </refsect1>
 
347
 
325
348
  <refsect1 id="exit_status">
326
349
    <title>EXIT STATUS</title>
327
350
    <para>
350
373
    </variablelist>
351
374
  </refsect1>
352
375
  
353
 
  <refsect1 id="file">
 
376
  <refsect1 id="files">
354
377
    <title>FILES</title>
355
378
    <para>
356
379
      Use the <option>--configdir</option> option to change where
420
443
      Currently, if a client is declared <quote>invalid</quote> due to
421
444
      having timed out, the server does not record this fact onto
422
445
      permanent storage.  This has some security implications, see
423
 
      <xref linkend="CLIENTS"/>.
 
446
      <xref linkend="clients"/>.
424
447
    </para>
425
448
    <para>
426
449
      There is currently no way of querying the server of the current
482
505
  
483
506
  <refsect1 id="security">
484
507
    <title>SECURITY</title>
485
 
    <refsect2 id="SERVER">
 
508
    <refsect2 id="server">
486
509
      <title>SERVER</title>
487
510
      <para>
488
511
        Running this <command>&COMMANDNAME;</command> server program
491
514
        soon after startup.
492
515
      </para>
493
516
    </refsect2>
494
 
    <refsect2 id="CLIENTS">
 
517
    <refsect2 id="clients">
495
518
      <title>CLIENTS</title>
496
519
      <para>
497
520
        The server only gives out its stored data to clients which