/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.7.471 by Teddy Hogeborn
Update copyright year to 2018
6
<!ENTITY TIMESTAMP "2018-02-08">
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.326 by Teddy Hogeborn
Update copyright year.
37
      <year>2010</year>
237.7.41 by Teddy Hogeborn
* Makefile (DOCS): Added "intro.8mandos".
38
      <year>2011</year>
237.7.92 by Teddy Hogeborn
Updated year in copyright notices.
39
      <year>2012</year>
237.7.174 by Teddy Hogeborn
* Makefile (CFLAGS, LDFLAGS): Keep default flags from environment.
40
      <year>2013</year>
237.7.326 by Teddy Hogeborn
Update copyright year.
41
      <year>2014</year>
42
      <year>2015</year>
237.7.355 by Teddy Hogeborn
Update copyright year.
43
      <year>2016</year>
237.7.447 by Teddy Hogeborn
Update copyright year to 2017
44
      <year>2017</year>
237.7.471 by Teddy Hogeborn
Update copyright year to 2018
45
      <year>2018</year>
89 by Teddy Hogeborn
* Makefile: Bug fix: fixed creation of man pages for section 5 pages.
46
      <holder>Teddy Hogeborn</holder>
47
      <holder>Björn Påhlsson</holder>
24.1.23 by Björn Påhlsson
Added manual pages for:
48
    </copyright>
131 by Teddy Hogeborn
* Makefile: Make all DocBook rules include legalnotice.xml as a
49
    <xi:include href="legalnotice.xml"/>
24.1.23 by Björn Påhlsson
Added manual pages for:
50
  </refentryinfo>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
51
  
24.1.23 by Björn Påhlsson
Added manual pages for:
52
  <refmeta>
53
    <refentrytitle>&CONFNAME;</refentrytitle>
54
    <manvolnum>5</manvolnum>
55
  </refmeta>
56
  
57
  <refnamediv>
58
    <refname><filename>&CONFNAME;</filename></refname>
59
    <refpurpose>
89 by Teddy Hogeborn
* Makefile: Bug fix: fixed creation of man pages for section 5 pages.
60
      Configuration file for the Mandos server
24.1.23 by Björn Påhlsson
Added manual pages for:
61
    </refpurpose>
62
  </refnamediv>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
63
  
24.1.23 by Björn Påhlsson
Added manual pages for:
64
  <refsynopsisdiv>
119 by Teddy Hogeborn
* mandos-clients.conf.xml (SYNOPSIS): Remove line breaks.
65
    <synopsis>&CONFPATH;</synopsis>
24.1.23 by Björn Påhlsson
Added manual pages for:
66
  </refsynopsisdiv>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
67
  
24.1.23 by Björn Påhlsson
Added manual pages for:
68
  <refsect1 id="description">
69
    <title>DESCRIPTION</title>
70
    <para>
89 by Teddy Hogeborn
* Makefile: Bug fix: fixed creation of man pages for section 5 pages.
71
      The file &CONFPATH; is a simple configuration file for
72
      <citerefentry><refentrytitle>mandos</refentrytitle>
73
      <manvolnum>8</manvolnum></citerefentry>, and is read by it at
93 by Teddy Hogeborn
* mandos (string_to_delta): Accept a whitespace-separated sequence of
74
      startup.  The configuration file starts with <quote><literal
75
      >[DEFAULT]</literal></quote> on a line by itself, followed by
76
      any number of <quote><varname><replaceable>option</replaceable
77
      ></varname>=<replaceable>value</replaceable></quote> entries,
78
      with continuations in the style of RFC 822.  <quote><varname
79
      ><replaceable>option</replaceable></varname>: <replaceable
80
      >value</replaceable></quote> is also accepted.  Note that
81
      leading whitespace is removed from values.  Lines beginning with
82
      <quote>#</quote> or <quote>;</quote> are ignored and may be used
83
      to provide comments.
24.1.23 by Björn Påhlsson
Added manual pages for:
84
    </para>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
85
    
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
86
  </refsect1>
87
  <refsect1>
88
    <title>OPTIONS</title>
89
    
24.1.23 by Björn Påhlsson
Added manual pages for:
90
    <variablelist>
91
      <varlistentry>
119 by Teddy Hogeborn
* mandos-clients.conf.xml (SYNOPSIS): Remove line breaks.
92
	<term><option>interface<literal> = </literal><replaceable
93
	>NAME</replaceable></option></term>
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
94
	<listitem>
95
	  <xi:include href="mandos-options.xml" xpointer="interface"/>
96
	</listitem>
97
      </varlistentry>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
98
      
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
99
      <varlistentry>
119 by Teddy Hogeborn
* mandos-clients.conf.xml (SYNOPSIS): Remove line breaks.
100
	<term><option>address<literal> = </literal><replaceable
101
	  >ADDRESS</replaceable></option></term>
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
102
	<listitem>
103
	  <xi:include href="mandos-options.xml" xpointer="address"/>
104
	</listitem>
105
      </varlistentry>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
106
      
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
107
      <varlistentry>
119 by Teddy Hogeborn
* mandos-clients.conf.xml (SYNOPSIS): Remove line breaks.
108
	<term><option>port<literal> = </literal><replaceable
109
	>NUMBER</replaceable></option></term>
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
110
	<listitem>
111
	  <xi:include href="mandos-options.xml" xpointer="port"/>
112
	</listitem>
113
      </varlistentry>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
114
      
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
115
      <varlistentry>
119 by Teddy Hogeborn
* mandos-clients.conf.xml (SYNOPSIS): Remove line breaks.
116
	<term><option>debug<literal> = </literal>{ <literal
91 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Include all DocBook-to-manpage-related
117
	  >1</literal> | <literal>yes</literal> | <literal
118
	  >true</literal> | <literal>on</literal> | <literal
119
	  >0</literal> | <literal>no</literal> | <literal
119 by Teddy Hogeborn
* mandos-clients.conf.xml (SYNOPSIS): Remove line breaks.
120
	  >false</literal> | <literal>off</literal> }</option></term>
121
	<listitem>
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
122
	  <xi:include href="mandos-options.xml" xpointer="debug"/>
123
	</listitem>
124
      </varlistentry>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
125
      
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
126
      <varlistentry>
119 by Teddy Hogeborn
* mandos-clients.conf.xml (SYNOPSIS): Remove line breaks.
127
	<term><option>priority<literal> = </literal><replaceable
128
	>STRING</replaceable></option></term>
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
129
	<listitem>
237.7.325 by Teddy Hogeborn
Bug fix for GnuTLS 3: be compatible with old 2048-bit DSA keys.
130
	  <xi:include href="mandos-options.xml" xpointer="priority"/>
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
131
	</listitem>
132
      </varlistentry>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
133
      
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
134
      <varlistentry>
119 by Teddy Hogeborn
* mandos-clients.conf.xml (SYNOPSIS): Remove line breaks.
135
	<term><option>servicename<literal> = </literal
136
	><replaceable>NAME</replaceable></option></term>
91 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Include all DocBook-to-manpage-related
137
	<listitem>
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
138
	  <xi:include href="mandos-options.xml"
139
		      xpointer="servicename"/>
24.1.23 by Björn Påhlsson
Added manual pages for:
140
	</listitem>
141
      </varlistentry>
142
      
237.2.6 by Teddy Hogeborn
* mandos (Client.timeout, Client.interval): Changed from being a
143
      <varlistentry>
144
	<term><option>use_dbus<literal> = </literal>{ <literal
145
	  >1</literal> | <literal>yes</literal> | <literal
146
	  >true</literal> | <literal>on</literal> | <literal
147
	  >0</literal> | <literal>no</literal> | <literal
148
	  >false</literal> | <literal>off</literal> }</option></term>
149
	<listitem>
150
	  <xi:include href="mandos-options.xml" xpointer="dbus"/>
151
	</listitem>
152
      </varlistentry>
153
      
237.2.77 by Teddy Hogeborn
Support not using IPv6 in server:
154
      <varlistentry>
155
	<term><option>use_ipv6<literal> = </literal>{ <literal
156
	  >1</literal> | <literal>yes</literal> | <literal
157
	  >true</literal> | <literal>on</literal> | <literal
158
	  >0</literal> | <literal>no</literal> | <literal
159
	  >false</literal> | <literal>off</literal> }</option></term>
160
	<listitem>
161
	  <xi:include href="mandos-options.xml" xpointer="ipv6"/>
162
	</listitem>
163
      </varlistentry>
164
      
237.14.2 by Teddy Hogeborn
Directory with persistent state can now be changed with the "statedir"
165
      <varlistentry>
166
	<term><option>restore<literal> = </literal>{ <literal
167
	  >1</literal> | <literal>yes</literal> | <literal
168
	  >true</literal> | <literal>on</literal> | <literal
169
	  >0</literal> | <literal>no</literal> | <literal
170
	  >false</literal> | <literal>off</literal> }</option></term>
171
	<listitem>
172
	  <xi:include href="mandos-options.xml" xpointer="restore"/>
173
	</listitem>
174
      </varlistentry>
175
      
176
      <varlistentry>
177
	<term><option>statedir<literal> = </literal><replaceable
178
	>DIRECTORY</replaceable></option></term>
179
	<listitem>
180
	  <xi:include href="mandos-options.xml" xpointer="statedir"/>
181
	</listitem>
182
      </varlistentry>
183
      
237.21.1 by Teddy Hogeborn
* mandos: Implement "--socket" option.
184
      <varlistentry>
185
	<term><option>socket<literal> = </literal><replaceable
186
	>NUMBER</replaceable></option></term>
187
	<listitem>
188
	  <xi:include href="mandos-options.xml" xpointer="socket"/>
189
	</listitem>
190
      </varlistentry>
191
      
24.1.23 by Björn Påhlsson
Added manual pages for:
192
    </variablelist>
193
  </refsect1>
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
194
  
195
  <refsect1 id="files">
196
    <title>FILES</title>
197
    <para>
198
      The file described here is &CONFPATH;
199
    </para>
200
  </refsect1>
201
  
202
  <refsect1 id="bugs">
203
    <title>BUGS</title>
204
    <para>
205
      The <literal>[DEFAULT]</literal> is necessary because the Python
91 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Include all DocBook-to-manpage-related
206
      built-in module <systemitem class="library">ConfigParser</systemitem>
156 by Teddy Hogeborn
* mandos-clients.conf.xml (OPTIONS): Improved spelling.
207
      requires it.
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
208
    </para>
237.7.369 by Teddy Hogeborn
Add bug reporting information to manual pages
209
    <xi:include href="bugs.xml"/>
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
210
  </refsect1>
211
  
212
  <refsect1 id="example">
213
    <title>EXAMPLE</title>
24.1.23 by Björn Påhlsson
Added manual pages for:
214
    <informalexample>
91 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Include all DocBook-to-manpage-related
215
      <para>
216
	No options are actually required:
217
      </para>
218
      <programlisting>
219
[DEFAULT]
220
      </programlisting>
221
    </informalexample>
222
    <informalexample>
223
      <para>
224
	An example using all the options:
225
      </para>
24.1.23 by Björn Påhlsson
Added manual pages for:
226
      <programlisting>
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
227
[DEFAULT]
228
# A configuration example
229
interface = eth0
237.2.77 by Teddy Hogeborn
Support not using IPv6 in server:
230
address = fe80::aede:48ff:fe71:f6f2
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
231
port = 1025
237.7.292 by Teddy Hogeborn
Add "!RSA" also to examples/documentation.
232
debug = True
233
priority = SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA
91 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Include all DocBook-to-manpage-related
234
servicename = Daena
237.2.6 by Teddy Hogeborn
* mandos (Client.timeout, Client.interval): Changed from being a
235
use_dbus = False
237.2.77 by Teddy Hogeborn
Support not using IPv6 in server:
236
use_ipv6 = True
237.14.2 by Teddy Hogeborn
Directory with persistent state can now be changed with the "statedir"
237
restore = True
238
statedir = /var/lib/mandos
24.1.23 by Björn Påhlsson
Added manual pages for:
239
      </programlisting>
240
    </informalexample>
241
  </refsect1>
92 by Teddy Hogeborn
* mandos-keygen.xml (SEE ALSO): Remove "and".
242
  
243
  <refsect1 id="see_also">
244
    <title>SEE ALSO</title>
245
    <para>
237.7.41 by Teddy Hogeborn
* Makefile (DOCS): Added "intro.8mandos".
246
      <citerefentry><refentrytitle>intro</refentrytitle>
247
      <manvolnum>8mandos</manvolnum></citerefentry>,
114 by Teddy Hogeborn
* mandos-clients.conf.xml (SEE ALSO): Alphabetized, as per
248
      <citerefentry><refentrytitle>gnutls_priority_init</refentrytitle
249
      ><manvolnum>3</manvolnum></citerefentry>,
250
      <citerefentry><refentrytitle>mandos</refentrytitle>
251
      <manvolnum>8</manvolnum></citerefentry>,
252
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
253
      <manvolnum>5</manvolnum></citerefentry>
92 by Teddy Hogeborn
* mandos-keygen.xml (SEE ALSO): Remove "and".
254
    </para>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
255
    
108 by Teddy Hogeborn
* mandos-options.xml (address): Refer to IPv4-mapped IPv6 address
256
    <variablelist>
257
      <varlistentry>
258
	<term>
259
	  RFC 4291: <citetitle>IP Version 6 Addressing
260
	  Architecture</citetitle>
261
	</term>
262
	<listitem>
263
	  <variablelist>
264
	    <varlistentry>
265
	      <term>Section 2.2: <citetitle>Text Representation of
266
	      Addresses</citetitle></term>
267
	      <listitem><para/></listitem>
268
	    </varlistentry>
269
	    <varlistentry>
270
	      <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
271
	      Address</citetitle></term>
272
	      <listitem><para/></listitem>
273
	    </varlistentry>
274
	    <varlistentry>
275
	    <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
276
	    Addresses</citetitle></term>
277
	    <listitem>
278
	      <para>
279
		The clients use IPv6 link-local addresses, which are
280
		immediately usable since a link-local addresses is
237.2.86 by Teddy Hogeborn
* initramfs-tools-hook: Add missing terminating `" when setting
281
		automatically assigned to a network interface when it
108 by Teddy Hogeborn
* mandos-options.xml (address): Refer to IPv4-mapped IPv6 address
282
		is brought up.
283
	      </para>
284
	    </listitem>
285
	    </varlistentry>
286
	  </variablelist>
287
	</listitem>
288
      </varlistentry>
289
      <varlistentry>
290
	<term>
291
	  <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
292
	</term>
293
	<listitem>
294
	  <para>
295
	    Zeroconf is the network protocol standard used by clients
296
	    for finding the Mandos server on the local network.
297
	  </para>
298
	</listitem>
299
      </varlistentry>
300
    </variablelist>
92 by Teddy Hogeborn
* mandos-keygen.xml (SEE ALSO): Remove "and".
301
  </refsect1>
24.1.23 by Björn Påhlsson
Added manual pages for:
302
</refentry>
111 by Teddy Hogeborn
* mandos-clients.conf.xml (ENTITY TIMESTAMP): New. Automatically
303
<!-- Local Variables: -->
304
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
305
<!-- time-stamp-end: "[\"']>" -->
306
<!-- time-stamp-format: "%:y-%02m-%02d" -->
307
<!-- End: -->