/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release
129 by Teddy Hogeborn
* mandos-clients.conf.xml: Changed all single quotes to double quotes
1
<?xml version="1.0" encoding="UTF-8"?>
24.1.23 by Björn Påhlsson
Added manual pages for:
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 CONFNAME "mandos.conf">
5
<!ENTITY CONFPATH "<filename>/etc/mandos/mandos.conf</filename>">
237.21.1 by Teddy Hogeborn
* mandos: Implement "--socket" option.
6
<!ENTITY TIMESTAMP "2012-05-26">
217 by Teddy Hogeborn
* .bzrignore: Added "man" directory (created by "make install-html").
7
<!ENTITY % common SYSTEM "common.ent">
8
%common;
24.1.23 by Björn Påhlsson
Added manual pages for:
9
]>
10
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
11
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
24.1.23 by Björn Påhlsson
Added manual pages for:
12
  <refentryinfo>
112 by Teddy Hogeborn
* mandos-clients.conf.xml (/refentry/refentryinfo/title): Changed to
13
    <title>Mandos Manual</title>
89 by Teddy Hogeborn
* Makefile: Bug fix: fixed creation of man pages for section 5 pages.
14
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
112 by Teddy Hogeborn
* mandos-clients.conf.xml (/refentry/refentryinfo/title): Changed to
15
    <productname>Mandos</productname>
217 by Teddy Hogeborn
* .bzrignore: Added "man" directory (created by "make install-html").
16
    <productnumber>&version;</productnumber>
111 by Teddy Hogeborn
* mandos-clients.conf.xml (ENTITY TIMESTAMP): New. Automatically
17
    <date>&TIMESTAMP;</date>
24.1.23 by Björn Påhlsson
Added manual pages for:
18
    <authorgroup>
19
      <author>
20
	<firstname>Björn</firstname>
21
	<surname>Påhlsson</surname>
22
	<address>
237.11.2 by Teddy Hogeborn
Change "fukt.bsnet.se" to "recompile.se" throughout.
23
	  <email>belorn@recompile.se</email>
24.1.23 by Björn Påhlsson
Added manual pages for:
24
	</address>
25
      </author>
26
      <author>
27
	<firstname>Teddy</firstname>
28
	<surname>Hogeborn</surname>
29
	<address>
237.11.2 by Teddy Hogeborn
Change "fukt.bsnet.se" to "recompile.se" throughout.
30
	  <email>teddy@recompile.se</email>
24.1.23 by Björn Påhlsson
Added manual pages for:
31
	</address>
32
      </author>
33
    </authorgroup>
34
    <copyright>
35
      <year>2008</year>
237.2.9 by Teddy Hogeborn
* README: Update copyright year; add "2009".
36
      <year>2009</year>
237.7.41 by Teddy Hogeborn
* Makefile (DOCS): Added "intro.8mandos".
37
      <year>2011</year>
237.7.92 by Teddy Hogeborn
Updated year in copyright notices.
38
      <year>2012</year>
89 by Teddy Hogeborn
* Makefile: Bug fix: fixed creation of man pages for section 5 pages.
39
      <holder>Teddy Hogeborn</holder>
40
      <holder>Björn Påhlsson</holder>
24.1.23 by Björn Påhlsson
Added manual pages for:
41
    </copyright>
131 by Teddy Hogeborn
* Makefile: Make all DocBook rules include legalnotice.xml as a
42
    <xi:include href="legalnotice.xml"/>
24.1.23 by Björn Påhlsson
Added manual pages for:
43
  </refentryinfo>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
44
  
24.1.23 by Björn Påhlsson
Added manual pages for:
45
  <refmeta>
46
    <refentrytitle>&CONFNAME;</refentrytitle>
47
    <manvolnum>5</manvolnum>
48
  </refmeta>
49
  
50
  <refnamediv>
51
    <refname><filename>&CONFNAME;</filename></refname>
52
    <refpurpose>
89 by Teddy Hogeborn
* Makefile: Bug fix: fixed creation of man pages for section 5 pages.
53
      Configuration file for the Mandos server
24.1.23 by Björn Påhlsson
Added manual pages for:
54
    </refpurpose>
55
  </refnamediv>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
56
  
24.1.23 by Björn Påhlsson
Added manual pages for:
57
  <refsynopsisdiv>
119 by Teddy Hogeborn
* mandos-clients.conf.xml (SYNOPSIS): Remove line breaks.
58
    <synopsis>&CONFPATH;</synopsis>
24.1.23 by Björn Påhlsson
Added manual pages for:
59
  </refsynopsisdiv>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
60
  
24.1.23 by Björn Påhlsson
Added manual pages for:
61
  <refsect1 id="description">
62
    <title>DESCRIPTION</title>
63
    <para>
89 by Teddy Hogeborn
* Makefile: Bug fix: fixed creation of man pages for section 5 pages.
64
      The file &CONFPATH; is a simple configuration file for
65
      <citerefentry><refentrytitle>mandos</refentrytitle>
66
      <manvolnum>8</manvolnum></citerefentry>, and is read by it at
93 by Teddy Hogeborn
* mandos (string_to_delta): Accept a whitespace-separated sequence of
67
      startup.  The configuration file starts with <quote><literal
68
      >[DEFAULT]</literal></quote> on a line by itself, followed by
69
      any number of <quote><varname><replaceable>option</replaceable
70
      ></varname>=<replaceable>value</replaceable></quote> entries,
71
      with continuations in the style of RFC 822.  <quote><varname
72
      ><replaceable>option</replaceable></varname>: <replaceable
73
      >value</replaceable></quote> is also accepted.  Note that
74
      leading whitespace is removed from values.  Lines beginning with
75
      <quote>#</quote> or <quote>;</quote> are ignored and may be used
76
      to provide comments.
24.1.23 by Björn Påhlsson
Added manual pages for:
77
    </para>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
78
    
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
79
  </refsect1>
80
  <refsect1>
81
    <title>OPTIONS</title>
82
    
24.1.23 by Björn Påhlsson
Added manual pages for:
83
    <variablelist>
84
      <varlistentry>
119 by Teddy Hogeborn
* mandos-clients.conf.xml (SYNOPSIS): Remove line breaks.
85
	<term><option>interface<literal> = </literal><replaceable
86
	>NAME</replaceable></option></term>
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
87
	<listitem>
88
	  <xi:include href="mandos-options.xml" xpointer="interface"/>
89
	</listitem>
90
      </varlistentry>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
91
      
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
92
      <varlistentry>
119 by Teddy Hogeborn
* mandos-clients.conf.xml (SYNOPSIS): Remove line breaks.
93
	<term><option>address<literal> = </literal><replaceable
94
	  >ADDRESS</replaceable></option></term>
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
95
	<listitem>
96
	  <xi:include href="mandos-options.xml" xpointer="address"/>
97
	</listitem>
98
      </varlistentry>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
99
      
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
100
      <varlistentry>
119 by Teddy Hogeborn
* mandos-clients.conf.xml (SYNOPSIS): Remove line breaks.
101
	<term><option>port<literal> = </literal><replaceable
102
	>NUMBER</replaceable></option></term>
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
103
	<listitem>
104
	  <xi:include href="mandos-options.xml" xpointer="port"/>
105
	</listitem>
106
      </varlistentry>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
107
      
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
108
      <varlistentry>
119 by Teddy Hogeborn
* mandos-clients.conf.xml (SYNOPSIS): Remove line breaks.
109
	<term><option>debug<literal> = </literal>{ <literal
91 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Include all DocBook-to-manpage-related
110
	  >1</literal> | <literal>yes</literal> | <literal
111
	  >true</literal> | <literal>on</literal> | <literal
112
	  >0</literal> | <literal>no</literal> | <literal
119 by Teddy Hogeborn
* mandos-clients.conf.xml (SYNOPSIS): Remove line breaks.
113
	  >false</literal> | <literal>off</literal> }</option></term>
114
	<listitem>
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
115
	  <xi:include href="mandos-options.xml" xpointer="debug"/>
116
	</listitem>
117
      </varlistentry>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
118
      
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
119
      <varlistentry>
119 by Teddy Hogeborn
* mandos-clients.conf.xml (SYNOPSIS): Remove line breaks.
120
	<term><option>priority<literal> = </literal><replaceable
121
	>STRING</replaceable></option></term>
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
122
	<listitem>
123
	  <xi:include href="mandos-options.xml" xpointer="priority"/>
124
	</listitem>
125
      </varlistentry>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
126
      
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
127
      <varlistentry>
119 by Teddy Hogeborn
* mandos-clients.conf.xml (SYNOPSIS): Remove line breaks.
128
	<term><option>servicename<literal> = </literal
129
	><replaceable>NAME</replaceable></option></term>
91 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Include all DocBook-to-manpage-related
130
	<listitem>
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
131
	  <xi:include href="mandos-options.xml"
132
		      xpointer="servicename"/>
24.1.23 by Björn Påhlsson
Added manual pages for:
133
	</listitem>
134
      </varlistentry>
135
      
237.2.6 by Teddy Hogeborn
* mandos (Client.timeout, Client.interval): Changed from being a
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
      
237.2.77 by Teddy Hogeborn
Support not using IPv6 in server:
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
      
237.14.2 by Teddy Hogeborn
Directory with persistent state can now be changed with the "statedir"
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
      
237.21.1 by Teddy Hogeborn
* mandos: Implement "--socket" option.
177
      <varlistentry>
178
	<term><option>socket<literal> = </literal><replaceable
179
	>NUMBER</replaceable></option></term>
180
	<listitem>
181
	  <xi:include href="mandos-options.xml" xpointer="socket"/>
182
	</listitem>
183
      </varlistentry>
184
      
24.1.23 by Björn Påhlsson
Added manual pages for:
185
    </variablelist>
186
  </refsect1>
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
187
  
188
  <refsect1 id="files">
189
    <title>FILES</title>
190
    <para>
191
      The file described here is &CONFPATH;
192
    </para>
193
  </refsect1>
194
  
195
  <refsect1 id="bugs">
196
    <title>BUGS</title>
197
    <para>
198
      The <literal>[DEFAULT]</literal> is necessary because the Python
91 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Include all DocBook-to-manpage-related
199
      built-in module <systemitem class="library">ConfigParser</systemitem>
156 by Teddy Hogeborn
* mandos-clients.conf.xml (OPTIONS): Improved spelling.
200
      requires it.
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
201
    </para>
202
  </refsect1>
203
  
204
  <refsect1 id="example">
205
    <title>EXAMPLE</title>
24.1.23 by Björn Påhlsson
Added manual pages for:
206
    <informalexample>
91 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Include all DocBook-to-manpage-related
207
      <para>
208
	No options are actually required:
209
      </para>
210
      <programlisting>
211
[DEFAULT]
212
      </programlisting>
213
    </informalexample>
214
    <informalexample>
215
      <para>
216
	An example using all the options:
217
      </para>
24.1.23 by Björn Påhlsson
Added manual pages for:
218
      <programlisting>
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
219
[DEFAULT]
220
# A configuration example
221
interface = eth0
237.2.77 by Teddy Hogeborn
Support not using IPv6 in server:
222
address = fe80::aede:48ff:fe71:f6f2
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
223
port = 1025
224
debug = true
225
priority = SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP
91 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Include all DocBook-to-manpage-related
226
servicename = Daena
237.2.6 by Teddy Hogeborn
* mandos (Client.timeout, Client.interval): Changed from being a
227
use_dbus = False
237.2.77 by Teddy Hogeborn
Support not using IPv6 in server:
228
use_ipv6 = True
237.14.2 by Teddy Hogeborn
Directory with persistent state can now be changed with the "statedir"
229
restore = True
230
statedir = /var/lib/mandos
24.1.23 by Björn Påhlsson
Added manual pages for:
231
      </programlisting>
232
    </informalexample>
233
  </refsect1>
92 by Teddy Hogeborn
* mandos-keygen.xml (SEE ALSO): Remove "and".
234
  
235
  <refsect1 id="see_also">
236
    <title>SEE ALSO</title>
237
    <para>
237.7.41 by Teddy Hogeborn
* Makefile (DOCS): Added "intro.8mandos".
238
      <citerefentry><refentrytitle>intro</refentrytitle>
239
      <manvolnum>8mandos</manvolnum></citerefentry>,
114 by Teddy Hogeborn
* mandos-clients.conf.xml (SEE ALSO): Alphabetized, as per
240
      <citerefentry><refentrytitle>gnutls_priority_init</refentrytitle
241
      ><manvolnum>3</manvolnum></citerefentry>,
242
      <citerefentry><refentrytitle>mandos</refentrytitle>
243
      <manvolnum>8</manvolnum></citerefentry>,
244
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
245
      <manvolnum>5</manvolnum></citerefentry>
92 by Teddy Hogeborn
* mandos-keygen.xml (SEE ALSO): Remove "and".
246
    </para>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
247
    
108 by Teddy Hogeborn
* mandos-options.xml (address): Refer to IPv4-mapped IPv6 address
248
    <variablelist>
249
      <varlistentry>
250
	<term>
251
	  RFC 4291: <citetitle>IP Version 6 Addressing
252
	  Architecture</citetitle>
253
	</term>
254
	<listitem>
255
	  <variablelist>
256
	    <varlistentry>
257
	      <term>Section 2.2: <citetitle>Text Representation of
258
	      Addresses</citetitle></term>
259
	      <listitem><para/></listitem>
260
	    </varlistentry>
261
	    <varlistentry>
262
	      <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
263
	      Address</citetitle></term>
264
	      <listitem><para/></listitem>
265
	    </varlistentry>
266
	    <varlistentry>
267
	    <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
268
	    Addresses</citetitle></term>
269
	    <listitem>
270
	      <para>
271
		The clients use IPv6 link-local addresses, which are
272
		immediately usable since a link-local addresses is
237.2.86 by Teddy Hogeborn
* initramfs-tools-hook: Add missing terminating `" when setting
273
		automatically assigned to a network interface when it
108 by Teddy Hogeborn
* mandos-options.xml (address): Refer to IPv4-mapped IPv6 address
274
		is brought up.
275
	      </para>
276
	    </listitem>
277
	    </varlistentry>
278
	  </variablelist>
279
	</listitem>
280
      </varlistentry>
281
      <varlistentry>
282
	<term>
283
	  <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
284
	</term>
285
	<listitem>
286
	  <para>
287
	    Zeroconf is the network protocol standard used by clients
288
	    for finding the Mandos server on the local network.
289
	  </para>
290
	</listitem>
291
      </varlistentry>
292
    </variablelist>
92 by Teddy Hogeborn
* mandos-keygen.xml (SEE ALSO): Remove "and".
293
  </refsect1>
24.1.23 by Björn Påhlsson
Added manual pages for:
294
</refentry>
111 by Teddy Hogeborn
* mandos-clients.conf.xml (ENTITY TIMESTAMP): New. Automatically
295
<!-- Local Variables: -->
296
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
297
<!-- time-stamp-end: "[\"']>" -->
298
<!-- time-stamp-format: "%:y-%02m-%02d" -->
299
<!-- End: -->