/mandos/trunk

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