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

  • Committer: Teddy Hogeborn
  • Date: 2008-08-31 08:47:38 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080831084738-uu70kayyt876982d
* mandos-keygen: Minor help text change.

* mandos-keygen.xml: Changed plural "keys" to singular "key"
                     throughout.
  (NAME): Improved wording.
  (DESCRIPTION): Improved wording.
  (OPTIONS): Split options in <term> tags into separate <term> tags.
             Use <option> tags.  Move long options before short
             options.  Uppercase replaceables.
  (OVERVIEW): Improved wording.
  (EXIT STATUS): Also cover --password option.
  (EXAMPLE): Add two examples using the --password option.
  (SECURITY): Improved wording.

* overview.xml: Improved wording.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-options.xml
 
1
<?xml version="1.0" encoding="UTF-8"?>
 
2
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
 
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.
 
8
-->
 
9
 
 
10
<section>
 
11
  <title/>
 
12
  
 
13
  <para id="interface">
 
14
    If this is specified, the server will only announce the service
 
15
    and listen to requests on the specified network interface.
 
16
    Default is to use all available interfaces.  <emphasis
 
17
    >Note:</emphasis> a failure to bind to the specified
 
18
    interface is not considered critical, and the server will not
 
19
    exit, but instead continue normally.
 
20
  </para>
 
21
  
 
22
  <para id="address">
 
23
    If this option is used, the server will only listen to the
 
24
    specified IPv6 address.  If a link-local address is specified, an
 
25
    interface should be set, since a link-local address is only valid
 
26
    on a single interface.  By default, the server will listen to all
 
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>.
 
31
  </para>
 
32
  
 
33
  <para id="port">
 
34
    If this option is used, the server will bind to that port. By
 
35
    default, the server will listen to an arbitrary port given by the
 
36
    operating system.
 
37
  </para>
 
38
  
 
39
  <para id="debug">
 
40
    If the server is run in debug mode, it will run in the foreground
 
41
    and print a lot of debugging information.  The default is to
 
42
    <emphasis>not</emphasis> run in debug mode.
 
43
  </para>
 
44
  
 
45
  <para id="priority">
 
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>
 
51
    <manvolnum>3</manvolnum></citerefentry> for the syntax.
 
52
    <emphasis>Warning</emphasis>: changing this may make the
 
53
    <acronym>TLS</acronym> handshake fail, making communication with
 
54
    clients impossible.
 
55
  </para>
 
56
  
 
57
  <para id="servicename">
 
58
    Zeroconf service name.  The default is
 
59
    <quote><literal>Mandos</literal></quote>.  This only needs to be
 
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
 
62
    normally be useful.  If there are name collisions on the same
 
63
    <emphasis>network</emphasis>, the newer server will automatically
 
64
    rename itself to <quote><literal>Mandos #2</literal></quote>, and
 
65
    so on; therefore, this option is not needed in that case.
 
66
  </para>
 
67
  
 
68
</section>