/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release
84 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Use the local manpages/docbook.xsl file, do
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"
84 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Use the local manpages/docbook.xsl file, do
3
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
24.1.23 by Björn Påhlsson
Added manual pages for:
4
<!ENTITY COMMANDNAME "mandos">
237.7.174 by Teddy Hogeborn
* Makefile (CFLAGS, LDFLAGS): Keep default flags from environment.
5
<!ENTITY TIMESTAMP "2013-10-20">
217 by Teddy Hogeborn
* .bzrignore: Added "man" directory (created by "make install-html").
6
<!ENTITY % common SYSTEM "common.ent">
7
%common;
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">
217 by Teddy Hogeborn
* .bzrignore: Added "man" directory (created by "make install-html").
11
   <refentryinfo>
112 by Teddy Hogeborn
* mandos-clients.conf.xml (/refentry/refentryinfo/title): Changed to
12
    <title>Mandos Manual</title>
84 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Use the local manpages/docbook.xsl file, do
13
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
112 by Teddy Hogeborn
* mandos-clients.conf.xml (/refentry/refentryinfo/title): Changed to
14
    <productname>Mandos</productname>
217 by Teddy Hogeborn
* .bzrignore: Added "man" directory (created by "make install-html").
15
    <productnumber>&version;</productnumber>
111 by Teddy Hogeborn
* mandos-clients.conf.xml (ENTITY TIMESTAMP): New. Automatically
16
    <date>&TIMESTAMP;</date>
24.1.23 by Björn Påhlsson
Added manual pages for:
17
    <authorgroup>
18
      <author>
19
	<firstname>Björn</firstname>
20
	<surname>Påhlsson</surname>
21
	<address>
237.11.2 by Teddy Hogeborn
Change "fukt.bsnet.se" to "recompile.se" throughout.
22
	  <email>belorn@recompile.se</email>
24.1.23 by Björn Påhlsson
Added manual pages for:
23
	</address>
24
      </author>
25
      <author>
26
	<firstname>Teddy</firstname>
27
	<surname>Hogeborn</surname>
28
	<address>
237.11.2 by Teddy Hogeborn
Change "fukt.bsnet.se" to "recompile.se" throughout.
29
	  <email>teddy@recompile.se</email>
24.1.23 by Björn Påhlsson
Added manual pages for:
30
	</address>
31
      </author>
32
    </authorgroup>
33
    <copyright>
34
      <year>2008</year>
237.2.9 by Teddy Hogeborn
* README: Update copyright year; add "2009".
35
      <year>2009</year>
237.2.207 by Teddy Hogeborn
Update copyright year to "2010" wherever appropriate.
36
      <year>2010</year>
237.7.14 by Teddy Hogeborn
Update copyright year to "2011" wherever appropriate.
37
      <year>2011</year>
237.7.92 by Teddy Hogeborn
Updated year in copyright notices.
38
      <year>2012</year>
237.7.174 by Teddy Hogeborn
* Makefile (CFLAGS, LDFLAGS): Keep default flags from environment.
39
      <year>2013</year>
81 by Teddy Hogeborn
* Makefile (GNUTLS_CFLAGS, GNUTLS_LIBS, AVAHI_CFLAGS, AVAHI_LIBS,
40
      <holder>Teddy Hogeborn</holder>
41
      <holder>Björn Påhlsson</holder>
24.1.23 by Björn Påhlsson
Added manual pages for:
42
    </copyright>
131 by Teddy Hogeborn
* Makefile: Make all DocBook rules include legalnotice.xml as a
43
    <xi:include href="legalnotice.xml"/>
24.1.23 by Björn Påhlsson
Added manual pages for:
44
  </refentryinfo>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
45
  
24.1.23 by Björn Påhlsson
Added manual pages for:
46
  <refmeta>
47
    <refentrytitle>&COMMANDNAME;</refentrytitle>
24.1.24 by Björn Påhlsson
minor edits
48
    <manvolnum>8</manvolnum>
24.1.23 by Björn Påhlsson
Added manual pages for:
49
  </refmeta>
50
  
51
  <refnamediv>
52
    <refname><command>&COMMANDNAME;</command></refname>
53
    <refpurpose>
116 by Teddy Hogeborn
* mandos-options.xml (priority): Added <acronym> tags.
54
      Gives encrypted passwords to authenticated Mandos clients
24.1.23 by Björn Påhlsson
Added manual pages for:
55
    </refpurpose>
56
  </refnamediv>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
57
  
24.1.23 by Björn Påhlsson
Added manual pages for:
58
  <refsynopsisdiv>
59
    <cmdsynopsis>
60
      <command>&COMMANDNAME;</command>
120 by Teddy Hogeborn
* mandos.xml (SYNOPSIS): Use <option> and <replaceable> tags. Unify
61
      <group>
62
	<arg choice="plain"><option>--interface
63
	<replaceable>NAME</replaceable></option></arg>
64
	<arg choice="plain"><option>-i
65
	<replaceable>NAME</replaceable></option></arg>
66
      </group>
67
      <sbr/>
68
      <group>
69
	<arg choice="plain"><option>--address
70
	<replaceable>ADDRESS</replaceable></option></arg>
71
	<arg choice="plain"><option>-a
72
	<replaceable>ADDRESS</replaceable></option></arg>
73
      </group>
74
      <sbr/>
75
      <group>
76
	<arg choice="plain"><option>--port
77
	<replaceable>PORT</replaceable></option></arg>
78
	<arg choice="plain"><option>-p
79
	<replaceable>PORT</replaceable></option></arg>
80
      </group>
81
      <sbr/>
82
      <arg><option>--priority
83
      <replaceable>PRIORITY</replaceable></option></arg>
84
      <sbr/>
85
      <arg><option>--servicename
86
      <replaceable>NAME</replaceable></option></arg>
87
      <sbr/>
88
      <arg><option>--configdir
89
      <replaceable>DIRECTORY</replaceable></option></arg>
90
      <sbr/>
91
      <arg><option>--debug</option></arg>
237.2.34 by Teddy Hogeborn
Merge from release branch.
92
      <sbr/>
237.2.210 by teddy at bsnet
* mandos: Fixed "--help" output.
93
      <arg><option>--debuglevel
94
      <replaceable>LEVEL</replaceable></option></arg>
95
      <sbr/>
237.2.87 by Teddy Hogeborn
Merge from release branch.
96
      <arg><option>--no-dbus</option></arg>
97
      <sbr/>
237.2.77 by Teddy Hogeborn
Support not using IPv6 in server:
98
      <arg><option>--no-ipv6</option></arg>
237.12.1 by Björn Påhlsson
Persistent state: New feature. Client state is now stored when mandos
99
      <sbr/>
100
      <arg><option>--no-restore</option></arg>
237.14.2 by Teddy Hogeborn
Directory with persistent state can now be changed with the "statedir"
101
      <sbr/>
102
      <arg><option>--statedir
103
      <replaceable>DIRECTORY</replaceable></option></arg>
237.21.1 by Teddy Hogeborn
* mandos: Implement "--socket" option.
104
      <sbr/>
105
      <arg><option>--socket
106
      <replaceable>FD</replaceable></option></arg>
237.7.154 by Teddy Hogeborn
* mandos: New "--foreground" option.
107
      <sbr/>
108
      <arg><option>--foreground</option></arg>
85 by Teddy Hogeborn
* mandos.xml (SYNOPSIS): Removed unnecessary 'choice="opt"' from <arg>
109
    </cmdsynopsis>
110
    <cmdsynopsis>
111
      <command>&COMMANDNAME;</command>
112
      <group choice="req">
122 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Put long options before short.
113
	<arg choice="plain"><option>--help</option></arg>
120 by Teddy Hogeborn
* mandos.xml (SYNOPSIS): Use <option> and <replaceable> tags. Unify
114
	<arg choice="plain"><option>-h</option></arg>
85 by Teddy Hogeborn
* mandos.xml (SYNOPSIS): Removed unnecessary 'choice="opt"' from <arg>
115
      </group>
84 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Use the local manpages/docbook.xsl file, do
116
    </cmdsynopsis>
117
    <cmdsynopsis>
118
      <command>&COMMANDNAME;</command>
120 by Teddy Hogeborn
* mandos.xml (SYNOPSIS): Use <option> and <replaceable> tags. Unify
119
      <arg choice="plain"><option>--version</option></arg>
84 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Use the local manpages/docbook.xsl file, do
120
    </cmdsynopsis>
121
    <cmdsynopsis>
122
      <command>&COMMANDNAME;</command>
120 by Teddy Hogeborn
* mandos.xml (SYNOPSIS): Use <option> and <replaceable> tags. Unify
123
      <arg choice="plain"><option>--check</option></arg>
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
124
    </cmdsynopsis>
24.1.23 by Björn Påhlsson
Added manual pages for:
125
  </refsynopsisdiv>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
126
  
24.1.23 by Björn Påhlsson
Added manual pages for:
127
  <refsect1 id="description">
128
    <title>DESCRIPTION</title>
129
    <para>
81 by Teddy Hogeborn
* Makefile (GNUTLS_CFLAGS, GNUTLS_LIBS, AVAHI_CFLAGS, AVAHI_LIBS,
130
      <command>&COMMANDNAME;</command> is a server daemon which
131
      handles incoming request for passwords for a pre-defined list of
24.1.179 by Björn Påhlsson
New feature:
132
      client host computers. For an introduction, see
133
      <citerefentry><refentrytitle>intro</refentrytitle>
134
      <manvolnum>8mandos</manvolnum></citerefentry>. The Mandos server
135
      uses Zeroconf to announce itself on the local network, and uses
136
      TLS to communicate securely with and to authenticate the
137
      clients.  The Mandos server uses IPv6 to allow Mandos clients to
138
      use IPv6 link-local addresses, since the clients will probably
139
      not have any other addresses configured (see <xref
140
      linkend="overview"/>).  Any authenticated client is then given
141
      the stored pre-encrypted password for that specific client.
81 by Teddy Hogeborn
* Makefile (GNUTLS_CFLAGS, GNUTLS_LIBS, AVAHI_CFLAGS, AVAHI_LIBS,
142
    </para>
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
143
  </refsect1>
81 by Teddy Hogeborn
* Makefile (GNUTLS_CFLAGS, GNUTLS_LIBS, AVAHI_CFLAGS, AVAHI_LIBS,
144
  
145
  <refsect1 id="purpose">
146
    <title>PURPOSE</title>
147
    <para>
148
      The purpose of this is to enable <emphasis>remote and unattended
84 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Use the local manpages/docbook.xsl file, do
149
      rebooting</emphasis> of client host computer with an
150
      <emphasis>encrypted root file system</emphasis>.  See <xref
151
      linkend="overview"/> for details.
81 by Teddy Hogeborn
* Makefile (GNUTLS_CFLAGS, GNUTLS_LIBS, AVAHI_CFLAGS, AVAHI_LIBS,
152
    </para>
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
153
  </refsect1>
24.1.55 by Björn Påhlsson
updated some partial manual pages
154
  
155
  <refsect1 id="options">
156
    <title>OPTIONS</title>
24.1.23 by Björn Påhlsson
Added manual pages for:
157
    <variablelist>
158
      <varlistentry>
124 by Teddy Hogeborn
* mandos.xml (OPTIONS): Moved long options before short. Use <option>
159
	<term><option>--help</option></term>
115 by Teddy Hogeborn
* mandos.xml (SYNOPSIS): Split <term> tags for the "--help" and
160
	<term><option>-h</option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
161
	<listitem>
162
	  <para>
81 by Teddy Hogeborn
* Makefile (GNUTLS_CFLAGS, GNUTLS_LIBS, AVAHI_CFLAGS, AVAHI_LIBS,
163
	    Show a help message and exit
24.1.23 by Björn Påhlsson
Added manual pages for:
164
	  </para>
165
	</listitem>
166
      </varlistentry>
124 by Teddy Hogeborn
* mandos.xml (OPTIONS): Moved long options before short. Use <option>
167
      
24.1.23 by Björn Påhlsson
Added manual pages for:
168
      <varlistentry>
124 by Teddy Hogeborn
* mandos.xml (OPTIONS): Moved long options before short. Use <option>
169
	<term><option>--interface</option>
170
	<replaceable>NAME</replaceable></term>
115 by Teddy Hogeborn
* mandos.xml (SYNOPSIS): Split <term> tags for the "--help" and
171
	<term><option>-i</option>
172
	<replaceable>NAME</replaceable></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
173
	<listitem>
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
174
	  <xi:include href="mandos-options.xml" xpointer="interface"/>
24.1.23 by Björn Påhlsson
Added manual pages for:
175
	</listitem>
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
176
      </varlistentry>
124 by Teddy Hogeborn
* mandos.xml (OPTIONS): Moved long options before short. Use <option>
177
      
24.1.23 by Björn Påhlsson
Added manual pages for:
178
      <varlistentry>
124 by Teddy Hogeborn
* mandos.xml (OPTIONS): Moved long options before short. Use <option>
179
	<term><option>--address
180
	<replaceable>ADDRESS</replaceable></option></term>
181
	<term><option>-a
182
	<replaceable>ADDRESS</replaceable></option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
183
	<listitem>
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
184
	  <xi:include href="mandos-options.xml" xpointer="address"/>
24.1.23 by Björn Påhlsson
Added manual pages for:
185
	</listitem>
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
186
      </varlistentry>
124 by Teddy Hogeborn
* mandos.xml (OPTIONS): Moved long options before short. Use <option>
187
      
24.1.23 by Björn Påhlsson
Added manual pages for:
188
      <varlistentry>
124 by Teddy Hogeborn
* mandos.xml (OPTIONS): Moved long options before short. Use <option>
189
	<term><option>--port
190
	<replaceable>PORT</replaceable></option></term>
191
	<term><option>-p
192
	<replaceable>PORT</replaceable></option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
193
	<listitem>
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
194
	  <xi:include href="mandos-options.xml" xpointer="port"/>
24.1.23 by Björn Påhlsson
Added manual pages for:
195
	</listitem>
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
196
      </varlistentry>
124 by Teddy Hogeborn
* mandos.xml (OPTIONS): Moved long options before short. Use <option>
197
      
24.1.23 by Björn Påhlsson
Added manual pages for:
198
      <varlistentry>
124 by Teddy Hogeborn
* mandos.xml (OPTIONS): Moved long options before short. Use <option>
199
	<term><option>--check</option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
200
	<listitem>
201
	  <para>
84 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Use the local manpages/docbook.xsl file, do
202
	    Run the server’s self-tests.  This includes any unit
81 by Teddy Hogeborn
* Makefile (GNUTLS_CFLAGS, GNUTLS_LIBS, AVAHI_CFLAGS, AVAHI_LIBS,
203
	    tests, etc.
24.1.23 by Björn Påhlsson
Added manual pages for:
204
	  </para>
205
	</listitem>
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
206
      </varlistentry>
124 by Teddy Hogeborn
* mandos.xml (OPTIONS): Moved long options before short. Use <option>
207
      
24.1.23 by Björn Påhlsson
Added manual pages for:
208
      <varlistentry>
124 by Teddy Hogeborn
* mandos.xml (OPTIONS): Moved long options before short. Use <option>
209
	<term><option>--debug</option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
210
	<listitem>
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
211
	  <xi:include href="mandos-options.xml" xpointer="debug"/>
24.1.23 by Björn Påhlsson
Added manual pages for:
212
	</listitem>
213
      </varlistentry>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
214
      
24.1.23 by Björn Påhlsson
Added manual pages for:
215
      <varlistentry>
237.2.210 by teddy at bsnet
* mandos: Fixed "--help" output.
216
	<term><option>--debuglevel
217
	<replaceable>LEVEL</replaceable></option></term>
218
	<listitem>
219
	  <para>
220
	    Set the debugging log level.
221
	    <replaceable>LEVEL</replaceable> is a string, one of
222
	    <quote><literal>CRITICAL</literal></quote>,
223
	    <quote><literal>ERROR</literal></quote>,
224
	    <quote><literal>WARNING</literal></quote>,
225
	    <quote><literal>INFO</literal></quote>, or
226
	    <quote><literal>DEBUG</literal></quote>, in order of
227
	    increasing verbosity.  The default level is
228
	    <quote><literal>WARNING</literal></quote>.
229
	  </para>
230
	</listitem>
231
      </varlistentry>
232
      
233
      <varlistentry>
124 by Teddy Hogeborn
* mandos.xml (OPTIONS): Moved long options before short. Use <option>
234
	<term><option>--priority <replaceable>
235
	PRIORITY</replaceable></option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
236
	<listitem>
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
237
	  <xi:include href="mandos-options.xml" xpointer="priority"/>
24.1.23 by Björn Påhlsson
Added manual pages for:
238
	</listitem>
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
239
      </varlistentry>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
240
      
24.1.23 by Björn Påhlsson
Added manual pages for:
241
      <varlistentry>
124 by Teddy Hogeborn
* mandos.xml (OPTIONS): Moved long options before short. Use <option>
242
	<term><option>--servicename
243
	<replaceable>NAME</replaceable></option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
244
	<listitem>
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
245
	  <xi:include href="mandos-options.xml"
246
		      xpointer="servicename"/>
24.1.23 by Björn Påhlsson
Added manual pages for:
247
	</listitem>
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
248
      </varlistentry>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
249
      
24.1.23 by Björn Påhlsson
Added manual pages for:
250
      <varlistentry>
124 by Teddy Hogeborn
* mandos.xml (OPTIONS): Moved long options before short. Use <option>
251
	<term><option>--configdir
252
	<replaceable>DIRECTORY</replaceable></option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
253
	<listitem>
254
	  <para>
81 by Teddy Hogeborn
* Makefile (GNUTLS_CFLAGS, GNUTLS_LIBS, AVAHI_CFLAGS, AVAHI_LIBS,
255
	    Directory to search for configuration files.  Default is
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
256
	    <quote><literal>/etc/mandos</literal></quote>.  See
257
	    <citerefentry><refentrytitle>mandos.conf</refentrytitle>
81 by Teddy Hogeborn
* Makefile (GNUTLS_CFLAGS, GNUTLS_LIBS, AVAHI_CFLAGS, AVAHI_LIBS,
258
	    <manvolnum>5</manvolnum></citerefentry> and <citerefentry>
259
	    <refentrytitle>mandos-clients.conf</refentrytitle>
260
	    <manvolnum>5</manvolnum></citerefentry>.
24.1.23 by Björn Påhlsson
Added manual pages for:
261
	  </para>
262
	</listitem>
263
      </varlistentry>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
264
      
24.1.35 by Björn Påhlsson
version 1.0
265
      <varlistentry>
124 by Teddy Hogeborn
* mandos.xml (OPTIONS): Moved long options before short. Use <option>
266
	<term><option>--version</option></term>
24.1.35 by Björn Påhlsson
version 1.0
267
	<listitem>
268
	  <para>
81 by Teddy Hogeborn
* Makefile (GNUTLS_CFLAGS, GNUTLS_LIBS, AVAHI_CFLAGS, AVAHI_LIBS,
269
	    Prints the program version and exit.
24.1.35 by Björn Påhlsson
version 1.0
270
	  </para>
271
	</listitem>
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
272
      </varlistentry>
237.2.34 by Teddy Hogeborn
Merge from release branch.
273
      
274
      <varlistentry>
237.2.87 by Teddy Hogeborn
Merge from release branch.
275
	<term><option>--no-dbus</option></term>
276
	<listitem>
277
	  <xi:include href="mandos-options.xml" xpointer="dbus"/>
278
	  <para>
279
	    See also <xref linkend="dbus_interface"/>.
280
	  </para>
281
	</listitem>
282
      </varlistentry>
283
      
284
      <varlistentry>
237.2.77 by Teddy Hogeborn
Support not using IPv6 in server:
285
	<term><option>--no-ipv6</option></term>
286
	<listitem>
287
	  <xi:include href="mandos-options.xml" xpointer="ipv6"/>
288
	</listitem>
289
      </varlistentry>
237.12.1 by Björn Påhlsson
Persistent state: New feature. Client state is now stored when mandos
290
      
291
      <varlistentry>
292
	<term><option>--no-restore</option></term>
293
	<listitem>
294
	  <xi:include href="mandos-options.xml" xpointer="restore"/>
237.7.94 by Teddy Hogeborn
* debian/rules (binary-common): Exclude network-hooks.d from
295
	  <para>
296
	    See also <xref linkend="persistent_state"/>.
297
	  </para>
237.12.1 by Björn Påhlsson
Persistent state: New feature. Client state is now stored when mandos
298
	</listitem>
299
      </varlistentry>
237.14.2 by Teddy Hogeborn
Directory with persistent state can now be changed with the "statedir"
300
      
301
      <varlistentry>
302
	<term><option>--statedir
303
	<replaceable>DIRECTORY</replaceable></option></term>
304
	<listitem>
305
	  <xi:include href="mandos-options.xml" xpointer="statedir"/>
306
	</listitem>
307
      </varlistentry>
237.21.1 by Teddy Hogeborn
* mandos: Implement "--socket" option.
308
      
309
      <varlistentry>
310
	<term><option>--socket
311
	<replaceable>FD</replaceable></option></term>
312
	<listitem>
313
	  <xi:include href="mandos-options.xml" xpointer="socket"/>
314
	</listitem>
315
      </varlistentry>
316
      
237.7.154 by Teddy Hogeborn
* mandos: New "--foreground" option.
317
      <varlistentry>
318
	<term><option>--foreground</option></term>
319
	<listitem>
320
	  <xi:include href="mandos-options.xml"
321
		      xpointer="foreground"/>
322
	</listitem>
323
      </varlistentry>
324
      
24.1.23 by Björn Påhlsson
Added manual pages for:
325
    </variablelist>
326
  </refsect1>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
327
  
84 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Use the local manpages/docbook.xsl file, do
328
  <refsect1 id="overview">
329
    <title>OVERVIEW</title>
90 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Added "--xinclude".
330
    <xi:include href="overview.xml"/>
84 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Use the local manpages/docbook.xsl file, do
331
    <para>
332
      This program is the server part.  It is a normal server program
333
      and will run in a normal system environment, not in an initial
134 by Teddy Hogeborn
* mandos.xml: Enclose "RAM" with <acronym>.
334
      <acronym>RAM</acronym> disk environment.
84 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Use the local manpages/docbook.xsl file, do
335
    </para>
336
  </refsect1>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
337
  
81 by Teddy Hogeborn
* Makefile (GNUTLS_CFLAGS, GNUTLS_LIBS, AVAHI_CFLAGS, AVAHI_LIBS,
338
  <refsect1 id="protocol">
339
    <title>NETWORK PROTOCOL</title>
340
    <para>
341
      The Mandos server announces itself as a Zeroconf service of type
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
342
      <quote><literal>_mandos._tcp</literal></quote>.  The Mandos
343
      client connects to the announced address and port, and sends a
344
      line of text where the first whitespace-separated field is the
345
      protocol version, which currently is
346
      <quote><literal>1</literal></quote>.  The client and server then
347
      start a TLS protocol handshake with a slight quirk: the Mandos
348
      server program acts as a TLS <quote>client</quote> while the
349
      connecting Mandos client acts as a TLS <quote>server</quote>.
350
      The Mandos client must supply an OpenPGP certificate, and the
351
      fingerprint of this certificate is used by the Mandos server to
352
      look up (in a list read from <filename>clients.conf</filename>
353
      at start time) which binary blob to give the client.  No other
354
      authentication or authorization is done by the server.
81 by Teddy Hogeborn
* Makefile (GNUTLS_CFLAGS, GNUTLS_LIBS, AVAHI_CFLAGS, AVAHI_LIBS,
355
    </para>
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
356
    <table>
357
      <title>Mandos Protocol (Version 1)</title><tgroup cols="3"><thead>
81 by Teddy Hogeborn
* Makefile (GNUTLS_CFLAGS, GNUTLS_LIBS, AVAHI_CFLAGS, AVAHI_LIBS,
358
      <row>
359
	<entry>Mandos Client</entry>
360
	<entry>Direction</entry>
361
	<entry>Mandos Server</entry>
362
      </row>
363
      </thead><tbody>
364
      <row>
365
	<entry>Connect</entry>
366
	<entry>-><!-- &rarr; --></entry>
367
      </row>
368
      <row>
91 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Include all DocBook-to-manpage-related
369
	<entry><quote><literal>1\r\n</literal></quote></entry>
81 by Teddy Hogeborn
* Makefile (GNUTLS_CFLAGS, GNUTLS_LIBS, AVAHI_CFLAGS, AVAHI_LIBS,
370
	<entry>-><!-- &rarr; --></entry>
371
      </row>
372
      <row>
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
373
	<entry>TLS handshake <emphasis>as TLS <quote>server</quote>
374
	</emphasis></entry>
81 by Teddy Hogeborn
* Makefile (GNUTLS_CFLAGS, GNUTLS_LIBS, AVAHI_CFLAGS, AVAHI_LIBS,
375
	<entry>&lt;-><!-- &xharr; --></entry>
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
376
	<entry>TLS handshake <emphasis>as TLS <quote>client</quote>
377
	</emphasis></entry>
81 by Teddy Hogeborn
* Makefile (GNUTLS_CFLAGS, GNUTLS_LIBS, AVAHI_CFLAGS, AVAHI_LIBS,
378
      </row>
379
      <row>
380
	<entry>OpenPGP public key (part of TLS handshake)</entry>
381
	<entry>-><!-- &rarr; --></entry>
382
      </row>
383
      <row>
384
	<entry/>
385
	<entry>&lt;-<!-- &larr; --></entry>
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
386
	<entry>Binary blob (client will assume OpenPGP data)</entry>
81 by Teddy Hogeborn
* Makefile (GNUTLS_CFLAGS, GNUTLS_LIBS, AVAHI_CFLAGS, AVAHI_LIBS,
387
      </row>
388
      <row>
389
	<entry/>
390
	<entry>&lt;-<!-- &larr; --></entry>
391
	<entry>Close</entry>
392
      </row>
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
393
    </tbody></tgroup></table>
394
  </refsect1>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
395
  
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
396
  <refsect1 id="checking">
397
    <title>CHECKING</title>
398
    <para>
399
      The server will, by default, continually check that the clients
400
      are still up.  If a client has not been confirmed as being up
401
      for some time, the client is assumed to be compromised and is no
237.2.130 by Teddy Hogeborn
* init.d-mandos: Bug fix: Correct the LSB header.
402
      longer eligible to receive the encrypted password.  (Manual
403
      intervention is required to re-enable a client.)  The timeout,
24.1.179 by Björn Påhlsson
New feature:
404
      extended timeout, checker program, and interval between checks
405
      can be configured both globally and per client; see
406
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
237.7.106 by Teddy Hogeborn
* mandos.xml (CHECKING): Don't claim that a successful secret request
407
      <manvolnum>5</manvolnum></citerefentry>.
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
408
    </para>
81 by Teddy Hogeborn
* Makefile (GNUTLS_CFLAGS, GNUTLS_LIBS, AVAHI_CFLAGS, AVAHI_LIBS,
409
  </refsect1>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
410
  
237.2.203 by Teddy Hogeborn
* mandos.xml (APPROVAL): New section.
411
  <refsect1 id="approval">
412
    <title>APPROVAL</title>
413
    <para>
414
      The server can be configured to require manual approval for a
415
      client before it is sent its secret.  The delay to wait for such
416
      approval and the default action (approve or deny) can be
417
      configured both globally and per client; see <citerefentry>
418
      <refentrytitle>mandos-clients.conf</refentrytitle>
419
      <manvolnum>5</manvolnum></citerefentry>.  By default all clients
420
      will be approved immediately without delay.
421
    </para>
422
    <para>
423
      This can be used to deny a client its secret if not manually
424
      approved within a specified time.  It can also be used to make
425
      the server delay before giving a client its secret, allowing
426
      optional manual denying of this specific client.
427
    </para>
428
    
429
  </refsect1>
430
  
81 by Teddy Hogeborn
* Makefile (GNUTLS_CFLAGS, GNUTLS_LIBS, AVAHI_CFLAGS, AVAHI_LIBS,
431
  <refsect1 id="logging">
432
    <title>LOGGING</title>
433
    <para>
91 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Include all DocBook-to-manpage-related
434
      The server will send log message with various severity levels to
237.13.1 by teddy at bsnet
* plugins.d/mandos-client.c (SYNOPSIS, OPTIONS): Document
435
      <filename class="devicefile">/dev/log</filename>.  With the
81 by Teddy Hogeborn
* Makefile (GNUTLS_CFLAGS, GNUTLS_LIBS, AVAHI_CFLAGS, AVAHI_LIBS,
436
      <option>--debug</option> option, it will log even more messages,
437
      and also show them on the console.
438
    </para>
439
  </refsect1>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
440
  
237.7.94 by Teddy Hogeborn
* debian/rules (binary-common): Exclude network-hooks.d from
441
  <refsect1 id="persistent_state">
442
    <title>PERSISTENT STATE</title>
443
    <para>
444
      Client settings, initially read from
445
      <filename>clients.conf</filename>, are persistent across
446
      restarts, and run-time changes will override settings in
447
      <filename>clients.conf</filename>.  However, if a setting is
448
      <emphasis>changed</emphasis> (or a client added, or removed) in
449
      <filename>clients.conf</filename>, this will take precedence.
450
    </para>
451
  </refsect1>
452
  
237.2.87 by Teddy Hogeborn
Merge from release branch.
453
  <refsect1 id="dbus_interface">
454
    <title>D-BUS INTERFACE</title>
455
    <para>
456
      The server will by default provide a D-Bus system bus interface.
457
      This interface will only be accessible by the root user or a
237.2.186 by Teddy Hogeborn
Documentation changes:
458
      Mandos-specific user, if such a user exists.  For documentation
459
      of the D-Bus API, see the file <filename>DBUS-API</filename>.
237.2.87 by Teddy Hogeborn
Merge from release branch.
460
    </para>
461
  </refsect1>
462
  
24.1.55 by Björn Påhlsson
updated some partial manual pages
463
  <refsect1 id="exit_status">
464
    <title>EXIT STATUS</title>
465
    <para>
81 by Teddy Hogeborn
* Makefile (GNUTLS_CFLAGS, GNUTLS_LIBS, AVAHI_CFLAGS, AVAHI_LIBS,
466
      The server will exit with a non-zero exit status only when a
467
      critical error is encountered.
24.1.55 by Björn Påhlsson
updated some partial manual pages
468
    </para>
469
  </refsect1>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
470
  
85 by Teddy Hogeborn
* mandos.xml (SYNOPSIS): Removed unnecessary 'choice="opt"' from <arg>
471
  <refsect1 id="environment">
472
    <title>ENVIRONMENT</title>
473
    <variablelist>
474
      <varlistentry>
117 by Teddy Hogeborn
* mandos-keygen.xml (ENVIRONMENT): Replaced <varname> with <envar>.
475
	<term><envar>PATH</envar></term>
85 by Teddy Hogeborn
* mandos.xml (SYNOPSIS): Removed unnecessary 'choice="opt"' from <arg>
476
	<listitem>
477
	  <para>
478
	    To start the configured checker (see <xref
479
	    linkend="checking"/>), the server uses
480
	    <filename>/bin/sh</filename>, which in turn uses
481
	    <varname>PATH</varname> to search for matching commands if
482
	    an absolute path is not given.  See <citerefentry>
483
	    <refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum>
91 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Include all DocBook-to-manpage-related
484
	    </citerefentry>.
85 by Teddy Hogeborn
* mandos.xml (SYNOPSIS): Removed unnecessary 'choice="opt"' from <arg>
485
	  </para>
486
	</listitem>
487
      </varlistentry>
488
    </variablelist>
489
  </refsect1>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
490
  
224 by Teddy Hogeborn
* mandos-keygen.xml (FILES): Fixed id to be "files", not "file".
491
  <refsect1 id="files">
24.1.55 by Björn Påhlsson
updated some partial manual pages
492
    <title>FILES</title>
493
    <para>
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
494
      Use the <option>--configdir</option> option to change where
495
      <command>&COMMANDNAME;</command> looks for its configurations
496
      files.  The default file names are listed here.
24.1.55 by Björn Påhlsson
updated some partial manual pages
497
    </para>
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
498
    <variablelist>
499
      <varlistentry>
500
	<term><filename>/etc/mandos/mandos.conf</filename></term>
501
	<listitem>
502
	  <para>
503
	    Server-global settings.  See
504
	    <citerefentry><refentrytitle>mandos.conf</refentrytitle>
505
	    <manvolnum>5</manvolnum></citerefentry> for details.
506
	  </para>
507
	</listitem>
508
      </varlistentry>
509
      <varlistentry>
510
	<term><filename>/etc/mandos/clients.conf</filename></term>
511
	<listitem>
512
	  <para>
513
	    List of clients and client-specific settings.  See
514
	    <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
515
	    <manvolnum>5</manvolnum></citerefentry> for details.
516
	  </para>
517
	</listitem>
518
      </varlistentry>
519
      <varlistentry>
237.7.174 by Teddy Hogeborn
* Makefile (CFLAGS, LDFLAGS): Keep default flags from environment.
520
	<term><filename>/run/mandos.pid</filename></term>
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
521
	<listitem>
522
	  <para>
237.2.202 by Teddy Hogeborn
* mandos: Do not write pid file if --debug is passed.
523
	    The file containing the process id of the
524
	    <command>&COMMANDNAME;</command> process started last.
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
525
	  </para>
526
	</listitem>
527
      </varlistentry>
528
      <varlistentry>
237.13.1 by teddy at bsnet
* plugins.d/mandos-client.c (SYNOPSIS, OPTIONS): Document
529
	<term><filename class="devicefile">/dev/log</filename></term>
237.7.72 by Björn Påhlsson
Working persistant state
530
      </varlistentry>
531
      <varlistentry>
237.14.2 by Teddy Hogeborn
Directory with persistent state can now be changed with the "statedir"
532
	<term><filename
533
	class="directory">/var/lib/mandos</filename></term>
534
	<listitem>
535
	  <para>
536
	    Directory where persistent state will be saved.  Change
537
	    this with the <option>--statedir</option> option.  See
538
	    also the <option>--no-restore</option> option.
539
	  </para>
540
	</listitem>
541
      </varlistentry>
542
      <varlistentry>
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
543
	<term><filename>/dev/log</filename></term>
544
	<listitem>
545
	  <para>
546
	    The Unix domain socket to where local syslog messages are
547
	    sent.
548
	  </para>
549
	</listitem>
550
      </varlistentry>
85 by Teddy Hogeborn
* mandos.xml (SYNOPSIS): Removed unnecessary 'choice="opt"' from <arg>
551
      <varlistentry>
552
	<term><filename>/bin/sh</filename></term>
553
	<listitem>
554
	  <para>
555
	    This is used to start the configured checker command for
556
	    each client.  See <citerefentry>
557
	    <refentrytitle>mandos-clients.conf</refentrytitle>
558
	    <manvolnum>5</manvolnum></citerefentry> for details.
559
	  </para>
560
	</listitem>
561
      </varlistentry>
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
562
    </variablelist>
563
  </refsect1>
85 by Teddy Hogeborn
* mandos.xml (SYNOPSIS): Removed unnecessary 'choice="opt"' from <arg>
564
  
24.1.55 by Björn Påhlsson
updated some partial manual pages
565
  <refsect1 id="bugs">
566
    <title>BUGS</title>
567
    <para>
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
568
      This server might, on especially fatal errors, emit a Python
569
      backtrace.  This could be considered a feature.
24.1.55 by Björn Påhlsson
updated some partial manual pages
570
    </para>
85 by Teddy Hogeborn
* mandos.xml (SYNOPSIS): Removed unnecessary 'choice="opt"' from <arg>
571
    <para>
572
      There is no fine-grained control over logging and debug output.
573
    </para>
574
    <para>
149 by Teddy Hogeborn
* mandos-keygen.xml (BUGS): Commented out.
575
      This server does not check the expire time of clients’ OpenPGP
576
      keys.
577
    </para>
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
578
  </refsect1>
85 by Teddy Hogeborn
* mandos.xml (SYNOPSIS): Removed unnecessary 'choice="opt"' from <arg>
579
  
580
  <refsect1 id="example">
581
    <title>EXAMPLE</title>
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
582
    <informalexample>
583
      <para>
584
	Normal invocation needs no options:
585
      </para>
586
      <para>
110 by Teddy Hogeborn
* mandos.xml (EXAMPLE): Replaced all occurences of command name with
587
	<userinput>&COMMANDNAME;</userinput>
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
588
      </para>
589
    </informalexample>
590
    <informalexample>
591
      <para>
84 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Use the local manpages/docbook.xsl file, do
592
	Run the server in debug mode, read configuration files from
237.14.2 by Teddy Hogeborn
Directory with persistent state can now be changed with the "statedir"
593
	the <filename class="directory">~/mandos</filename> directory,
594
	and use the Zeroconf service name <quote>Test</quote> to not
595
	collide with any other official Mandos server on this host:
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
596
      </para>
597
      <para>
598
599
<!-- do not wrap this line -->
110 by Teddy Hogeborn
* mandos.xml (EXAMPLE): Replaced all occurences of command name with
600
<userinput>&COMMANDNAME; --debug --configdir ~/mandos --servicename Test</userinput>
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
601
602
      </para>
603
    </informalexample>
604
    <informalexample>
605
      <para>
606
	Run the server normally, but only listen to one interface and
607
	only on the link-local address on that interface:
608
      </para>
609
      <para>
610
611
<!-- do not wrap this line -->
110 by Teddy Hogeborn
* mandos.xml (EXAMPLE): Replaced all occurences of command name with
612
<userinput>&COMMANDNAME; --interface eth7 --address fe80::aede:48ff:fe71:f6f2</userinput>
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
613
614
      </para>
615
    </informalexample>
24.1.55 by Björn Påhlsson
updated some partial manual pages
616
  </refsect1>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
617
  
24.1.55 by Björn Påhlsson
updated some partial manual pages
618
  <refsect1 id="security">
619
    <title>SECURITY</title>
224 by Teddy Hogeborn
* mandos-keygen.xml (FILES): Fixed id to be "files", not "file".
620
    <refsect2 id="server">
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
621
      <title>SERVER</title>
622
      <para>
85 by Teddy Hogeborn
* mandos.xml (SYNOPSIS): Removed unnecessary 'choice="opt"' from <arg>
623
	Running this <command>&COMMANDNAME;</command> server program
624
	should not in itself present any security risk to the host
163 by Teddy Hogeborn
* Makefile (PIDDIR, USER, GROUP): Removed.
625
	computer running it.  The program switches to a non-root user
626
	soon after startup.
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
627
      </para>
628
    </refsect2>
224 by Teddy Hogeborn
* mandos-keygen.xml (FILES): Fixed id to be "files", not "file".
629
    <refsect2 id="clients">
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
630
      <title>CLIENTS</title>
631
      <para>
632
	The server only gives out its stored data to clients which
633
	does have the OpenPGP key of the stored fingerprint.  This is
634
	guaranteed by the fact that the client sends its OpenPGP
635
	public key in the TLS handshake; this ensures it to be
636
	genuine.  The server computes the fingerprint of the key
637
	itself and looks up the fingerprint in its list of
638
	clients. The <filename>clients.conf</filename> file (see
639
	<citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
84 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Use the local manpages/docbook.xsl file, do
640
	<manvolnum>5</manvolnum></citerefentry>)
641
	<emphasis>must</emphasis> be made non-readable by anyone
201 by Teddy Hogeborn
* mandos.xml (SECURITY): Minor wording improvement.
642
	except the user starting the server (usually root).
84 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Use the local manpages/docbook.xsl file, do
643
      </para>
644
      <para>
645
	As detailed in <xref linkend="checking"/>, the status of all
646
	client computers will continually be checked and be assumed
647
	compromised if they are gone for too long.
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
648
      </para>
649
      <para>
650
	For more details on client-side security, see
171 by Teddy Hogeborn
Renamed "password-request" to "mandos-client".
651
	<citerefentry><refentrytitle>mandos-client</refentrytitle>
83 by Teddy Hogeborn
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".
652
	<manvolnum>8mandos</manvolnum></citerefentry>.
653
      </para>
654
    </refsect2>
24.1.55 by Björn Påhlsson
updated some partial manual pages
655
  </refsect1>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
656
  
24.1.55 by Björn Påhlsson
updated some partial manual pages
657
  <refsect1 id="see_also">
658
    <title>SEE ALSO</title>
92 by Teddy Hogeborn
* mandos-keygen.xml (SEE ALSO): Remove "and".
659
    <para>
237.7.41 by Teddy Hogeborn
* Makefile (DOCS): Added "intro.8mandos".
660
      <citerefentry><refentrytitle>intro</refentrytitle>
661
      <manvolnum>8mandos</manvolnum></citerefentry>,
662
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
663
      <manvolnum>5</manvolnum></citerefentry>,
664
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
665
      <manvolnum>5</manvolnum></citerefentry>,
666
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
667
      <manvolnum>8mandos</manvolnum></citerefentry>,
668
      <citerefentry><refentrytitle>sh</refentrytitle>
669
      <manvolnum>1</manvolnum></citerefentry>
92 by Teddy Hogeborn
* mandos-keygen.xml (SEE ALSO): Remove "and".
670
    </para>
84 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Use the local manpages/docbook.xsl file, do
671
    <variablelist>
672
      <varlistentry>
673
	<term>
674
	  <ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
675
	</term>
676
	<listitem>
677
	  <para>
678
	    Zeroconf is the network protocol standard used by clients
679
	    for finding this Mandos server on the local network.
680
	  </para>
681
	</listitem>
682
      </varlistentry>
683
      <varlistentry>
684
	<term>
685
	  <ulink url="http://www.avahi.org/">Avahi</ulink>
686
	</term>
687
      <listitem>
688
	<para>
689
	  Avahi is the library this server calls to implement
690
	  Zeroconf service announcements.
691
	</para>
692
      </listitem>
693
      </varlistentry>
694
      <varlistentry>
695
	<term>
108 by Teddy Hogeborn
* mandos-options.xml (address): Refer to IPv4-mapped IPv6 address
696
	  <ulink url="http://www.gnu.org/software/gnutls/"
697
	  >GnuTLS</ulink>
84 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Use the local manpages/docbook.xsl file, do
698
	</term>
699
      <listitem>
700
	<para>
701
	  GnuTLS is the library this server uses to implement TLS for
702
	  communicating securely with the client, and at the same time
703
	  confidently get the client’s public OpenPGP key.
704
	</para>
705
      </listitem>
706
      </varlistentry>
707
      <varlistentry>
708
	<term>
108 by Teddy Hogeborn
* mandos-options.xml (address): Refer to IPv4-mapped IPv6 address
709
	  RFC 4291: <citetitle>IP Version 6 Addressing
710
	  Architecture</citetitle>
84 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Use the local manpages/docbook.xsl file, do
711
	</term>
712
	<listitem>
108 by Teddy Hogeborn
* mandos-options.xml (address): Refer to IPv4-mapped IPv6 address
713
	  <variablelist>
714
	    <varlistentry>
715
	      <term>Section 2.2: <citetitle>Text Representation of
716
	      Addresses</citetitle></term>
717
	      <listitem><para/></listitem>
718
	    </varlistentry>
719
	    <varlistentry>
720
	      <term>Section 2.5.5.2: <citetitle>IPv4-Mapped IPv6
721
	      Address</citetitle></term>
722
	      <listitem><para/></listitem>
723
	    </varlistentry>
724
	    <varlistentry>
725
	    <term>Section 2.5.6, <citetitle>Link-Local IPv6 Unicast
726
	    Addresses</citetitle></term>
727
	    <listitem>
728
	      <para>
729
		The clients use IPv6 link-local addresses, which are
730
		immediately usable since a link-local addresses is
731
		automatically assigned to a network interfaces when it
732
		is brought up.
733
	      </para>
734
	    </listitem>
735
	    </varlistentry>
736
	  </variablelist>
84 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Use the local manpages/docbook.xsl file, do
737
	</listitem>
738
      </varlistentry>
739
      <varlistentry>
740
	<term>
108 by Teddy Hogeborn
* mandos-options.xml (address): Refer to IPv4-mapped IPv6 address
741
	  RFC 4346: <citetitle>The Transport Layer Security (TLS)
742
	  Protocol Version 1.1</citetitle>
84 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Use the local manpages/docbook.xsl file, do
743
	</term>
744
      <listitem>
745
	<para>
746
	  TLS 1.1 is the protocol implemented by GnuTLS.
747
	</para>
748
      </listitem>
749
      </varlistentry>
750
      <varlistentry>
751
	<term>
108 by Teddy Hogeborn
* mandos-options.xml (address): Refer to IPv4-mapped IPv6 address
752
	  RFC 4880: <citetitle>OpenPGP Message Format</citetitle>
84 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Use the local manpages/docbook.xsl file, do
753
	</term>
754
      <listitem>
755
	<para>
756
	  The data sent to clients is binary encrypted OpenPGP data.
757
	</para>
758
      </listitem>
759
      </varlistentry>
760
      <varlistentry>
761
	<term>
108 by Teddy Hogeborn
* mandos-options.xml (address): Refer to IPv4-mapped IPv6 address
762
	  RFC 5081: <citetitle>Using OpenPGP Keys for Transport Layer
763
	  Security</citetitle>
84 by Teddy Hogeborn
* Makefile (DOCBOOKTOMAN): Use the local manpages/docbook.xsl file, do
764
	</term>
765
      <listitem>
766
	<para>
767
	  This is implemented by GnuTLS and used by this server so
768
	  that OpenPGP keys can be used.
769
	</para>
770
      </listitem>
771
      </varlistentry>
772
    </variablelist>
24.1.55 by Björn Påhlsson
updated some partial manual pages
773
  </refsect1>
24.1.23 by Björn Påhlsson
Added manual pages for:
774
</refentry>
111 by Teddy Hogeborn
* mandos-clients.conf.xml (ENTITY TIMESTAMP): New. Automatically
775
<!-- Local Variables: -->
776
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
777
<!-- time-stamp-end: "[\"']>" -->
778
<!-- time-stamp-format: "%:y-%02m-%02d" -->
779
<!-- End: -->