/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: 2012-06-06 14:12:50 UTC
  • Revision ID: teddy@recompile.se-20120606141250-5zxn3syowzb4t437
* Makefile (DOCBOOKTOMAN): Don't show errors from "locale".

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos.conf.xml
1
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">
5
4
<!ENTITY CONFNAME "mandos.conf">
6
5
<!ENTITY CONFPATH "<filename>/etc/mandos/mandos.conf</filename>">
7
 
<!ENTITY TIMESTAMP "2008-08-31">
 
6
<!ENTITY TIMESTAMP "2012-05-26">
 
7
<!ENTITY % common SYSTEM "common.ent">
 
8
%common;
8
9
]>
9
10
 
10
11
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
12
13
    <title>Mandos Manual</title>
13
14
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
15
    <productname>Mandos</productname>
15
 
    <productnumber>&VERSION;</productnumber>
 
16
    <productnumber>&version;</productnumber>
16
17
    <date>&TIMESTAMP;</date>
17
18
    <authorgroup>
18
19
      <author>
19
20
        <firstname>Björn</firstname>
20
21
        <surname>Påhlsson</surname>
21
22
        <address>
22
 
          <email>belorn@fukt.bsnet.se</email>
 
23
          <email>belorn@recompile.se</email>
23
24
        </address>
24
25
      </author>
25
26
      <author>
26
27
        <firstname>Teddy</firstname>
27
28
        <surname>Hogeborn</surname>
28
29
        <address>
29
 
          <email>teddy@fukt.bsnet.se</email>
 
30
          <email>teddy@recompile.se</email>
30
31
        </address>
31
32
      </author>
32
33
    </authorgroup>
33
34
    <copyright>
34
35
      <year>2008</year>
 
36
      <year>2009</year>
 
37
      <year>2011</year>
 
38
      <year>2012</year>
35
39
      <holder>Teddy Hogeborn</holder>
36
40
      <holder>Björn Påhlsson</holder>
37
41
    </copyright>
38
42
    <xi:include href="legalnotice.xml"/>
39
43
  </refentryinfo>
40
 
 
 
44
  
41
45
  <refmeta>
42
46
    <refentrytitle>&CONFNAME;</refentrytitle>
43
47
    <manvolnum>5</manvolnum>
49
53
      Configuration file for the Mandos server
50
54
    </refpurpose>
51
55
  </refnamediv>
52
 
 
 
56
  
53
57
  <refsynopsisdiv>
54
58
    <synopsis>&CONFPATH;</synopsis>
55
59
  </refsynopsisdiv>
56
 
 
 
60
  
57
61
  <refsect1 id="description">
58
62
    <title>DESCRIPTION</title>
59
63
    <para>
71
75
      <quote>#</quote> or <quote>;</quote> are ignored and may be used
72
76
      to provide comments.
73
77
    </para>
74
 
 
 
78
    
75
79
  </refsect1>
76
80
  <refsect1>
77
81
    <title>OPTIONS</title>
84
88
          <xi:include href="mandos-options.xml" xpointer="interface"/>
85
89
        </listitem>
86
90
      </varlistentry>
87
 
 
 
91
      
88
92
      <varlistentry>
89
93
        <term><option>address<literal> = </literal><replaceable
90
94
          >ADDRESS</replaceable></option></term>
92
96
          <xi:include href="mandos-options.xml" xpointer="address"/>
93
97
        </listitem>
94
98
      </varlistentry>
95
 
 
 
99
      
96
100
      <varlistentry>
97
101
        <term><option>port<literal> = </literal><replaceable
98
102
        >NUMBER</replaceable></option></term>
100
104
          <xi:include href="mandos-options.xml" xpointer="port"/>
101
105
        </listitem>
102
106
      </varlistentry>
103
 
 
 
107
      
104
108
      <varlistentry>
105
109
        <term><option>debug<literal> = </literal>{ <literal
106
110
          >1</literal> | <literal>yes</literal> | <literal
111
115
          <xi:include href="mandos-options.xml" xpointer="debug"/>
112
116
        </listitem>
113
117
      </varlistentry>
114
 
 
 
118
      
115
119
      <varlistentry>
116
120
        <term><option>priority<literal> = </literal><replaceable
117
121
        >STRING</replaceable></option></term>
119
123
          <xi:include href="mandos-options.xml" xpointer="priority"/>
120
124
        </listitem>
121
125
      </varlistentry>
122
 
 
 
126
      
123
127
      <varlistentry>
124
128
        <term><option>servicename<literal> = </literal
125
129
        ><replaceable>NAME</replaceable></option></term>
129
133
        </listitem>
130
134
      </varlistentry>
131
135
      
 
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
      <varlistentry>
 
178
        <term><option>socket<literal> = </literal><replaceable
 
179
        >NUMBER</replaceable></option></term>
 
180
        <listitem>
 
181
          <xi:include href="mandos-options.xml" xpointer="socket"/>
 
182
        </listitem>
 
183
      </varlistentry>
 
184
      
132
185
    </variablelist>
133
186
  </refsect1>
134
187
  
144
197
    <para>
145
198
      The <literal>[DEFAULT]</literal> is necessary because the Python
146
199
      built-in module <systemitem class="library">ConfigParser</systemitem>
147
 
      requres it.
 
200
      requires it.
148
201
    </para>
149
202
  </refsect1>
150
203
  
166
219
[DEFAULT]
167
220
# A configuration example
168
221
interface = eth0
169
 
address = 2001:db8:f983:bd0b:30de:ae4a:71f2:f672
 
222
address = fe80::aede:48ff:fe71:f6f2
170
223
port = 1025
171
224
debug = true
172
225
priority = SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP
173
226
servicename = Daena
 
227
use_dbus = False
 
228
use_ipv6 = True
 
229
restore = True
 
230
statedir = /var/lib/mandos
174
231
      </programlisting>
175
232
    </informalexample>
176
233
  </refsect1>
178
235
  <refsect1 id="see_also">
179
236
    <title>SEE ALSO</title>
180
237
    <para>
 
238
      <citerefentry><refentrytitle>intro</refentrytitle>
 
239
      <manvolnum>8mandos</manvolnum></citerefentry>,
181
240
      <citerefentry><refentrytitle>gnutls_priority_init</refentrytitle
182
241
      ><manvolnum>3</manvolnum></citerefentry>,
183
242
      <citerefentry><refentrytitle>mandos</refentrytitle>
185
244
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
186
245
      <manvolnum>5</manvolnum></citerefentry>
187
246
    </para>
188
 
 
 
247
    
189
248
    <variablelist>
190
249
      <varlistentry>
191
250
        <term>
211
270
              <para>
212
271
                The clients use IPv6 link-local addresses, which are
213
272
                immediately usable since a link-local addresses is
214
 
                automatically assigned to a network interfaces when it
 
273
                automatically assigned to a network interface when it
215
274
                is brought up.
216
275
              </para>
217
276
            </listitem>