/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-29 16:53:41 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080829165341-xzrp0xxxfrua5kzq
* mandos.xml (SYNOPSIS): Split <term> tags for the "--help" and
                         "--interface" options.

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 "2012-01-01">
7
 
<!ENTITY % common SYSTEM "common.ent">
8
 
%common;
 
7
<!ENTITY TIMESTAMP "2008-08-29">
9
8
]>
10
9
 
11
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
13
12
    <title>Mandos Manual</title>
14
13
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
15
14
    <productname>Mandos</productname>
16
 
    <productnumber>&version;</productnumber>
 
15
    <productnumber>&VERSION;</productnumber>
17
16
    <date>&TIMESTAMP;</date>
18
17
    <authorgroup>
19
18
      <author>
20
19
        <firstname>Björn</firstname>
21
20
        <surname>Påhlsson</surname>
22
21
        <address>
23
 
          <email>belorn@recompile.se</email>
 
22
          <email>belorn@fukt.bsnet.se</email>
24
23
        </address>
25
24
      </author>
26
25
      <author>
27
26
        <firstname>Teddy</firstname>
28
27
        <surname>Hogeborn</surname>
29
28
        <address>
30
 
          <email>teddy@recompile.se</email>
 
29
          <email>teddy@fukt.bsnet.se</email>
31
30
        </address>
32
31
      </author>
33
32
    </authorgroup>
34
33
    <copyright>
35
34
      <year>2008</year>
36
 
      <year>2009</year>
37
 
      <year>2011</year>
38
 
      <year>2012</year>
39
35
      <holder>Teddy Hogeborn</holder>
40
36
      <holder>Björn Påhlsson</holder>
41
37
    </copyright>
42
 
    <xi:include href="legalnotice.xml"/>
 
38
    <legalnotice>
 
39
      <para>
 
40
        This manual page is free software: you can redistribute it
 
41
        and/or modify it under the terms of the GNU General Public
 
42
        License as published by the Free Software Foundation,
 
43
        either version 3 of the License, or (at your option) any
 
44
        later version.
 
45
      </para>
 
46
 
 
47
      <para>
 
48
        This manual page is distributed in the hope that it will
 
49
        be useful, but WITHOUT ANY WARRANTY; without even the
 
50
        implied warranty of MERCHANTABILITY or FITNESS FOR A
 
51
        PARTICULAR PURPOSE.  See the GNU General Public License
 
52
        for more details.
 
53
      </para>
 
54
 
 
55
      <para>
 
56
        You should have received a copy of the GNU General Public
 
57
        License along with this program; If not, see
 
58
        <ulink url="http://www.gnu.org/licenses/"/>.
 
59
      </para>
 
60
    </legalnotice>
43
61
  </refentryinfo>
44
 
  
 
62
 
45
63
  <refmeta>
46
64
    <refentrytitle>&CONFNAME;</refentrytitle>
47
65
    <manvolnum>5</manvolnum>
53
71
      Configuration file for the Mandos server
54
72
    </refpurpose>
55
73
  </refnamediv>
56
 
  
 
74
 
57
75
  <refsynopsisdiv>
58
 
    <synopsis>&CONFPATH;</synopsis>
 
76
    <synopsis>
 
77
      &CONFPATH;
 
78
    </synopsis>
59
79
  </refsynopsisdiv>
60
 
  
 
80
 
61
81
  <refsect1 id="description">
62
82
    <title>DESCRIPTION</title>
63
83
    <para>
75
95
      <quote>#</quote> or <quote>;</quote> are ignored and may be used
76
96
      to provide comments.
77
97
    </para>
78
 
    
 
98
 
79
99
  </refsect1>
80
100
  <refsect1>
81
101
    <title>OPTIONS</title>
82
102
    
83
103
    <variablelist>
84
104
      <varlistentry>
85
 
        <term><option>interface<literal> = </literal><replaceable
86
 
        >NAME</replaceable></option></term>
 
105
        <term><varname>interface</varname></term>
87
106
        <listitem>
 
107
          <synopsis><literal>interface = </literal><replaceable
 
108
          >NAME</replaceable>
 
109
          </synopsis>
88
110
          <xi:include href="mandos-options.xml" xpointer="interface"/>
89
111
        </listitem>
90
112
      </varlistentry>
91
 
      
 
113
 
92
114
      <varlistentry>
93
 
        <term><option>address<literal> = </literal><replaceable
94
 
          >ADDRESS</replaceable></option></term>
 
115
        <term><varname>address</varname></term>
95
116
        <listitem>
 
117
          <synopsis><literal>address = </literal><replaceable
 
118
          >ADDRESS</replaceable>
 
119
          </synopsis>
96
120
          <xi:include href="mandos-options.xml" xpointer="address"/>
97
121
        </listitem>
98
122
      </varlistentry>
99
 
      
 
123
 
100
124
      <varlistentry>
101
 
        <term><option>port<literal> = </literal><replaceable
102
 
        >NUMBER</replaceable></option></term>
 
125
        <term><varname>port</varname></term>
103
126
        <listitem>
 
127
          <synopsis><literal>port = </literal><replaceable
 
128
          >NUMBER</replaceable>
 
129
          </synopsis>
104
130
          <xi:include href="mandos-options.xml" xpointer="port"/>
105
131
        </listitem>
106
132
      </varlistentry>
107
 
      
 
133
 
108
134
      <varlistentry>
109
 
        <term><option>debug<literal> = </literal>{ <literal
 
135
        <term><varname>debug</varname></term>
 
136
        <listitem>
 
137
          <synopsis><literal>debug = </literal>{ <literal
110
138
          >1</literal> | <literal>yes</literal> | <literal
111
139
          >true</literal> | <literal>on</literal> | <literal
112
140
          >0</literal> | <literal>no</literal> | <literal
113
 
          >false</literal> | <literal>off</literal> }</option></term>
114
 
        <listitem>
 
141
          >false</literal> | <literal>off</literal> }
 
142
          </synopsis>
115
143
          <xi:include href="mandos-options.xml" xpointer="debug"/>
116
144
        </listitem>
117
145
      </varlistentry>
118
 
      
 
146
 
119
147
      <varlistentry>
120
 
        <term><option>priority<literal> = </literal><replaceable
121
 
        >STRING</replaceable></option></term>
 
148
        <term><varname>priority</varname></term>
122
149
        <listitem>
 
150
          <synopsis><literal>priority = </literal><replaceable
 
151
          >STRING</replaceable>
 
152
          </synopsis>
123
153
          <xi:include href="mandos-options.xml" xpointer="priority"/>
124
154
        </listitem>
125
155
      </varlistentry>
126
 
      
 
156
 
127
157
      <varlistentry>
128
 
        <term><option>servicename<literal> = </literal
129
 
        ><replaceable>NAME</replaceable></option></term>
 
158
        <term><varname>servicename</varname></term>
130
159
        <listitem>
 
160
          <synopsis><literal>servicename = </literal><replaceable
 
161
          >NAME</replaceable>
 
162
          </synopsis>
131
163
          <xi:include href="mandos-options.xml"
132
164
                      xpointer="servicename"/>
133
165
        </listitem>
134
166
      </varlistentry>
135
167
      
136
 
      <varlistentry>
137
 
        <term><option>use_dbus<literal> = </literal>{ <literal
138
 
          >1</literal> | <literal>yes</literal> | <literal
139
 
          >true</literal> | <literal>on</literal> | <literal
140
 
          >0</literal> | <literal>no</literal> | <literal
141
 
          >false</literal> | <literal>off</literal> }</option></term>
142
 
        <listitem>
143
 
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
144
 
        </listitem>
145
 
      </varlistentry>
146
 
      
147
 
      <varlistentry>
148
 
        <term><option>use_ipv6<literal> = </literal>{ <literal
149
 
          >1</literal> | <literal>yes</literal> | <literal
150
 
          >true</literal> | <literal>on</literal> | <literal
151
 
          >0</literal> | <literal>no</literal> | <literal
152
 
          >false</literal> | <literal>off</literal> }</option></term>
153
 
        <listitem>
154
 
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
155
 
        </listitem>
156
 
      </varlistentry>
157
 
      
158
 
      <varlistentry>
159
 
        <term><option>restore<literal> = </literal>{ <literal
160
 
          >1</literal> | <literal>yes</literal> | <literal
161
 
          >true</literal> | <literal>on</literal> | <literal
162
 
          >0</literal> | <literal>no</literal> | <literal
163
 
          >false</literal> | <literal>off</literal> }</option></term>
164
 
        <listitem>
165
 
          <xi:include href="mandos-options.xml" xpointer="restore"/>
166
 
        </listitem>
167
 
      </varlistentry>
168
 
      
169
 
      <varlistentry>
170
 
        <term><option>statedir<literal> = </literal><replaceable
171
 
        >DIRECTORY</replaceable></option></term>
172
 
        <listitem>
173
 
          <xi:include href="mandos-options.xml" xpointer="statedir"/>
174
 
        </listitem>
175
 
      </varlistentry>
176
 
      
177
168
    </variablelist>
178
169
  </refsect1>
179
170
  
189
180
    <para>
190
181
      The <literal>[DEFAULT]</literal> is necessary because the Python
191
182
      built-in module <systemitem class="library">ConfigParser</systemitem>
192
 
      requires it.
 
183
      requres it.
193
184
    </para>
194
185
  </refsect1>
195
186
  
211
202
[DEFAULT]
212
203
# A configuration example
213
204
interface = eth0
214
 
address = fe80::aede:48ff:fe71:f6f2
 
205
address = 2001:db8:f983:bd0b:30de:ae4a:71f2:f672
215
206
port = 1025
216
207
debug = true
217
208
priority = SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP
218
209
servicename = Daena
219
 
use_dbus = False
220
 
use_ipv6 = True
221
 
restore = True
222
 
statedir = /var/lib/mandos
223
210
      </programlisting>
224
211
    </informalexample>
225
212
  </refsect1>
227
214
  <refsect1 id="see_also">
228
215
    <title>SEE ALSO</title>
229
216
    <para>
230
 
      <citerefentry><refentrytitle>intro</refentrytitle>
231
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
232
217
      <citerefentry><refentrytitle>gnutls_priority_init</refentrytitle
233
218
      ><manvolnum>3</manvolnum></citerefentry>,
234
219
      <citerefentry><refentrytitle>mandos</refentrytitle>
236
221
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
237
222
      <manvolnum>5</manvolnum></citerefentry>
238
223
    </para>
239
 
    
 
224
 
240
225
    <variablelist>
241
226
      <varlistentry>
242
227
        <term>
262
247
              <para>
263
248
                The clients use IPv6 link-local addresses, which are
264
249
                immediately usable since a link-local addresses is
265
 
                automatically assigned to a network interface when it
 
250
                automatically assigned to a network interfaces when it
266
251
                is brought up.
267
252
              </para>
268
253
            </listitem>