/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.conf.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
 
<?xml version="1.0" encoding="UTF-8"?>
 
1
<?xml version='1.0' encoding='UTF-8'?>
2
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
3
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
 
4
<!ENTITY VERSION "1.0">
4
5
<!ENTITY CONFNAME "mandos.conf">
5
6
<!ENTITY CONFPATH "<filename>/etc/mandos/mandos.conf</filename>">
6
 
<!ENTITY TIMESTAMP "2009-02-25">
7
 
<!ENTITY % common SYSTEM "common.ent">
8
 
%common;
 
7
<!ENTITY OVERVIEW SYSTEM "overview.xml">
9
8
]>
10
9
 
11
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
12
11
  <refentryinfo>
13
 
    <title>Mandos Manual</title>
 
12
    <title>&CONFNAME;</title>
14
13
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
15
 
    <productname>Mandos</productname>
16
 
    <productnumber>&version;</productnumber>
17
 
    <date>&TIMESTAMP;</date>
 
14
    <productname>&CONFNAME;</productname>
 
15
    <productnumber>&VERSION;</productnumber>
18
16
    <authorgroup>
19
17
      <author>
20
18
        <firstname>Björn</firstname>
33
31
    </authorgroup>
34
32
    <copyright>
35
33
      <year>2008</year>
36
 
      <year>2009</year>
37
34
      <holder>Teddy Hogeborn</holder>
38
35
      <holder>Björn Påhlsson</holder>
39
36
    </copyright>
40
 
    <xi:include href="legalnotice.xml"/>
 
37
    <legalnotice>
 
38
      <para>
 
39
        This manual page is free software: you can redistribute it
 
40
        and/or modify it under the terms of the GNU General Public
 
41
        License as published by the Free Software Foundation,
 
42
        either version 3 of the License, or (at your option) any
 
43
        later version.
 
44
      </para>
 
45
 
 
46
      <para>
 
47
        This manual page is distributed in the hope that it will
 
48
        be useful, but WITHOUT ANY WARRANTY; without even the
 
49
        implied warranty of MERCHANTABILITY or FITNESS FOR A
 
50
        PARTICULAR PURPOSE.  See the GNU General Public License
 
51
        for more details.
 
52
      </para>
 
53
 
 
54
      <para>
 
55
        You should have received a copy of the GNU General Public
 
56
        License along with this program; If not, see
 
57
        <ulink url="http://www.gnu.org/licenses/"/>.
 
58
      </para>
 
59
    </legalnotice>
41
60
  </refentryinfo>
42
 
  
 
61
 
43
62
  <refmeta>
44
63
    <refentrytitle>&CONFNAME;</refentrytitle>
45
64
    <manvolnum>5</manvolnum>
51
70
      Configuration file for the Mandos server
52
71
    </refpurpose>
53
72
  </refnamediv>
54
 
  
 
73
 
55
74
  <refsynopsisdiv>
56
 
    <synopsis>&CONFPATH;</synopsis>
 
75
    <synopsis>
 
76
      &CONFPATH;
 
77
    </synopsis>
57
78
  </refsynopsisdiv>
58
 
  
 
79
 
59
80
  <refsect1 id="description">
60
81
    <title>DESCRIPTION</title>
61
82
    <para>
62
83
      The file &CONFPATH; is a simple configuration file for
63
84
      <citerefentry><refentrytitle>mandos</refentrytitle>
64
85
      <manvolnum>8</manvolnum></citerefentry>, and is read by it at
65
 
      startup.  The configuration file starts with <quote><literal
66
 
      >[DEFAULT]</literal></quote> on a line by itself, followed by
67
 
      any number of <quote><varname><replaceable>option</replaceable
68
 
      ></varname>=<replaceable>value</replaceable></quote> entries,
69
 
      with continuations in the style of RFC 822.  <quote><varname
70
 
      ><replaceable>option</replaceable></varname>: <replaceable
71
 
      >value</replaceable></quote> is also accepted.  Note that
72
 
      leading whitespace is removed from values.  Lines beginning with
73
 
      <quote>#</quote> or <quote>;</quote> are ignored and may be used
74
 
      to provide comments.
 
86
      startup.  The configuration file starts with
 
87
      <quote><literal>[DEFAULT]</literal></quote> on a line by itself,
 
88
      followed by any number of
 
89
      <quote><varname><replaceable>option</replaceable></varname>=<replaceable>value</replaceable></quote>
 
90
      entries, with continuations in the style of RFC 822.
 
91
      <quote><varname><replaceable>option</replaceable></varname>:
 
92
      <replaceable>value</replaceable></quote> is also accepted.  Note
 
93
      that leading whitespace is removed from values.  Lines beginning
 
94
      with <quote>#</quote> or <quote>;</quote> are ignored and may be
 
95
      used to provide comments.
75
96
    </para>
76
 
    
 
97
 
77
98
  </refsect1>
78
99
  <refsect1>
79
100
    <title>OPTIONS</title>
80
101
    
81
102
    <variablelist>
82
103
      <varlistentry>
83
 
        <term><option>interface<literal> = </literal><replaceable
84
 
        >NAME</replaceable></option></term>
 
104
        <term><varname>interface</varname></term>
85
105
        <listitem>
 
106
          <synopsis><literal>interface = </literal><arg
 
107
          choice="plain"><replaceable>IF</replaceable></arg>
 
108
          </synopsis>
86
109
          <xi:include href="mandos-options.xml" xpointer="interface"/>
87
110
        </listitem>
88
111
      </varlistentry>
89
 
      
 
112
 
90
113
      <varlistentry>
91
 
        <term><option>address<literal> = </literal><replaceable
92
 
          >ADDRESS</replaceable></option></term>
 
114
        <term><varname>address</varname></term>
93
115
        <listitem>
 
116
          <synopsis><literal>address = </literal><arg
 
117
          choice="plain"><replaceable>ADDRESS</replaceable></arg>
 
118
          </synopsis>
94
119
          <xi:include href="mandos-options.xml" xpointer="address"/>
95
120
        </listitem>
96
121
      </varlistentry>
97
 
      
 
122
 
98
123
      <varlistentry>
99
 
        <term><option>port<literal> = </literal><replaceable
100
 
        >NUMBER</replaceable></option></term>
 
124
        <term><varname>port</varname></term>
101
125
        <listitem>
 
126
          <synopsis><literal>port = </literal><arg
 
127
          choice="plain"><replaceable>PORT</replaceable></arg>
 
128
          </synopsis>
102
129
          <xi:include href="mandos-options.xml" xpointer="port"/>
103
130
        </listitem>
104
131
      </varlistentry>
105
 
      
 
132
 
106
133
      <varlistentry>
107
 
        <term><option>debug<literal> = </literal>{ <literal
108
 
          >1</literal> | <literal>yes</literal> | <literal
109
 
          >true</literal> | <literal>on</literal> | <literal
110
 
          >0</literal> | <literal>no</literal> | <literal
111
 
          >false</literal> | <literal>off</literal> }</option></term>
 
134
        <term><varname>debug</varname></term>
112
135
        <listitem>
 
136
          <synopsis><literal>debug =</literal><group choice="req">
 
137
            <arg choice="plain">1</arg>
 
138
            <arg choice="plain">yes</arg>
 
139
            <arg choice="plain">true</arg>
 
140
            <arg choice="plain">on</arg>
 
141
            <arg choice="plain">0</arg>
 
142
            <arg choice="plain">no</arg>
 
143
            <arg choice="plain">false</arg>
 
144
            <arg choice="plain">off</arg>
 
145
          </group>
 
146
          </synopsis>
113
147
          <xi:include href="mandos-options.xml" xpointer="debug"/>
114
148
        </listitem>
115
149
      </varlistentry>
116
 
      
 
150
 
117
151
      <varlistentry>
118
 
        <term><option>priority<literal> = </literal><replaceable
119
 
        >STRING</replaceable></option></term>
 
152
        <term><varname>priority</varname></term>
120
153
        <listitem>
 
154
          <synopsis><literal>priority = </literal><arg
 
155
          choice="plain"><replaceable>PRIORITY</replaceable></arg>
 
156
          </synopsis>
121
157
          <xi:include href="mandos-options.xml" xpointer="priority"/>
122
158
        </listitem>
123
159
      </varlistentry>
124
 
      
 
160
 
125
161
      <varlistentry>
126
 
        <term><option>servicename<literal> = </literal
127
 
        ><replaceable>NAME</replaceable></option></term>
 
162
        <term><varname>servicename</varname></term>
 
163
          <synopsis><literal>servicename = </literal><arg
 
164
          choice="plain"><replaceable>NAME</replaceable></arg>
 
165
          </synopsis>
128
166
        <listitem>
129
167
          <xi:include href="mandos-options.xml"
130
168
                      xpointer="servicename"/>
131
169
        </listitem>
132
170
      </varlistentry>
133
171
      
134
 
      <varlistentry>
135
 
        <term><option>use_dbus<literal> = </literal>{ <literal
136
 
          >1</literal> | <literal>yes</literal> | <literal
137
 
          >true</literal> | <literal>on</literal> | <literal
138
 
          >0</literal> | <literal>no</literal> | <literal
139
 
          >false</literal> | <literal>off</literal> }</option></term>
140
 
        <listitem>
141
 
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
142
 
        </listitem>
143
 
      </varlistentry>
144
 
      
145
 
      <varlistentry>
146
 
        <term><option>use_ipv6<literal> = </literal>{ <literal
147
 
          >1</literal> | <literal>yes</literal> | <literal
148
 
          >true</literal> | <literal>on</literal> | <literal
149
 
          >0</literal> | <literal>no</literal> | <literal
150
 
          >false</literal> | <literal>off</literal> }</option></term>
151
 
        <listitem>
152
 
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
153
 
        </listitem>
154
 
      </varlistentry>
155
 
      
156
172
    </variablelist>
157
173
  </refsect1>
158
174
  
167
183
    <title>BUGS</title>
168
184
    <para>
169
185
      The <literal>[DEFAULT]</literal> is necessary because the Python
170
 
      built-in module <systemitem class="library">ConfigParser</systemitem>
171
 
      requires it.
 
186
      module <systemitem class="library">ConfigParser</systemitem>
 
187
      requres it.
172
188
    </para>
173
189
  </refsect1>
174
190
  
175
191
  <refsect1 id="example">
176
192
    <title>EXAMPLE</title>
177
193
    <informalexample>
178
 
      <para>
179
 
        No options are actually required:
180
 
      </para>
181
 
      <programlisting>
182
 
[DEFAULT]
183
 
      </programlisting>
184
 
    </informalexample>
185
 
    <informalexample>
186
 
      <para>
187
 
        An example using all the options:
188
 
      </para>
189
194
      <programlisting>
190
195
[DEFAULT]
191
196
# A configuration example
192
197
interface = eth0
193
 
address = fe80::aede:48ff:fe71:f6f2
 
198
address = 2001:db8:f983:bd0b:30de:ae4a:71f2:f672
194
199
port = 1025
195
200
debug = true
196
201
priority = SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP
197
 
servicename = Daena
198
 
use_dbus = False
199
 
use_ipv6 = True
 
202
servicename = Mandos
200
203
      </programlisting>
201
204
    </informalexample>
202
205
  </refsect1>
203
 
  
204
 
  <refsect1 id="see_also">
205
 
    <title>SEE ALSO</title>
206
 
    <para>
207
 
      <citerefentry><refentrytitle>gnutls_priority_init</refentrytitle
208
 
      ><manvolnum>3</manvolnum></citerefentry>,
209
 
      <citerefentry><refentrytitle>mandos</refentrytitle>
210
 
      <manvolnum>8</manvolnum></citerefentry>,
211
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
212
 
      <manvolnum>5</manvolnum></citerefentry>
213
 
    </para>
214
 
    
215
 
    <variablelist>
216
 
      <varlistentry>
217
 
        <term>
218
 
          RFC 4291: <citetitle>IP Version 6 Addressing
219
 
          Architecture</citetitle>
220
 
        </term>
221
 
        <listitem>
222
 
          <variablelist>
223
 
            <varlistentry>
224
 
              <term>Section 2.2: <citetitle>Text Representation of
225
 
              Addresses</citetitle></term>
226
 
              <listitem><para/></listitem>
227
 
            </varlistentry>
228
 
            <varlistentry>
229
 
              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
230
 
              Address</citetitle></term>
231
 
              <listitem><para/></listitem>
232
 
            </varlistentry>
233
 
            <varlistentry>
234
 
            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
235
 
            Addresses</citetitle></term>
236
 
            <listitem>
237
 
              <para>
238
 
                The clients use IPv6 link-local addresses, which are
239
 
                immediately usable since a link-local addresses is
240
 
                automatically assigned to a network interface when it
241
 
                is brought up.
242
 
              </para>
243
 
            </listitem>
244
 
            </varlistentry>
245
 
          </variablelist>
246
 
        </listitem>
247
 
      </varlistentry>
248
 
      <varlistentry>
249
 
        <term>
250
 
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
251
 
        </term>
252
 
        <listitem>
253
 
          <para>
254
 
            Zeroconf is the network protocol standard used by clients
255
 
            for finding the Mandos server on the local network.
256
 
          </para>
257
 
        </listitem>
258
 
      </varlistentry>
259
 
    </variablelist>
260
 
  </refsect1>
261
206
</refentry>
262
 
<!-- Local Variables: -->
263
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
264
 
<!-- time-stamp-end: "[\"']>" -->
265
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
266
 
<!-- End: -->