/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 17:16:33 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080830171633-rjyuhsemikw6lg2w
* mandos-keygen.xml (SYNOPSIS): Fixed tags.  Unify short and long
                                options.
* plugins.d/password-request.xml (SYNOPSIS): - '' -

* mandos-clients.conf.xml: Removed extra white space.
* plugin-runner.xml: - '' -
* plugins.d/password-prompt.xml: - '' -
* mandos-keygen.xml: - '' -
* plugins.d/password-request.xml: - '' -

Show diffs side-by-side

added added

removed removed

Lines of Context:
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 "2009-02-25">
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>
33
32
    </authorgroup>
34
33
    <copyright>
35
34
      <year>2008</year>
36
 
      <year>2009</year>
37
35
      <holder>Teddy Hogeborn</holder>
38
36
      <holder>Björn Påhlsson</holder>
39
37
    </copyright>
40
 
    <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>
41
61
  </refentryinfo>
42
 
  
 
62
 
43
63
  <refmeta>
44
64
    <refentrytitle>&CONFNAME;</refentrytitle>
45
65
    <manvolnum>5</manvolnum>
51
71
      Configuration file for the Mandos server
52
72
    </refpurpose>
53
73
  </refnamediv>
54
 
  
 
74
 
55
75
  <refsynopsisdiv>
56
 
    <synopsis>&CONFPATH;</synopsis>
 
76
    <synopsis>
 
77
      &CONFPATH;
 
78
    </synopsis>
57
79
  </refsynopsisdiv>
58
 
  
 
80
 
59
81
  <refsect1 id="description">
60
82
    <title>DESCRIPTION</title>
61
83
    <para>
73
95
      <quote>#</quote> or <quote>;</quote> are ignored and may be used
74
96
      to provide comments.
75
97
    </para>
76
 
    
 
98
 
77
99
  </refsect1>
78
100
  <refsect1>
79
101
    <title>OPTIONS</title>
80
102
    
81
103
    <variablelist>
82
104
      <varlistentry>
83
 
        <term><option>interface<literal> = </literal><replaceable
84
 
        >NAME</replaceable></option></term>
 
105
        <term><varname>interface</varname></term>
85
106
        <listitem>
 
107
          <synopsis><literal>interface = </literal><replaceable
 
108
          >NAME</replaceable>
 
109
          </synopsis>
86
110
          <xi:include href="mandos-options.xml" xpointer="interface"/>
87
111
        </listitem>
88
112
      </varlistentry>
89
 
      
 
113
 
90
114
      <varlistentry>
91
 
        <term><option>address<literal> = </literal><replaceable
92
 
          >ADDRESS</replaceable></option></term>
 
115
        <term><varname>address</varname></term>
93
116
        <listitem>
 
117
          <synopsis><literal>address = </literal><replaceable
 
118
          >ADDRESS</replaceable>
 
119
          </synopsis>
94
120
          <xi:include href="mandos-options.xml" xpointer="address"/>
95
121
        </listitem>
96
122
      </varlistentry>
97
 
      
 
123
 
98
124
      <varlistentry>
99
 
        <term><option>port<literal> = </literal><replaceable
100
 
        >NUMBER</replaceable></option></term>
 
125
        <term><varname>port</varname></term>
101
126
        <listitem>
 
127
          <synopsis><literal>port = </literal><replaceable
 
128
          >NUMBER</replaceable>
 
129
          </synopsis>
102
130
          <xi:include href="mandos-options.xml" xpointer="port"/>
103
131
        </listitem>
104
132
      </varlistentry>
105
 
      
 
133
 
106
134
      <varlistentry>
107
 
        <term><option>debug<literal> = </literal>{ <literal
 
135
        <term><varname>debug</varname></term>
 
136
        <listitem>
 
137
          <synopsis><literal>debug = </literal>{ <literal
108
138
          >1</literal> | <literal>yes</literal> | <literal
109
139
          >true</literal> | <literal>on</literal> | <literal
110
140
          >0</literal> | <literal>no</literal> | <literal
111
 
          >false</literal> | <literal>off</literal> }</option></term>
112
 
        <listitem>
 
141
          >false</literal> | <literal>off</literal> }
 
142
          </synopsis>
113
143
          <xi:include href="mandos-options.xml" xpointer="debug"/>
114
144
        </listitem>
115
145
      </varlistentry>
116
 
      
 
146
 
117
147
      <varlistentry>
118
 
        <term><option>priority<literal> = </literal><replaceable
119
 
        >STRING</replaceable></option></term>
 
148
        <term><varname>priority</varname></term>
120
149
        <listitem>
 
150
          <synopsis><literal>priority = </literal><replaceable
 
151
          >STRING</replaceable>
 
152
          </synopsis>
121
153
          <xi:include href="mandos-options.xml" xpointer="priority"/>
122
154
        </listitem>
123
155
      </varlistentry>
124
 
      
 
156
 
125
157
      <varlistentry>
126
 
        <term><option>servicename<literal> = </literal
127
 
        ><replaceable>NAME</replaceable></option></term>
 
158
        <term><varname>servicename</varname></term>
128
159
        <listitem>
 
160
          <synopsis><literal>servicename = </literal><replaceable
 
161
          >NAME</replaceable>
 
162
          </synopsis>
129
163
          <xi:include href="mandos-options.xml"
130
164
                      xpointer="servicename"/>
131
165
        </listitem>
132
166
      </varlistentry>
133
167
      
134
 
      <varlistentry>
135
 
        <term><option>use_dbus<literal> = </literal>{ <literal
136
 
          >1</literal> | <literal>yes</literal> | <literal
137
 
          >true</literal> | <literal>on</literal> | <literal
138
 
          >0</literal> | <literal>no</literal> | <literal
139
 
          >false</literal> | <literal>off</literal> }</option></term>
140
 
        <listitem>
141
 
          <xi:include href="mandos-options.xml" xpointer="dbus"/>
142
 
        </listitem>
143
 
      </varlistentry>
144
 
      
145
 
      <varlistentry>
146
 
        <term><option>use_ipv6<literal> = </literal>{ <literal
147
 
          >1</literal> | <literal>yes</literal> | <literal
148
 
          >true</literal> | <literal>on</literal> | <literal
149
 
          >0</literal> | <literal>no</literal> | <literal
150
 
          >false</literal> | <literal>off</literal> }</option></term>
151
 
        <listitem>
152
 
          <xi:include href="mandos-options.xml" xpointer="ipv6"/>
153
 
        </listitem>
154
 
      </varlistentry>
155
 
      
156
168
    </variablelist>
157
169
  </refsect1>
158
170
  
168
180
    <para>
169
181
      The <literal>[DEFAULT]</literal> is necessary because the Python
170
182
      built-in module <systemitem class="library">ConfigParser</systemitem>
171
 
      requires it.
 
183
      requres it.
172
184
    </para>
173
185
  </refsect1>
174
186
  
190
202
[DEFAULT]
191
203
# A configuration example
192
204
interface = eth0
193
 
address = fe80::aede:48ff:fe71:f6f2
 
205
address = 2001:db8:f983:bd0b:30de:ae4a:71f2:f672
194
206
port = 1025
195
207
debug = true
196
208
priority = SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP
197
209
servicename = Daena
198
 
use_dbus = False
199
 
use_ipv6 = True
200
210
      </programlisting>
201
211
    </informalexample>
202
212
  </refsect1>
211
221
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
212
222
      <manvolnum>5</manvolnum></citerefentry>
213
223
    </para>
214
 
    
 
224
 
215
225
    <variablelist>
216
226
      <varlistentry>
217
227
        <term>
237
247
              <para>
238
248
                The clients use IPv6 link-local addresses, which are
239
249
                immediately usable since a link-local addresses is
240
 
                automatically assigned to a network interface when it
 
250
                automatically assigned to a network interfaces when it
241
251
                is brought up.
242
252
              </para>
243
253
            </listitem>