/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: 2008-09-13 15:36:18 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080913153618-atp386q2bqj0ku99
* Makefile (install-client-nokey): Do "&&" instead of ";" to catch
                                   errors.

* README: Kill the straight quotes.  Add copyright notice.

* overview.xml: Improved wording.

Show diffs side-by-side

added added

removed removed

Lines of Context:
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">
4
5
<!ENTITY COMMANDNAME "mandos">
5
 
<!ENTITY TIMESTAMP "2009-02-15">
6
 
<!ENTITY % common SYSTEM "common.ent">
7
 
%common;
 
6
<!ENTITY TIMESTAMP "2008-09-12">
8
7
]>
9
8
 
10
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
 
   <refentryinfo>
 
10
  <refentryinfo>
12
11
    <title>Mandos Manual</title>
13
12
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
13
    <productname>Mandos</productname>
15
 
    <productnumber>&version;</productnumber>
 
14
    <productnumber>&VERSION;</productnumber>
16
15
    <date>&TIMESTAMP;</date>
17
16
    <authorgroup>
18
17
      <author>
32
31
    </authorgroup>
33
32
    <copyright>
34
33
      <year>2008</year>
35
 
      <year>2009</year>
36
34
      <holder>Teddy Hogeborn</holder>
37
35
      <holder>Björn Påhlsson</holder>
38
36
    </copyright>
85
83
      <replaceable>DIRECTORY</replaceable></option></arg>
86
84
      <sbr/>
87
85
      <arg><option>--debug</option></arg>
88
 
      <sbr/>
89
 
      <arg><option>--no-dbus</option></arg>
90
 
      <sbr/>
91
 
      <arg><option>--no-ipv6</option></arg>
92
86
    </cmdsynopsis>
93
87
    <cmdsynopsis>
94
88
      <command>&COMMANDNAME;</command>
233
227
          </para>
234
228
        </listitem>
235
229
      </varlistentry>
236
 
      
237
 
      <varlistentry>
238
 
        <term><option>--no-dbus</option></term>
239
 
        <listitem>
240
 
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
241
 
          <para>
242
 
            See also <xref linkend="dbus_interface"/>.
243
 
          </para>
244
 
        </listitem>
245
 
      </varlistentry>
246
 
      
247
 
      <varlistentry>
248
 
        <term><option>--no-ipv6</option></term>
249
 
        <listitem>
250
 
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
251
 
        </listitem>
252
 
      </varlistentry>
253
230
    </variablelist>
254
231
  </refsect1>
255
232
  
345
322
    </para>
346
323
  </refsect1>
347
324
  
348
 
  <refsect1 id="dbus_interface">
349
 
    <title>D-BUS INTERFACE</title>
350
 
    <para>
351
 
      The server will by default provide a D-Bus system bus interface.
352
 
      This interface will only be accessible by the root user or a
353
 
      Mandos-specific user, if such a user exists.
354
 
      <!-- XXX -->
355
 
    </para>
356
 
  </refsect1>
357
 
  
358
325
  <refsect1 id="exit_status">
359
326
    <title>EXIT STATUS</title>
360
327
    <para>
383
350
    </variablelist>
384
351
  </refsect1>
385
352
  
386
 
  <refsect1 id="files">
 
353
  <refsect1 id="file">
387
354
    <title>FILES</title>
388
355
    <para>
389
356
      Use the <option>--configdir</option> option to change where
453
420
      Currently, if a client is declared <quote>invalid</quote> due to
454
421
      having timed out, the server does not record this fact onto
455
422
      permanent storage.  This has some security implications, see
456
 
      <xref linkend="clients"/>.
 
423
      <xref linkend="CLIENTS"/>.
457
424
    </para>
458
425
    <para>
459
426
      There is currently no way of querying the server of the current
467
434
      Debug mode is conflated with running in the foreground.
468
435
    </para>
469
436
    <para>
470
 
      The console log messages do not show a time stamp.
 
437
      The console log messages does not show a time stamp.
471
438
    </para>
472
439
    <para>
473
440
      This server does not check the expire time of clients’ OpenPGP
515
482
  
516
483
  <refsect1 id="security">
517
484
    <title>SECURITY</title>
518
 
    <refsect2 id="server">
 
485
    <refsect2 id="SERVER">
519
486
      <title>SERVER</title>
520
487
      <para>
521
488
        Running this <command>&COMMANDNAME;</command> server program
524
491
        soon after startup.
525
492
      </para>
526
493
    </refsect2>
527
 
    <refsect2 id="clients">
 
494
    <refsect2 id="CLIENTS">
528
495
      <title>CLIENTS</title>
529
496
      <para>
530
497
        The server only gives out its stored data to clients which
537
504
        <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
538
505
        <manvolnum>5</manvolnum></citerefentry>)
539
506
        <emphasis>must</emphasis> be made non-readable by anyone
540
 
        except the user starting the server (usually root).
 
507
        except the user running the server.
541
508
      </para>
542
509
      <para>
543
510
        As detailed in <xref linkend="checking"/>, the status of all