/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-20 03:22:45 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080820032245-ue341vdvzqdsg68l
* mandos (string_to_delta): Accept a whitespace-separated sequence of
                            intervals and return the sum.  This allows
                            "5m 30s" to be valid.
  (main): Provide an empty default value for the "host" option for
          "clients.conf", making it no longer a required option.

* mandos-clients.conf.xml: Removed <?xml-stylesheet>.
  (DESCRIPTION): Improved text.
  (DEFAULTS): Renamed to "OPTIONS".  Improved text for "timeout" and
              "interval".
  (CLIENTS): Removed; content moved to "OPTIONS".
  (EXPANSION): New section; document %(foo)s and %%(foo)s expansion.
  (FILES): Moved to before "EXAMPLES".
  (BUGS): New section.
  (EXAMPLES): Renamed to "EXAMPLE", as per man-pages(7).  Renamed
              example section "example_client" to "foo".  Changed
              example "host" setting to a more reasonable example host
              name.  Added additional example client "bar".

* mandos-conf.xml: Removed OVERVIEW entity.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-options.xml
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
10
<section>
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 be an IPv6 address; an
30
 
    IPv4 address can only be specified using IPv4-mapped IPv6 address
31
 
    syntax: <quote><systemitem class="ipaddress"
32
 
    >::FFFF:192.0.2.3</systemitem ></quote>.
 
23
    If this option is used, the server will only listen to a specific
 
24
    address.  If a link-local address is specified, an interface
 
25
    should be set, since a link-local address is only valid on a
 
26
    single interface.  By default, the server will listen to all
 
27
    available addresses.  Also, this must currently be an IPv6
 
28
    address; an IPv4 address can only be specified using the
 
29
    <quote><systemitem class="ipaddress">::FFFF:192.0.2.3</systemitem
 
30
    ></quote> format.
33
31
  </para>
34
32
  
35
33
  <para id="port">
40
38
  
41
39
  <para id="debug">
42
40
    If the server is run in debug mode, it will run in the foreground
43
 
    and print a lot of debugging information.  The default is to
44
 
    <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.
45
43
  </para>
46
44
  
47
45
  <para id="priority">
48
 
    GnuTLS priority string for the <acronym>TLS</acronym> handshake.
49
 
    The default is <quote><literal
50
 
    >SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP</literal></quote>.  See
51
 
    <citerefentry><refentrytitle>gnutls_priority_init</refentrytitle>
52
 
    <manvolnum>3</manvolnum></citerefentry> for the syntax.
53
 
    <emphasis>Warning</emphasis>: changing this may make the
54
 
    <acronym>TLS</acronym> handshake fail, making server-client
55
 
    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.
56
53
  </para>
57
54
  
58
55
  <para id="servicename">
59
56
    Zeroconf service name.  The default is
60
57
    <quote><literal>Mandos</literal></quote>.  This only needs to be
61
 
    changed if for some reason is would be necessary to run more than
62
 
    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
63
60
    normally be useful.  If there are name collisions on the same
64
61
    <emphasis>network</emphasis>, the newer server will automatically
65
62
    rename itself to <quote><literal>Mandos #2</literal></quote>, and