/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

merge +
mandosclient
        Added a adjustbuffer function.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos.conf.xml
1
 
<?xml version='1.0' encoding='UTF-8'?>
2
 
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
 
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
 
<!ENTITY VERSION "1.0">
5
 
<!ENTITY CONFNAME "mandos.conf">
6
 
<!ENTITY CONFPATH "<filename>/etc/mandos/mandos.conf</filename>">
7
 
<!ENTITY OVERVIEW SYSTEM "overview.xml">
8
 
]>
9
 
 
10
 
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
 
  <refentryinfo>
12
 
    <title>&CONFNAME;</title>
13
 
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
 
    <productname>&CONFNAME;</productname>
15
 
    <productnumber>&VERSION;</productnumber>
16
 
    <authorgroup>
17
 
      <author>
18
 
        <firstname>Björn</firstname>
19
 
        <surname>Påhlsson</surname>
20
 
        <address>
21
 
          <email>belorn@fukt.bsnet.se</email>
22
 
        </address>
23
 
      </author>
24
 
      <author>
25
 
        <firstname>Teddy</firstname>
26
 
        <surname>Hogeborn</surname>
27
 
        <address>
28
 
          <email>teddy@fukt.bsnet.se</email>
29
 
        </address>
30
 
      </author>
31
 
    </authorgroup>
32
 
    <copyright>
33
 
      <year>2008</year>
34
 
      <holder>Teddy Hogeborn</holder>
35
 
      <holder>Björn Påhlsson</holder>
36
 
    </copyright>
37
 
    <legalnotice>
38
 
      <para>
39
 
        This manual page is free software: you can redistribute it
40
 
        and/or modify it under the terms of the GNU General Public
41
 
        License as published by the Free Software Foundation,
42
 
        either version 3 of the License, or (at your option) any
43
 
        later version.
44
 
      </para>
45
 
 
46
 
      <para>
47
 
        This manual page is distributed in the hope that it will
48
 
        be useful, but WITHOUT ANY WARRANTY; without even the
49
 
        implied warranty of MERCHANTABILITY or FITNESS FOR A
50
 
        PARTICULAR PURPOSE.  See the GNU General Public License
51
 
        for more details.
52
 
      </para>
53
 
 
54
 
      <para>
55
 
        You should have received a copy of the GNU General Public
56
 
        License along with this program; If not, see
57
 
        <ulink url="http://www.gnu.org/licenses/"/>.
58
 
      </para>
59
 
    </legalnotice>
60
 
  </refentryinfo>
61
 
 
62
 
  <refmeta>
63
 
    <refentrytitle>&CONFNAME;</refentrytitle>
64
 
    <manvolnum>5</manvolnum>
65
 
  </refmeta>
66
 
  
67
 
  <refnamediv>
68
 
    <refname><filename>&CONFNAME;</filename></refname>
69
 
    <refpurpose>
70
 
      Configuration file for the Mandos server
71
 
    </refpurpose>
72
 
  </refnamediv>
73
 
 
74
 
  <refsynopsisdiv>
75
 
    <synopsis>
76
 
      &CONFPATH;
77
 
    </synopsis>
78
 
  </refsynopsisdiv>
79
 
 
80
 
  <refsect1 id="description">
81
 
    <title>DESCRIPTION</title>
82
 
    <para>
83
 
      The file &CONFPATH; is a simple configuration file for
84
 
      <citerefentry><refentrytitle>mandos</refentrytitle>
85
 
      <manvolnum>8</manvolnum></citerefentry>, and is read by it at
86
 
      startup.  The configuration file starts with
87
 
      <quote><literal>[DEFAULT]</literal></quote> on a line by itself,
88
 
      followed by any number of
89
 
      <quote><varname><replaceable>option</replaceable></varname>=<replaceable>value</replaceable></quote>
90
 
      entries, with continuations in the style of RFC 822.
91
 
      <quote><varname><replaceable>option</replaceable></varname>:
92
 
      <replaceable>value</replaceable></quote> is also accepted.  Note
93
 
      that leading whitespace is removed from values.  Lines beginning
94
 
      with <quote>#</quote> or <quote>;</quote> are ignored and may be
95
 
      used to provide comments.
96
 
    </para>
97
 
 
98
 
  </refsect1>
99
 
  <refsect1>
100
 
    <title>OPTIONS</title>
101
 
    
102
 
    <variablelist>
103
 
      <varlistentry>
104
 
        <term><varname>interface</varname></term>
105
 
        <listitem>
106
 
          <synopsis><literal>interface = </literal><replaceable
107
 
          >IF</replaceable>
108
 
          </synopsis>
109
 
          <xi:include href="mandos-options.xml" xpointer="interface"/>
110
 
        </listitem>
111
 
      </varlistentry>
112
 
 
113
 
      <varlistentry>
114
 
        <term><varname>address</varname></term>
115
 
        <listitem>
116
 
          <synopsis><literal>address = </literal><replaceable
117
 
          >ADDRESS</replaceable>
118
 
          </synopsis>
119
 
          <xi:include href="mandos-options.xml" xpointer="address"/>
120
 
        </listitem>
121
 
      </varlistentry>
122
 
 
123
 
      <varlistentry>
124
 
        <term><varname>port</varname></term>
125
 
        <listitem>
126
 
          <synopsis><literal>port = </literal><replaceable
127
 
          >PORT</replaceable>
128
 
          </synopsis>
129
 
          <xi:include href="mandos-options.xml" xpointer="port"/>
130
 
        </listitem>
131
 
      </varlistentry>
132
 
 
133
 
      <varlistentry>
134
 
        <term><varname>debug</varname></term>
135
 
        <listitem>
136
 
          <synopsis><literal>debug = </literal>{ <literal
137
 
          >1</literal> | <literal>yes</literal> | <literal
138
 
          >true</literal> | <literal>on</literal> | <literal
139
 
          >0</literal> | <literal>no</literal> | <literal
140
 
          >false</literal> | <literal>off</literal> }
141
 
          </synopsis>
142
 
          <xi:include href="mandos-options.xml" xpointer="debug"/>
143
 
        </listitem>
144
 
      </varlistentry>
145
 
 
146
 
      <varlistentry>
147
 
        <term><varname>priority</varname></term>
148
 
        <listitem>
149
 
          <synopsis><literal>priority = </literal><replaceable
150
 
          >PRIORITY</replaceable>
151
 
          </synopsis>
152
 
          <xi:include href="mandos-options.xml" xpointer="priority"/>
153
 
        </listitem>
154
 
      </varlistentry>
155
 
 
156
 
      <varlistentry>
157
 
        <term><varname>servicename</varname></term>
158
 
        <listitem>
159
 
          <synopsis><literal>servicename = </literal><replaceable
160
 
          >NAME</replaceable>
161
 
          </synopsis>
162
 
          <xi:include href="mandos-options.xml"
163
 
                      xpointer="servicename"/>
164
 
        </listitem>
165
 
      </varlistentry>
166
 
      
167
 
    </variablelist>
168
 
  </refsect1>
169
 
  
170
 
  <refsect1 id="files">
171
 
    <title>FILES</title>
172
 
    <para>
173
 
      The file described here is &CONFPATH;
174
 
    </para>
175
 
  </refsect1>
176
 
  
177
 
  <refsect1 id="bugs">
178
 
    <title>BUGS</title>
179
 
    <para>
180
 
      The <literal>[DEFAULT]</literal> is necessary because the Python
181
 
      built-in module <systemitem class="library">ConfigParser</systemitem>
182
 
      requres it.
183
 
    </para>
184
 
  </refsect1>
185
 
  
186
 
  <refsect1 id="example">
187
 
    <title>EXAMPLE</title>
188
 
    <informalexample>
189
 
      <para>
190
 
        No options are actually required:
191
 
      </para>
192
 
      <programlisting>
193
 
[DEFAULT]
194
 
      </programlisting>
195
 
    </informalexample>
196
 
    <informalexample>
197
 
      <para>
198
 
        An example using all the options:
199
 
      </para>
200
 
      <programlisting>
201
 
[DEFAULT]
202
 
# A configuration example
203
 
interface = eth0
204
 
address = 2001:db8:f983:bd0b:30de:ae4a:71f2:f672
205
 
port = 1025
206
 
debug = true
207
 
priority = SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP
208
 
servicename = Daena
209
 
      </programlisting>
210
 
    </informalexample>
211
 
  </refsect1>
212
 
</refentry>