/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-30 19:49:24 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080830194924-f4liqq8wxajlbshn
* plugin-runner.xml (NAME): Improved wording.
  (SYNOPSIS): Use <option> and <replaceable> tags.  Unify short and
              long options.  Add "--global-envs" and "--envs-for"
              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 "2016-03-05">
7
 
<!ENTITY % common SYSTEM "common.ent">
8
 
%common;
 
7
<!ENTITY TIMESTAMP "2008-08-30">
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>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
35
      <holder>Teddy Hogeborn</holder>
45
36
      <holder>Björn Påhlsson</holder>
46
37
    </copyright>
47
 
    <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>
48
61
  </refentryinfo>
49
 
  
 
62
 
50
63
  <refmeta>
51
64
    <refentrytitle>&CONFNAME;</refentrytitle>
52
65
    <manvolnum>5</manvolnum>
58
71
      Configuration file for the Mandos server
59
72
    </refpurpose>
60
73
  </refnamediv>
61
 
  
 
74
 
62
75
  <refsynopsisdiv>
63
76
    <synopsis>&CONFPATH;</synopsis>
64
77
  </refsynopsisdiv>
65
 
  
 
78
 
66
79
  <refsect1 id="description">
67
80
    <title>DESCRIPTION</title>
68
81
    <para>
80
93
      <quote>#</quote> or <quote>;</quote> are ignored and may be used
81
94
      to provide comments.
82
95
    </para>
83
 
    
 
96
 
84
97
  </refsect1>
85
98
  <refsect1>
86
99
    <title>OPTIONS</title>
93
106
          <xi:include href="mandos-options.xml" xpointer="interface"/>
94
107
        </listitem>
95
108
      </varlistentry>
96
 
      
 
109
 
97
110
      <varlistentry>
98
111
        <term><option>address<literal> = </literal><replaceable
99
112
          >ADDRESS</replaceable></option></term>
101
114
          <xi:include href="mandos-options.xml" xpointer="address"/>
102
115
        </listitem>
103
116
      </varlistentry>
104
 
      
 
117
 
105
118
      <varlistentry>
106
119
        <term><option>port<literal> = </literal><replaceable
107
120
        >NUMBER</replaceable></option></term>
109
122
          <xi:include href="mandos-options.xml" xpointer="port"/>
110
123
        </listitem>
111
124
      </varlistentry>
112
 
      
 
125
 
113
126
      <varlistentry>
114
127
        <term><option>debug<literal> = </literal>{ <literal
115
128
          >1</literal> | <literal>yes</literal> | <literal
120
133
          <xi:include href="mandos-options.xml" xpointer="debug"/>
121
134
        </listitem>
122
135
      </varlistentry>
123
 
      
 
136
 
124
137
      <varlistentry>
125
138
        <term><option>priority<literal> = </literal><replaceable
126
139
        >STRING</replaceable></option></term>
128
141
          <xi:include href="mandos-options.xml" xpointer="priority"/>
129
142
        </listitem>
130
143
      </varlistentry>
131
 
      
 
144
 
132
145
      <varlistentry>
133
146
        <term><option>servicename<literal> = </literal
134
147
        ><replaceable>NAME</replaceable></option></term>
138
151
        </listitem>
139
152
      </varlistentry>
140
153
      
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
154
    </variablelist>
191
155
  </refsect1>
192
156
  
202
166
    <para>
203
167
      The <literal>[DEFAULT]</literal> is necessary because the Python
204
168
      built-in module <systemitem class="library">ConfigParser</systemitem>
205
 
      requires it.
 
169
      requres it.
206
170
    </para>
207
 
    <xi:include href="bugs.xml"/>
208
171
  </refsect1>
209
172
  
210
173
  <refsect1 id="example">
225
188
[DEFAULT]
226
189
# A configuration example
227
190
interface = eth0
228
 
address = fe80::aede:48ff:fe71:f6f2
 
191
address = 2001:db8:f983:bd0b:30de:ae4a:71f2:f672
229
192
port = 1025
230
 
debug = True
231
 
priority = SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA
 
193
debug = true
 
194
priority = SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP
232
195
servicename = Daena
233
 
use_dbus = False
234
 
use_ipv6 = True
235
 
restore = True
236
 
statedir = /var/lib/mandos
237
196
      </programlisting>
238
197
    </informalexample>
239
198
  </refsect1>
241
200
  <refsect1 id="see_also">
242
201
    <title>SEE ALSO</title>
243
202
    <para>
244
 
      <citerefentry><refentrytitle>intro</refentrytitle>
245
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
246
203
      <citerefentry><refentrytitle>gnutls_priority_init</refentrytitle
247
204
      ><manvolnum>3</manvolnum></citerefentry>,
248
205
      <citerefentry><refentrytitle>mandos</refentrytitle>
250
207
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
251
208
      <manvolnum>5</manvolnum></citerefentry>
252
209
    </para>
253
 
    
 
210
 
254
211
    <variablelist>
255
212
      <varlistentry>
256
213
        <term>
276
233
              <para>
277
234
                The clients use IPv6 link-local addresses, which are
278
235
                immediately usable since a link-local addresses is
279
 
                automatically assigned to a network interface when it
 
236
                automatically assigned to a network interfaces when it
280
237
                is brought up.
281
238
              </para>
282
239
            </listitem>