/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-19 13:25:14 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080819132514-wawrvgmfjovg9poj
* Makefile (DOCBOOKTOMAN): Added "--xinclude".

* mandos-options.xml: New file; moved mandos(8) option descriptions
                      here.

* mandos.conf.xml: Add XInclude namespace.
  (OPTIONS): New separate section with options from old "DESCRIPTION"
             section.  Changed all options to include a synopsis and
             include its paragraph from "mandos-options.xml".
  (FILES): Moved to before "EXAMPLES".
  (BUGS): New section.
  (EXAMPLES): Renamed to "EXAMPLE", as per man-pages(7).  Unindented
              example text.

* mandos.xml: Removed OVERVIEW entity.  Add XInclude namespace.
  (OPTIONS): Moved all descriptive paragraphs to "mandos-options.xml"
             and just <xi:include/> them from here.
  (OVERVIEW): Changed to do <xi:include/>.

* overview.xml: Added DOCTYPE; reportedly needed for XInclude to work.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
<?xml version="1.0" encoding="UTF-8"?>
2
 
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
 
2
<!DOCTYPE simplesect PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
3
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
4
4
 
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
 
<section>
 
10
<simplesect>
13
11
  <title/>
14
12
  
15
13
  <para id="interface">
16
14
    If this is specified, the server will only announce the service
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
20
 
    interface is not considered critical, and the server will not
21
 
    exit, but instead continue normally.
 
15
    and listen to requests on network interface
 
16
    <replaceable>IF</replaceable>.  Default is to use all available
 
17
    interfaces.  <emphasis>Note:</emphasis> a failure to bind to the
 
18
    specified interface is not considered critical, and the server
 
19
    does not exit.
22
20
  </para>
23
21
  
24
22
  <para id="address">
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
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.)
 
23
    If this option is used, the server will only listen to a specific
 
24
    address.  This must currently be an IPv6 address; an IPv4 address
 
25
    can only be specified using the <quote><systemitem
 
26
    class="ipaddress">::FFFF:192.0.2.3</systemitem></quote> format.
 
27
    Also, if a link-local address is specified, an interface should be
 
28
    set, since a link-local address is only valid on a single
 
29
    interface.  By default, the server will listen to all available
 
30
    addresses.
35
31
  </para>
36
32
  
37
33
  <para id="port">
42
38
  
43
39
  <para id="debug">
44
40
    If the server is run in debug mode, it will run in the foreground
45
 
    and print a lot of debugging information.  The default is to
46
 
    <emphasis>not</emphasis> run in debug mode.
 
41
    and print a lot of debugging information.  The default is
 
42
    <emphasis>not</emphasis> to run in debug mode.
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>.  See
53
 
    <citerefentry><refentrytitle>gnutls_priority_init</refentrytitle>
54
 
    <manvolnum>3</manvolnum></citerefentry> for the syntax.
55
 
    <emphasis>Warning</emphasis>: changing this may make the
56
 
    <acronym>TLS</acronym> handshake fail, making server-client
57
 
    communication impossible.
 
46
    GnuTLS priority string for the TLS handshake with the clients.
 
47
    The default is
 
48
    <quote><literal>SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP</literal></quote>.
 
49
    See <citerefentry><refentrytitle>gnutls_priority_init
 
50
    </refentrytitle><manvolnum>3</manvolnum></citerefentry> for the
 
51
    syntax.  <emphasis>Warning</emphasis>: changing this may make the
 
52
    TLS handshake fail, making communication with clients impossible.
58
53
  </para>
59
54
  
60
55
  <para id="servicename">
61
56
    Zeroconf service name.  The default is
62
57
    <quote><literal>Mandos</literal></quote>.  This only needs to be
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
 
58
    changed this if it, for some reason, is necessary to run more than
 
59
    one server on the same <emphasis>host</emphasis>, which would not
65
60
    normally be useful.  If there are name collisions on the same
66
61
    <emphasis>network</emphasis>, the newer server will automatically
67
62
    rename itself to <quote><literal>Mandos #2</literal></quote>, and
68
63
    so on; therefore, this option is not needed in that case.
69
64
  </para>
70
65
  
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>
76
 
  
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>
88
 
  
89
 
</section>
 
66
</simplesect>