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

  • Committer: Teddy Hogeborn
  • Date: 2008-08-19 23:44:17 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080819234417-8dz5prw19ihrklx6
* Makefile (DOCBOOKTOMAN): Include all DocBook-to-manpage-related
                           commands here, and use it everywhere.
  (mandos.8, mandos.conf.5): New; also depend on "mandos-options.xml".

* mandos-keygen.xml: Removed OVERVIEW entity.  Add XInclude namespace.
  (OVERVIEW): Changed to do <xi:include/>.

* mandos-options.xml (<simplesect>): Changed to a <section>.
  ([@id="address"]): Reordered sentences.

* mandos.conf.xml (OPTIONS): Removed illegal <arg> tags.
  (EXAMPLE): Added empty example.

* mandos.xml (NETWORK PROTOCOL): Bug fix: Changed "1\r\en" back to
                                 "1\r\n".
  (CHECKING): Do not refer to the non-relevant mandos.conf(5) manual.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos.conf.xml
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 "2016-02-28">
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>
21
19
        <surname>Påhlsson</surname>
22
20
        <address>
23
 
          <email>belorn@recompile.se</email>
 
21
          <email>belorn@fukt.bsnet.se</email>
24
22
        </address>
25
23
      </author>
26
24
      <author>
27
25
        <firstname>Teddy</firstname>
28
26
        <surname>Hogeborn</surname>
29
27
        <address>
30
 
          <email>teddy@recompile.se</email>
 
28
          <email>teddy@fukt.bsnet.se</email>
31
29
        </address>
32
30
      </author>
33
31
    </authorgroup>
34
32
    <copyright>
35
33
      <year>2008</year>
36
 
      <year>2009</year>
37
 
      <year>2010</year>
38
 
      <year>2011</year>
39
 
      <year>2012</year>
40
 
      <year>2013</year>
41
 
      <year>2014</year>
42
 
      <year>2015</year>
43
 
      <year>2016</year>
44
34
      <holder>Teddy Hogeborn</holder>
45
35
      <holder>Björn Påhlsson</holder>
46
36
    </copyright>
47
 
    <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>
48
60
  </refentryinfo>
49
 
  
 
61
 
50
62
  <refmeta>
51
63
    <refentrytitle>&CONFNAME;</refentrytitle>
52
64
    <manvolnum>5</manvolnum>
58
70
      Configuration file for the Mandos server
59
71
    </refpurpose>
60
72
  </refnamediv>
61
 
  
 
73
 
62
74
  <refsynopsisdiv>
63
 
    <synopsis>&CONFPATH;</synopsis>
 
75
    <synopsis>
 
76
      &CONFPATH;
 
77
    </synopsis>
64
78
  </refsynopsisdiv>
65
 
  
 
79
 
66
80
  <refsect1 id="description">
67
81
    <title>DESCRIPTION</title>
68
82
    <para>
69
83
      The file &CONFPATH; is a simple configuration file for
70
84
      <citerefentry><refentrytitle>mandos</refentrytitle>
71
85
      <manvolnum>8</manvolnum></citerefentry>, and is read by it at
72
 
      startup.  The configuration file starts with <quote><literal
73
 
      >[DEFAULT]</literal></quote> on a line by itself, followed by
74
 
      any number of <quote><varname><replaceable>option</replaceable
75
 
      ></varname>=<replaceable>value</replaceable></quote> entries,
76
 
      with continuations in the style of RFC 822.  <quote><varname
77
 
      ><replaceable>option</replaceable></varname>: <replaceable
78
 
      >value</replaceable></quote> is also accepted.  Note that
79
 
      leading whitespace is removed from values.  Lines beginning with
80
 
      <quote>#</quote> or <quote>;</quote> are ignored and may be used
81
 
      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.
82
96
    </para>
83
 
    
 
97
 
84
98
  </refsect1>
85
99
  <refsect1>
86
100
    <title>OPTIONS</title>
87
101
    
88
102
    <variablelist>
89
103
      <varlistentry>
90
 
        <term><option>interface<literal> = </literal><replaceable
91
 
        >NAME</replaceable></option></term>
 
104
        <term><varname>interface</varname></term>
92
105
        <listitem>
 
106
          <synopsis><literal>interface = </literal><replaceable
 
107
          >IF</replaceable>
 
108
          </synopsis>
93
109
          <xi:include href="mandos-options.xml" xpointer="interface"/>
94
110
        </listitem>
95
111
      </varlistentry>
96
 
      
 
112
 
97
113
      <varlistentry>
98
 
        <term><option>address<literal> = </literal><replaceable
99
 
          >ADDRESS</replaceable></option></term>
 
114
        <term><varname>address</varname></term>
100
115
        <listitem>
 
116
          <synopsis><literal>address = </literal><replaceable
 
117
          >ADDRESS</replaceable>
 
118
          </synopsis>
101
119
          <xi:include href="mandos-options.xml" xpointer="address"/>
102
120
        </listitem>
103
121
      </varlistentry>
104
 
      
 
122
 
105
123
      <varlistentry>
106
 
        <term><option>port<literal> = </literal><replaceable
107
 
        >NUMBER</replaceable></option></term>
 
124
        <term><varname>port</varname></term>
108
125
        <listitem>
 
126
          <synopsis><literal>port = </literal><replaceable
 
127
          >PORT</replaceable>
 
128
          </synopsis>
109
129
          <xi:include href="mandos-options.xml" xpointer="port"/>
110
130
        </listitem>
111
131
      </varlistentry>
112
 
      
 
132
 
113
133
      <varlistentry>
114
 
        <term><option>debug<literal> = </literal>{ <literal
 
134
        <term><varname>debug</varname></term>
 
135
        <listitem>
 
136
          <synopsis><literal>debug = </literal>{ <literal
115
137
          >1</literal> | <literal>yes</literal> | <literal
116
138
          >true</literal> | <literal>on</literal> | <literal
117
139
          >0</literal> | <literal>no</literal> | <literal
118
 
          >false</literal> | <literal>off</literal> }</option></term>
119
 
        <listitem>
 
140
          >false</literal> | <literal>off</literal> }
 
141
          </synopsis>
120
142
          <xi:include href="mandos-options.xml" xpointer="debug"/>
121
143
        </listitem>
122
144
      </varlistentry>
123
 
      
 
145
 
124
146
      <varlistentry>
125
 
        <term><option>priority<literal> = </literal><replaceable
126
 
        >STRING</replaceable></option></term>
 
147
        <term><varname>priority</varname></term>
127
148
        <listitem>
 
149
          <synopsis><literal>priority = </literal><replaceable
 
150
          >PRIORITY</replaceable>
 
151
          </synopsis>
128
152
          <xi:include href="mandos-options.xml" xpointer="priority"/>
129
153
        </listitem>
130
154
      </varlistentry>
131
 
      
 
155
 
132
156
      <varlistentry>
133
 
        <term><option>servicename<literal> = </literal
134
 
        ><replaceable>NAME</replaceable></option></term>
 
157
        <term><varname>servicename</varname></term>
135
158
        <listitem>
 
159
          <synopsis><literal>servicename = </literal><replaceable
 
160
          >NAME</replaceable>
 
161
          </synopsis>
136
162
          <xi:include href="mandos-options.xml"
137
163
                      xpointer="servicename"/>
138
164
        </listitem>
139
165
      </varlistentry>
140
166
      
141
 
      <varlistentry>
142
 
        <term><option>use_dbus<literal> = </literal>{ <literal
143
 
          >1</literal> | <literal>yes</literal> | <literal
144
 
          >true</literal> | <literal>on</literal> | <literal
145
 
          >0</literal> | <literal>no</literal> | <literal
146
 
          >false</literal> | <literal>off</literal> }</option></term>
147
 
        <listitem>
148
 
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
149
 
        </listitem>
150
 
      </varlistentry>
151
 
      
152
 
      <varlistentry>
153
 
        <term><option>use_ipv6<literal> = </literal>{ <literal
154
 
          >1</literal> | <literal>yes</literal> | <literal
155
 
          >true</literal> | <literal>on</literal> | <literal
156
 
          >0</literal> | <literal>no</literal> | <literal
157
 
          >false</literal> | <literal>off</literal> }</option></term>
158
 
        <listitem>
159
 
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
160
 
        </listitem>
161
 
      </varlistentry>
162
 
      
163
 
      <varlistentry>
164
 
        <term><option>restore<literal> = </literal>{ <literal
165
 
          >1</literal> | <literal>yes</literal> | <literal
166
 
          >true</literal> | <literal>on</literal> | <literal
167
 
          >0</literal> | <literal>no</literal> | <literal
168
 
          >false</literal> | <literal>off</literal> }</option></term>
169
 
        <listitem>
170
 
          <xi:include href="mandos-options.xml" xpointer="restore"/>
171
 
        </listitem>
172
 
      </varlistentry>
173
 
      
174
 
      <varlistentry>
175
 
        <term><option>statedir<literal> = </literal><replaceable
176
 
        >DIRECTORY</replaceable></option></term>
177
 
        <listitem>
178
 
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
179
 
        </listitem>
180
 
      </varlistentry>
181
 
      
182
 
      <varlistentry>
183
 
        <term><option>socket<literal> = </literal><replaceable
184
 
        >NUMBER</replaceable></option></term>
185
 
        <listitem>
186
 
          <xi:include href="mandos-options.xml" xpointer="socket"/>
187
 
        </listitem>
188
 
      </varlistentry>
189
 
      
190
167
    </variablelist>
191
168
  </refsect1>
192
169
  
202
179
    <para>
203
180
      The <literal>[DEFAULT]</literal> is necessary because the Python
204
181
      built-in module <systemitem class="library">ConfigParser</systemitem>
205
 
      requires it.
 
182
      requres it.
206
183
    </para>
207
184
  </refsect1>
208
185
  
224
201
[DEFAULT]
225
202
# A configuration example
226
203
interface = eth0
227
 
address = fe80::aede:48ff:fe71:f6f2
 
204
address = 2001:db8:f983:bd0b:30de:ae4a:71f2:f672
228
205
port = 1025
229
 
debug = True
230
 
priority = SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA
 
206
debug = true
 
207
priority = SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP
231
208
servicename = Daena
232
 
use_dbus = False
233
 
use_ipv6 = True
234
 
restore = True
235
 
statedir = /var/lib/mandos
236
209
      </programlisting>
237
210
    </informalexample>
238
211
  </refsect1>
239
 
  
240
 
  <refsect1 id="see_also">
241
 
    <title>SEE ALSO</title>
242
 
    <para>
243
 
      <citerefentry><refentrytitle>intro</refentrytitle>
244
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
245
 
      <citerefentry><refentrytitle>gnutls_priority_init</refentrytitle
246
 
      ><manvolnum>3</manvolnum></citerefentry>,
247
 
      <citerefentry><refentrytitle>mandos</refentrytitle>
248
 
      <manvolnum>8</manvolnum></citerefentry>,
249
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
250
 
      <manvolnum>5</manvolnum></citerefentry>
251
 
    </para>
252
 
    
253
 
    <variablelist>
254
 
      <varlistentry>
255
 
        <term>
256
 
          RFC 4291: <citetitle>IP Version 6 Addressing
257
 
          Architecture</citetitle>
258
 
        </term>
259
 
        <listitem>
260
 
          <variablelist>
261
 
            <varlistentry>
262
 
              <term>Section 2.2: <citetitle>Text Representation of
263
 
              Addresses</citetitle></term>
264
 
              <listitem><para/></listitem>
265
 
            </varlistentry>
266
 
            <varlistentry>
267
 
              <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
268
 
              Address</citetitle></term>
269
 
              <listitem><para/></listitem>
270
 
            </varlistentry>
271
 
            <varlistentry>
272
 
            <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
273
 
            Addresses</citetitle></term>
274
 
            <listitem>
275
 
              <para>
276
 
                The clients use IPv6 link-local addresses, which are
277
 
                immediately usable since a link-local addresses is
278
 
                automatically assigned to a network interface when it
279
 
                is brought up.
280
 
              </para>
281
 
            </listitem>
282
 
            </varlistentry>
283
 
          </variablelist>
284
 
        </listitem>
285
 
      </varlistentry>
286
 
      <varlistentry>
287
 
        <term>
288
 
          <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
289
 
        </term>
290
 
        <listitem>
291
 
          <para>
292
 
            Zeroconf is the network protocol standard used by clients
293
 
            for finding the Mandos server on the local network.
294
 
          </para>
295
 
        </listitem>
296
 
      </varlistentry>
297
 
    </variablelist>
298
 
  </refsect1>
299
212
</refentry>
300
 
<!-- Local Variables: -->
301
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
302
 
<!-- time-stamp-end: "[\"']>" -->
303
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
304
 
<!-- End: -->