/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-options.xml

  • Committer: Teddy Hogeborn
  • Date: 2008-08-31 09:26:12 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080831092612-atz9uzia38h1ijy5
* mandos.xml (OPTIONS): Moved long options before short.  Use <option>
                        tags instead of <literal>.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-options.xml
5
5
<!--
6
6
This file is used by both mandos(8) and mandos.conf(5), since these
7
7
options can be used both on the command line and in the config file.
8
 
 
9
 
It is also used for some texts by mandos-client(8mandos).
10
8
-->
11
9
 
12
10
<section>
26
24
    specified IPv6 address.  If a link-local address is specified, an
27
25
    interface should be set, since a link-local address is only valid
28
26
    on a single interface.  By default, the server will listen to all
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.)
 
27
    available addresses.  If set, this must be an IPv6 address; an
 
28
    IPv4 address can only be specified using IPv4-mapped IPv6 address
 
29
    syntax: <quote><systemitem class="ipaddress"
 
30
    >::FFFF:192.0.2.3</systemitem ></quote>.
35
31
  </para>
36
32
  
37
33
  <para id="port">
47
43
  </para>
48
44
  
49
45
  <para id="priority">
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>.
53
 
    See <citerefentry><refentrytitle
54
 
    >gnutls_priority_init</refentrytitle>
 
46
    GnuTLS priority string for the <acronym>TLS</acronym> handshake
 
47
    with the clients.  The default is
 
48
    <quote><literal>SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP</literal
 
49
    ></quote>.  See <citerefentry>
 
50
    <refentrytitle>gnutls_priority_init</refentrytitle>
55
51
    <manvolnum>3</manvolnum></citerefentry> for the syntax.
56
52
    <emphasis>Warning</emphasis>: changing this may make the
57
 
    <acronym>TLS</acronym> handshake fail, making server-client
58
 
    communication impossible.
 
53
    <acronym>TLS</acronym> handshake fail, making communication with
 
54
    clients impossible.
59
55
  </para>
60
56
  
61
57
  <para id="servicename">
62
58
    Zeroconf service name.  The default is
63
59
    <quote><literal>Mandos</literal></quote>.  This only needs to be
64
 
    changed if for some reason is would be necessary to run more than
65
 
    one server on the same <emphasis>host</emphasis>.  This would not
 
60
    changed this if it, for some reason, is necessary to run more than
 
61
    one server on the same <emphasis>host</emphasis>, which would not
66
62
    normally be useful.  If there are name collisions on the same
67
63
    <emphasis>network</emphasis>, the newer server will automatically
68
64
    rename itself to <quote><literal>Mandos #2</literal></quote>, and
69
65
    so on; therefore, this option is not needed in that case.
70
66
  </para>
71
67
  
72
 
  <para id="dbus">
73
 
    This option controls whether the server will provide a D-Bus
74
 
    system bus interface.  The default is to provide such an
75
 
    interface.
76
 
  </para>
77
 
  
78
 
  <para id="ipv6">
79
 
    This option controls whether the server will use IPv6 sockets and
80
 
    addresses.  The default is to use IPv6.  This option should
81
 
    <emphasis>never</emphasis> normally be turned off, <emphasis>even in
82
 
    IPv4-only environments</emphasis>.  This is because <citerefentry>
83
 
    <refentrytitle>mandos-client</refentrytitle>
84
 
    <manvolnum>8mandos</manvolnum></citerefentry> will normally use
85
 
    IPv6 link-local addresses, and will not be able to find or connect
86
 
    to the server if this option is turned off.  <emphasis>Only
87
 
    advanced users should consider changing this option</emphasis>.
88
 
  </para>
89
 
  
90
 
  <para id="restore">
91
 
    This option controls whether the server will restore its state
92
 
    from the last time it ran.  Default is to restore last state.
93
 
  </para>
94
 
  
95
 
  <para id="statedir">
96
 
    Directory to save (and restore) state in.  Default is
97
 
    <quote><filename
98
 
    class="directory">/var/lib/mandos</filename></quote>.
99
 
  </para>
100
 
  
101
 
  <para id="socket">
102
 
    If this option is used, the server will not create a new network
103
 
    socket, but will instead use the supplied file descriptor.  By
104
 
    default, the server will create a new network socket.
105
 
  </para>
106
 
  
107
 
  <para id="foreground">
108
 
    This option will make the server run in the foreground and not
109
 
    write a PID file.  The default is to <emphasis>not</emphasis> run
110
 
    in the foreground, except in <option>debug</option> mode, which
111
 
    implies this option.
112
 
  </para>
113
 
  
114
68
</section>