/mandos/trunk

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/trunk
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
1
<?xml version="1.0" encoding="UTF-8"?>
95 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: corrected patterns.
2
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
3
	"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
4
5
<!--
6
This file is used by both mandos(8) and mandos.conf(5), since these
7
options can be used both on the command line and in the config file.
142 by Teddy Hogeborn
* plugins.d/password-request.c (main): Change default GnuTLS priority
8
171 by Teddy Hogeborn
Renamed "password-request" to "mandos-client".
9
It is also used for some texts by mandos-client(8mandos).
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
10
-->
11
91 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Include all DocBook-to-manpage-related
12
<section>
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
13
  <title/>
14
  
15
  <para id="interface">
16
    If this is specified, the server will only announce the service
105 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Only cd to one directory.
17
    and listen to requests on the specified network interface.
18
    Default is to use all available interfaces.  <emphasis
19
    >Note:</emphasis> a failure to bind to the specified
119 by Teddy Hogeborn
* mandos-clients.conf.xml (SYNOPSIS): Remove line breaks.
20
    interface is not considered critical, and the server will not
21
    exit, but instead continue normally.
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
22
  </para>
23
  
24
  <para id="address">
95 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: corrected patterns.
25
    If this option is used, the server will only listen to the
26
    specified IPv6 address.  If a link-local address is specified, an
27
    interface should be set, since a link-local address is only valid
28
    on a single interface.  By default, the server will listen to all
314 by Teddy Hogeborn
Support not using IPv6 in server:
29
    available addresses.  If set, this must normally be an IPv6
30
    address; an IPv4 address can only be specified using IPv4-mapped
31
    IPv6 address syntax: <quote><systemitem class="ipaddress"
32
    >::FFFF:192.0.2.3</systemitem ></quote>.  (Only if IPv6 usage is
33
    <emphasis>disabled</emphasis> (see below) must this be an IPv4
34
    address.)
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
35
  </para>
36
  
37
  <para id="port">
38
    If this option is used, the server will bind to that port. By
39
    default, the server will listen to an arbitrary port given by the
40
    operating system.
41
  </para>
42
  
43
  <para id="debug">
44
    If the server is run in debug mode, it will run in the foreground
105 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Only cd to one directory.
45
    and print a lot of debugging information.  The default is to
46
    <emphasis>not</emphasis> run in debug mode.
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
47
  </para>
48
  
49
  <para id="priority">
143 by Teddy Hogeborn
* Makefile (mandos.8): Add dependency on "overview.xml" and
50
    GnuTLS priority string for the <acronym>TLS</acronym> handshake.
51
    The default is <quote><literal
52
    >SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP</literal></quote>.  See
53
    <citerefentry><refentrytitle>gnutls_priority_init</refentrytitle>
116 by Teddy Hogeborn
* mandos-options.xml (priority): Added <acronym> tags.
54
    <manvolnum>3</manvolnum></citerefentry> for the syntax.
55
    <emphasis>Warning</emphasis>: changing this may make the
143 by Teddy Hogeborn
* Makefile (mandos.8): Add dependency on "overview.xml" and
56
    <acronym>TLS</acronym> handshake fail, making server-client
57
    communication impossible.
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
58
  </para>
59
  
60
  <para id="servicename">
61
    Zeroconf service name.  The default is
62
    <quote><literal>Mandos</literal></quote>.  This only needs to be
216 by Teddy Hogeborn
* Makefile: Add HTML rules for manual pages.
63
    changed if for some reason is would be necessary to run more than
64
    one server on the same <emphasis>host</emphasis>.  This would not
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
65
    normally be useful.  If there are name collisions on the same
66
    <emphasis>network</emphasis>, the newer server will automatically
67
    rename itself to <quote><literal>Mandos #2</literal></quote>, and
68
    so on; therefore, this option is not needed in that case.
69
  </para>
314 by Teddy Hogeborn
Support not using IPv6 in server:
70
  
243 by Teddy Hogeborn
* mandos (Client.timeout, Client.interval): Changed from being a
71
  <para id="dbus">
72
    This option controls whether the server will provide a D-Bus
73
    system bus interface.  The default is to provide such an
74
    interface.
75
  </para>
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
76
  
314 by Teddy Hogeborn
Support not using IPv6 in server:
77
  <para id="ipv6">
78
    This option controls whether the server will use IPv6 sockets and
79
    addresses.  The default is to use IPv6.  This option should
80
    <emphasis>never</emphasis> normally be turned off, <emphasis>even in
81
    IPv4-only environments</emphasis>.  This is because <citerefentry>
82
    <refentrytitle>mandos-client</refentrytitle>
83
    <manvolnum>8mandos</manvolnum></citerefentry> will normally use
84
    IPv6 link-local addresses, and will not be able to find or connect
85
    to the server if this option is turned off.  <emphasis>Only
86
    advanced users should consider changing this option</emphasis>.
87
  </para>
518.2.2 by Teddy Hogeborn
Directory with persistent state can now be changed with the "statedir"
88
  
518.1.1 by Björn Påhlsson
Persistent state: New feature. Client state is now stored when mandos
89
  <para id="restore">
90
    This option controls whether the server will restore any state from
520 by Björn Påhlsson
merge persistent state
91
    last time it ran. Default is to try restore last state.
518.1.1 by Björn Påhlsson
Persistent state: New feature. Client state is now stored when mandos
92
  </para>
314 by Teddy Hogeborn
Support not using IPv6 in server:
93
  
518.2.2 by Teddy Hogeborn
Directory with persistent state can now be changed with the "statedir"
94
  <para id="statedir">
95
    Directory to save (and restore) state in.  Default is
96
    <quote><filename
97
    class="directory">/var/lib/mandos</filename></quote>.
98
  </para>
99
  
91 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Include all DocBook-to-manpage-related
100
</section>