/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-29 05:53:59 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080829055359-wkdasnyxtylmnxus
* mandos.xml (EXAMPLE): Replaced all occurences of command name with
                        "&COMMANDNAME;".

* plugins.d/password-prompt.c (main): Improved some documentation
                                      strings.  Do perror() of
                                      tcgetattr() fails.  Add debug
                                      output if interrupted by signal.
                                      Loop over write() instead of
                                      using fwrite() when outputting
                                      password.  Add debug output if
                                      getline() returns 0, unless it
                                      was caused by a signal.  Add
                                      exit status code to debug
                                      output.

* plugins.d/password-prompt.xml: Changed all single quotes to double
                                 quotes for consistency.  Removed
                                 <?xml-stylesheet>.
  (ENTITY TIMESTAMP): New.  Automatically updated by Emacs time-stamp
                      by using Emacs local variables.
  (/refentry/refentryinfo/title): Changed to "Mandos Manual".
  (/refentry/refentryinfo/productname): Changed to "Mandos".
  (/refentry/refentryinfo/date): New; set to "&TIMESTAMP;".
  (/refentry/refentryinfo/copyright): Split copyright holders.
  (/refentry/refnamediv/refpurpose): Improved wording.
  (SYNOPSIS): Fix to use correct markup.  Add short options.
  (DESCRIPTION, OPTIONS): Improved wording.
  (OPTIONS): Improved wording.  Use more correct markup.  Document
             short options.
  (EXIT STATUS): Add text.
  (ENVIRONMENT): Document use of "cryptsource" and "crypttarget".
  (FILES): REMOVED.
  (BUGS): Add text.
  (EXAMPLE): Added some examples.
  (SECURITY): Added text.
  (SEE ALSO): Remove reference to mandos(8).  Add reference to
              crypttab(5).

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>
17
15
    and listen to requests on the specified network interface.
18
16
    Default is to use all available interfaces.  <emphasis
19
17
    >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.
 
18
    interface is not considered critical, and the server does not
 
19
    exit, but will instead continue normally.
22
20
  </para>
23
21
  
24
22
  <para id="address">
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>.  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
 
  <para id="restore">
90
 
    This option controls whether the server will restore any state from
91
 
    last time it ran. Default is to try restore last state.
92
 
  </para>
93
 
  
94
 
  <para id="statedir">
95
 
    Directory to save (and restore) state in.  Default is
96
 
    <quote><filename
97
 
    class="directory">/var/lib/mandos</filename></quote>.
98
 
  </para>
99
 
  
100
66
</section>