/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-17 22:42:28 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080817224228-nhor2yuv230if01i
* Makefile (DOCBOOKTOMAN): Use the local manpages/docbook.xsl file, do
                           not rely on a stylesheet declaration.

* mandos.xml: Removed <?xml-stylesheet>.  New entity "&OVERVIEW;"
              refers to "overview.xml". Changed all single quotes to
              double quotes for consistency.
  (DESCRIPTION): Use the term "TLS" and not "GnuTLS" for the protocol.
                 Refer to the "OVERVIEW" section for reason for IPv6
                 link-local addresses.
  (PURPOSE): Shortened a lot.  Refer to "OVERVIEW" section for details.
  (OVERVIEW): New section.  Include &OVERVIEW; and add a paragraph
              about what the role of this program is.
  (SECURITY/CLIENTS): Refer to the "CHECKING" section for details on
                      checking.
  (SEE ALSO): Changed from an <itemizedlist> to a <variablelist>.
              Added a short text for each entry.  Removed reference to
              plugin-runner(8mandos).  Add reference to RFC 4291 and
              RFC 4346.

* overview.xml: New file, containing a single <para>.  The idea is to
                use this in all the man pages.

* plugins.d/password-request.c: Updated comments about spurious
                                warnings.

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
 
It is also used for some texts by password-request(8mandos).
10
 
-->
11
 
 
12
 
<section>
13
 
  <title/>
14
 
  
15
 
  <para id="interface">
16
 
    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.
22
 
  </para>
23
 
  
24
 
  <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>.
33
 
  </para>
34
 
  
35
 
  <para id="port">
36
 
    If this option is used, the server will bind to that port. By
37
 
    default, the server will listen to an arbitrary port given by the
38
 
    operating system.
39
 
  </para>
40
 
  
41
 
  <para id="debug">
42
 
    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.
45
 
  </para>
46
 
  
47
 
  <para id="priority">
48
 
    GnuTLS priority string for the <acronym>TLS</acronym> handshake
49
 
    with the clients.  The default is
50
 
    <quote><literal>SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP</literal
51
 
    ></quote>.  See <citerefentry>
52
 
    <refentrytitle>gnutls_priority_init</refentrytitle>
53
 
    <manvolnum>3</manvolnum></citerefentry> for the syntax.
54
 
    <emphasis>Warning</emphasis>: changing this may make the
55
 
    <acronym>TLS</acronym> handshake fail, making communication with
56
 
    clients impossible.
57
 
  </para>
58
 
  
59
 
  <para id="servicename">
60
 
    Zeroconf service name.  The default is
61
 
    <quote><literal>Mandos</literal></quote>.  This only needs to be
62
 
    changed this if it, for some reason, is necessary to run more than
63
 
    one server on the same <emphasis>host</emphasis>, which would not
64
 
    normally be useful.  If there are name collisions on the same
65
 
    <emphasis>network</emphasis>, the newer server will automatically
66
 
    rename itself to <quote><literal>Mandos #2</literal></quote>, and
67
 
    so on; therefore, this option is not needed in that case.
68
 
  </para>
69
 
  
70
 
</section>