/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: 2009-01-12 22:02:33 UTC
  • Revision ID: teddy@fukt.bsnet.se-20090112220233-lawxo4uvyzb38u1f
* README (The Plugin System): Removed redundant text about options and
                              files for the plugins, this is now
                              documented in the manuals for the
                              plugins.

* plugins.d/mandos-client.c (main): Remove comment which was copied
                                    from another program by mistake.
                                    Use "sscanf" instead of "strtol"
                                    to parse numbers; this uses the
                                    correct type instead of casting.
                                    Don't report errors when removing
                                    temporary directory if directory
                                    is already gone.

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-12">
 
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>
31
32
    </authorgroup>
32
33
    <copyright>
33
34
      <year>2008</year>
 
35
      <year>2009</year>
34
36
      <holder>Teddy Hogeborn</holder>
35
37
      <holder>Björn Påhlsson</holder>
36
38
    </copyright>
83
85
      <replaceable>DIRECTORY</replaceable></option></arg>
84
86
      <sbr/>
85
87
      <arg><option>--debug</option></arg>
 
88
      <sbr/>
 
89
      <arg><option>--no-dbus</option></arg>
86
90
    </cmdsynopsis>
87
91
    <cmdsynopsis>
88
92
      <command>&COMMANDNAME;</command>
227
231
          </para>
228
232
        </listitem>
229
233
      </varlistentry>
 
234
      
 
235
      <varlistentry>
 
236
        <term><option>--no-dbus</option></term>
 
237
        <listitem>
 
238
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
 
239
          <para>
 
240
            See also <xref linkend="dbus_interface"/>.
 
241
          </para>
 
242
        </listitem>
 
243
      </varlistentry>
230
244
    </variablelist>
231
245
  </refsect1>
232
246
  
322
336
    </para>
323
337
  </refsect1>
324
338
  
 
339
  <refsect1 id="dbus_interface">
 
340
    <title>D-BUS INTERFACE</title>
 
341
    <para>
 
342
      The server will by default provide a D-Bus system bus interface.
 
343
      This interface will only be accessible by the root user or a
 
344
      Mandos-specific user, if such a user exists.
 
345
      <!-- XXX -->
 
346
    </para>
 
347
  </refsect1>
 
348
 
325
349
  <refsect1 id="exit_status">
326
350
    <title>EXIT STATUS</title>
327
351
    <para>
350
374
    </variablelist>
351
375
  </refsect1>
352
376
  
353
 
  <refsect1 id="file">
 
377
  <refsect1 id="files">
354
378
    <title>FILES</title>
355
379
    <para>
356
380
      Use the <option>--configdir</option> option to change where
420
444
      Currently, if a client is declared <quote>invalid</quote> due to
421
445
      having timed out, the server does not record this fact onto
422
446
      permanent storage.  This has some security implications, see
423
 
      <xref linkend="CLIENTS"/>.
 
447
      <xref linkend="clients"/>.
424
448
    </para>
425
449
    <para>
426
450
      There is currently no way of querying the server of the current
482
506
  
483
507
  <refsect1 id="security">
484
508
    <title>SECURITY</title>
485
 
    <refsect2 id="SERVER">
 
509
    <refsect2 id="server">
486
510
      <title>SERVER</title>
487
511
      <para>
488
512
        Running this <command>&COMMANDNAME;</command> server program
491
515
        soon after startup.
492
516
      </para>
493
517
    </refsect2>
494
 
    <refsect2 id="CLIENTS">
 
518
    <refsect2 id="clients">
495
519
      <title>CLIENTS</title>
496
520
      <para>
497
521
        The server only gives out its stored data to clients which
504
528
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
505
529
        <manvolnum>5</manvolnum></citerefentry>)
506
530
        <emphasis>must</emphasis> be made non-readable by anyone
507
 
        except the user running the server.
 
531
        except the user starting the server (usually root).
508
532
      </para>
509
533
      <para>
510
534
        As detailed in <xref linkend="checking"/>, the status of all