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