/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-09-03 19:37:07 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080903193707-sas85ud9r37ubs9r
* mandos-clients.conf.xml (OPTIONS): Add info to all options about
                                     whether it is a required or
                                     optional.

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">
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-31">
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
38
    <xi:include href="legalnotice.xml"/>
43
39
  </refentryinfo>
44
 
  
 
40
 
45
41
  <refmeta>
46
42
    <refentrytitle>&CONFNAME;</refentrytitle>
47
43
    <manvolnum>5</manvolnum>
53
49
      Configuration file for the Mandos server
54
50
    </refpurpose>
55
51
  </refnamediv>
56
 
  
 
52
 
57
53
  <refsynopsisdiv>
58
54
    <synopsis>&CONFPATH;</synopsis>
59
55
  </refsynopsisdiv>
60
 
  
 
56
 
61
57
  <refsect1 id="description">
62
58
    <title>DESCRIPTION</title>
63
59
    <para>
75
71
      <quote>#</quote> or <quote>;</quote> are ignored and may be used
76
72
      to provide comments.
77
73
    </para>
78
 
    
 
74
 
79
75
  </refsect1>
80
76
  <refsect1>
81
77
    <title>OPTIONS</title>
88
84
          <xi:include href="mandos-options.xml" xpointer="interface"/>
89
85
        </listitem>
90
86
      </varlistentry>
91
 
      
 
87
 
92
88
      <varlistentry>
93
89
        <term><option>address<literal> = </literal><replaceable
94
90
          >ADDRESS</replaceable></option></term>
96
92
          <xi:include href="mandos-options.xml" xpointer="address"/>
97
93
        </listitem>
98
94
      </varlistentry>
99
 
      
 
95
 
100
96
      <varlistentry>
101
97
        <term><option>port<literal> = </literal><replaceable
102
98
        >NUMBER</replaceable></option></term>
104
100
          <xi:include href="mandos-options.xml" xpointer="port"/>
105
101
        </listitem>
106
102
      </varlistentry>
107
 
      
 
103
 
108
104
      <varlistentry>
109
105
        <term><option>debug<literal> = </literal>{ <literal
110
106
          >1</literal> | <literal>yes</literal> | <literal
115
111
          <xi:include href="mandos-options.xml" xpointer="debug"/>
116
112
        </listitem>
117
113
      </varlistentry>
118
 
      
 
114
 
119
115
      <varlistentry>
120
116
        <term><option>priority<literal> = </literal><replaceable
121
117
        >STRING</replaceable></option></term>
123
119
          <xi:include href="mandos-options.xml" xpointer="priority"/>
124
120
        </listitem>
125
121
      </varlistentry>
126
 
      
 
122
 
127
123
      <varlistentry>
128
124
        <term><option>servicename<literal> = </literal
129
125
        ><replaceable>NAME</replaceable></option></term>
133
129
        </listitem>
134
130
      </varlistentry>
135
131
      
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
132
    </variablelist>
178
133
  </refsect1>
179
134
  
189
144
    <para>
190
145
      The <literal>[DEFAULT]</literal> is necessary because the Python
191
146
      built-in module <systemitem class="library">ConfigParser</systemitem>
192
 
      requires it.
 
147
      requres it.
193
148
    </para>
194
149
  </refsect1>
195
150
  
211
166
[DEFAULT]
212
167
# A configuration example
213
168
interface = eth0
214
 
address = fe80::aede:48ff:fe71:f6f2
 
169
address = 2001:db8:f983:bd0b:30de:ae4a:71f2:f672
215
170
port = 1025
216
171
debug = true
217
172
priority = SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP
218
173
servicename = Daena
219
 
use_dbus = False
220
 
use_ipv6 = True
221
 
restore = True
222
 
statedir = /var/lib/mandos
223
174
      </programlisting>
224
175
    </informalexample>
225
176
  </refsect1>
227
178
  <refsect1 id="see_also">
228
179
    <title>SEE ALSO</title>
229
180
    <para>
230
 
      <citerefentry><refentrytitle>intro</refentrytitle>
231
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
232
181
      <citerefentry><refentrytitle>gnutls_priority_init</refentrytitle
233
182
      ><manvolnum>3</manvolnum></citerefentry>,
234
183
      <citerefentry><refentrytitle>mandos</refentrytitle>
236
185
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
237
186
      <manvolnum>5</manvolnum></citerefentry>
238
187
    </para>
239
 
    
 
188
 
240
189
    <variablelist>
241
190
      <varlistentry>
242
191
        <term>
262
211
              <para>
263
212
                The clients use IPv6 link-local addresses, which are
264
213
                immediately usable since a link-local addresses is
265
 
                automatically assigned to a network interface when it
 
214
                automatically assigned to a network interfaces when it
266
215
                is brought up.
267
216
              </para>
268
217
            </listitem>