/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release
24.1.23 by Björn Påhlsson
Added manual pages for:
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>">
89 by Teddy Hogeborn
* Makefile: Bug fix: fixed creation of man pages for section 5 pages.
7
<!ENTITY OVERVIEW SYSTEM "overview.xml">
24.1.23 by Björn Påhlsson
Added manual pages for:
8
]>
9
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
24.1.23 by Björn Påhlsson
Added manual pages for:
11
  <refentryinfo>
12
    <title>&CONFNAME;</title>
89 by Teddy Hogeborn
* Makefile: Bug fix: fixed creation of man pages for section 5 pages.
13
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
24.1.23 by Björn Påhlsson
Added manual pages for:
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>
89 by Teddy Hogeborn
* Makefile: Bug fix: fixed creation of man pages for section 5 pages.
34
      <holder>Teddy Hogeborn</holder>
35
      <holder>Björn Påhlsson</holder>
24.1.23 by Björn Påhlsson
Added manual pages for:
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>
89 by Teddy Hogeborn
* Makefile: Bug fix: fixed creation of man pages for section 5 pages.
70
      Configuration file for the Mandos server
24.1.23 by Björn Påhlsson
Added manual pages for:
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>
89 by Teddy Hogeborn
* Makefile: Bug fix: fixed creation of man pages for section 5 pages.
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.
24.1.23 by Björn Påhlsson
Added manual pages for:
96
    </para>
97
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
98
  </refsect1>
99
  <refsect1>
100
    <title>OPTIONS</title>
101
    
24.1.23 by Björn Påhlsson
Added manual pages for:
102
    <variablelist>
103
      <varlistentry>
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
104
	<term><varname>interface</varname></term>
105
	<listitem>
106
	  <synopsis><literal>interface = </literal><arg
107
	  choice="plain"><replaceable>IF</replaceable></arg>
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><arg
117
	  choice="plain"><replaceable>ADDRESS</replaceable></arg>
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><arg
127
	  choice="plain"><replaceable>PORT</replaceable></arg>
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><group choice="req">
137
	    <arg choice="plain">1</arg>
138
	    <arg choice="plain">yes</arg>
139
	    <arg choice="plain">true</arg>
140
	    <arg choice="plain">on</arg>
141
	    <arg choice="plain">0</arg>
142
	    <arg choice="plain">no</arg>
143
	    <arg choice="plain">false</arg>
144
	    <arg choice="plain">off</arg>
145
	  </group>
146
	  </synopsis>
147
	  <xi:include href="mandos-options.xml" xpointer="debug"/>
148
	</listitem>
149
      </varlistentry>
150
151
      <varlistentry>
152
	<term><varname>priority</varname></term>
153
	<listitem>
154
	  <synopsis><literal>priority = </literal><arg
155
	  choice="plain"><replaceable>PRIORITY</replaceable></arg>
156
	  </synopsis>
157
	  <xi:include href="mandos-options.xml" xpointer="priority"/>
158
	</listitem>
159
      </varlistentry>
160
161
      <varlistentry>
162
	<term><varname>servicename</varname></term>
163
	  <synopsis><literal>servicename = </literal><arg
164
	  choice="plain"><replaceable>NAME</replaceable></arg>
165
	  </synopsis>
166
	<listitem>
167
	  <xi:include href="mandos-options.xml"
168
		      xpointer="servicename"/>
24.1.23 by Björn Påhlsson
Added manual pages for:
169
	</listitem>
170
      </varlistentry>
171
      
172
    </variablelist>
173
  </refsect1>
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
174
  
175
  <refsect1 id="files">
176
    <title>FILES</title>
177
    <para>
178
      The file described here is &CONFPATH;
179
    </para>
180
  </refsect1>
181
  
182
  <refsect1 id="bugs">
183
    <title>BUGS</title>
184
    <para>
185
      The <literal>[DEFAULT]</literal> is necessary because the Python
186
      module <systemitem class="library">ConfigParser</systemitem>
187
      requres it.
188
    </para>
189
  </refsect1>
190
  
191
  <refsect1 id="example">
192
    <title>EXAMPLE</title>
24.1.23 by Björn Påhlsson
Added manual pages for:
193
    <informalexample>
194
      <programlisting>
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
195
[DEFAULT]
196
# A configuration example
197
interface = eth0
198
address = 2001:db8:f983:bd0b:30de:ae4a:71f2:f672
199
port = 1025
200
debug = true
201
priority = SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP
202
servicename = Mandos
24.1.23 by Björn Påhlsson
Added manual pages for:
203
      </programlisting>
204
    </informalexample>
205
  </refsect1>
206
</refentry>