/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" [
24.1.24 by Björn Påhlsson
minor edits
4
<!ENTITY CONFNAME "mandos-clients.conf">
24.1.23 by Björn Påhlsson
Added manual pages for:
5
<!ENTITY CONFPATH "<filename>/etc/mandos/clients.conf</filename>">
237.11.13 by Teddy Hogeborn
Miscellaneous fixes prompted by lintian:
6
<!ENTITY TIMESTAMP "2011-10-10">
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
131 by Teddy Hogeborn
* Makefile: Make all DocBook rules include legalnotice.xml as a
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>
93 by Teddy Hogeborn
* mandos (string_to_delta): Accept a whitespace-separated sequence of
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.2.207 by Teddy Hogeborn
Update copyright year to "2010" wherever appropriate.
37
      <year>2010</year>
237.7.14 by Teddy Hogeborn
Update copyright year to "2011" wherever appropriate.
38
      <year>2011</year>
93 by Teddy Hogeborn
* mandos (string_to_delta): Accept a whitespace-separated sequence of
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>
93 by Teddy Hogeborn
* mandos (string_to_delta): Accept a whitespace-separated sequence of
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>
106 by Teddy Hogeborn
* mandos-clients.conf.xml (DESCRIPTION): Do not imply that this is the
64
      The file &CONFPATH; is a configuration file for <citerefentry
93 by Teddy Hogeborn
* mandos (string_to_delta): Accept a whitespace-separated sequence of
65
      ><refentrytitle>mandos</refentrytitle>
106 by Teddy Hogeborn
* mandos-clients.conf.xml (DESCRIPTION): Do not imply that this is the
66
      <manvolnum>8</manvolnum></citerefentry>, read by it at startup.
67
      The file needs to list all clients that should be able to use
237.2.174 by Teddy Hogeborn
More consistent terminology: Clients are no longer "invalid" - they
68
      the service.  All clients listed will be regarded as enabled,
69
      even if a client was disabled in a previous run of the server.
93 by Teddy Hogeborn
* mandos (string_to_delta): Accept a whitespace-separated sequence of
70
    </para>
71
    <para>
94 by Teddy Hogeborn
* clients.conf ([DEFAULT]/checker): Update to new default value.
72
      The format starts with a <literal>[<replaceable>section
73
      header</replaceable>]</literal> which is either
93 by Teddy Hogeborn
* mandos (string_to_delta): Accept a whitespace-separated sequence of
74
      <literal>[DEFAULT]</literal> or <literal>[<replaceable>client
94 by Teddy Hogeborn
* clients.conf ([DEFAULT]/checker): Update to new default value.
75
      name</replaceable>]</literal>.  The <replaceable>client
76
      name</replaceable> can be anything, and is not tied to a host
77
      name.  Following the section header is any number of
78
      <quote><varname><replaceable>option</replaceable
93 by Teddy Hogeborn
* mandos (string_to_delta): Accept a whitespace-separated sequence of
79
      ></varname>=<replaceable>value</replaceable></quote> entries,
80
      with continuations in the style of RFC 822.  <quote><varname
81
      ><replaceable>option</replaceable></varname>: <replaceable
82
      >value</replaceable></quote> is also accepted.  Note that
83
      leading whitespace is removed from values.  Values can contain
84
      format strings which refer to other values in the same section,
94 by Teddy Hogeborn
* clients.conf ([DEFAULT]/checker): Update to new default value.
85
      or values in the <quote>DEFAULT</quote> section (see <xref
86
      linkend="expansion"/>).  Lines beginning with <quote>#</quote>
87
      or <quote>;</quote> are ignored and may be used to provide
88
      comments.
24.1.23 by Björn Påhlsson
Added manual pages for:
89
    </para>
90
  </refsect1>
93 by Teddy Hogeborn
* mandos (string_to_delta): Accept a whitespace-separated sequence of
91
  
92
  <refsect1 id="options">
93
    <title>OPTIONS</title>
24.1.23 by Björn Påhlsson
Added manual pages for:
94
    <para>
106 by Teddy Hogeborn
* mandos-clients.conf.xml (DESCRIPTION): Do not imply that this is the
95
      <emphasis>Note:</emphasis> all option values are subject to
96
      start time expansion, see <xref linkend="expansion"/>.
97
    </para>
98
    <para>
156 by Teddy Hogeborn
* mandos-clients.conf.xml (OPTIONS): Improved spelling.
99
      Unknown options are ignored.  The used options are as follows:
24.1.23 by Björn Påhlsson
Added manual pages for:
100
    </para>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
101
    
24.1.23 by Björn Påhlsson
Added manual pages for:
102
    <variablelist>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
103
      
24.1.23 by Björn Påhlsson
Added manual pages for:
104
      <varlistentry>
237.2.201 by Teddy Hogeborn
* mandos (Client.runtime_expansions): New attribute containing the
105
	<term><option>approval_delay<literal> = </literal><replaceable
106
	>TIME</replaceable></option></term>
107
	<listitem>
108
	  <para>
109
	    This option is <emphasis>optional</emphasis>.
110
	  </para>
111
	  <para>
112
	    How long to wait for external approval before resorting to
113
	    use the <option>approved_by_default</option> value.  The
114
	    default is <quote>0s</quote>, i.e. not to wait.
115
	  </para>
116
	  <para>
117
	    The format of <replaceable>TIME</replaceable> is the same
118
	    as for <varname>timeout</varname> below.
119
	  </para>
120
	</listitem>
121
      </varlistentry>
122
      
123
      <varlistentry>
124
	<term><option>approval_duration<literal> = </literal
125
        ><replaceable>TIME</replaceable></option></term>
126
	<listitem>
127
	  <para>
128
	    This option is <emphasis>optional</emphasis>.
129
	  </para>
130
	  <para>
131
	    How long an external approval lasts.  The default is 1
132
	    second.
133
	  </para>
134
	  <para>
135
	    The format of <replaceable>TIME</replaceable> is the same
136
	    as for <varname>timeout</varname> below.
137
	  </para>
138
	</listitem>
139
      </varlistentry>
140
      
141
      <varlistentry>
142
	<term><option>approved_by_default<literal> = </literal
143
          >{ <literal >1</literal> | <literal>yes</literal> | <literal
144
	  >true</literal> | <literal>on</literal> | <literal
145
	  >0</literal> | <literal>no</literal> | <literal
146
	  >false</literal> | <literal>off</literal> }</option></term>
147
	<listitem>
148
	  <para>
149
	    Whether to approve a client by default after
150
	    the <option>approval_delay</option>.  The default
151
	    is <quote>True</quote>.
24.1.23 by Björn Påhlsson
Added manual pages for:
152
	  </para>
153
	</listitem>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
154
      </varlistentry>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
155
      
24.1.23 by Björn Påhlsson
Added manual pages for:
156
      <varlistentry>
119 by Teddy Hogeborn
* mandos-clients.conf.xml (SYNOPSIS): Remove line breaks.
157
	<term><option>checker<literal> = </literal><replaceable
158
	>COMMAND</replaceable></option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
159
	<listitem>
160
	  <para>
150 by Teddy Hogeborn
* mandos-clients.conf.xml (OPTIONS): Add info to all options about
161
	    This option is <emphasis>optional</emphasis>.
162
	  </para>
163
	  <para>
24.1.23 by Björn Påhlsson
Added manual pages for:
164
	    This option allows you to override the default shell
94 by Teddy Hogeborn
* clients.conf ([DEFAULT]/checker): Update to new default value.
165
	    command that the server will use to check if the client is
106 by Teddy Hogeborn
* mandos-clients.conf.xml (DESCRIPTION): Do not imply that this is the
166
	    still up.  Any output of the command will be ignored, only
167
	    the exit code is checked:  If the exit code of the command
168
	    is zero, the client is considered up.  The command will be
169
	    run using <quote><command><filename>/bin/sh</filename>
170
	    <option>-c</option></command></quote>, so
171
	    <varname>PATH</varname> will be searched.  The default
172
	    value for the checker command is <quote><literal
173
	    ><command>fping</command> <option>-q</option> <option
237.2.20 by Teddy Hogeborn
Change the default value of the "checker" option command to make the
174
	    >--</option> %%(host)s</literal></quote>.
94 by Teddy Hogeborn
* clients.conf ([DEFAULT]/checker): Update to new default value.
175
	  </para>
176
	  <para>
177
	    In addition to normal start time expansion, this option
178
	    will also be subject to runtime expansion; see <xref
179
	    linkend="expansion"/>.
24.1.23 by Björn Påhlsson
Added manual pages for:
180
	  </para>
181
	</listitem>
182
      </varlistentry>
183
      
184
      <varlistentry>
237.7.48 by Teddy Hogeborn
* mandos-clients.conf.xml (OPTIONS): Moved up "extended_timeout" to
185
	<term><option>extended_timeout<literal> = </literal><replaceable
186
	>TIME</replaceable></option></term>
187
	<listitem>
188
	  <para>
189
	    This option is <emphasis>optional</emphasis>.
190
	  </para>
191
	  <para>
192
	    Extended timeout is an added timeout that is given once
237.11.13 by Teddy Hogeborn
Miscellaneous fixes prompted by lintian:
193
	    after a password has been sent successfully to a client.
237.7.48 by Teddy Hogeborn
* mandos-clients.conf.xml (OPTIONS): Moved up "extended_timeout" to
194
	    The timeout is by default longer than the normal timeout,
195
	    and is used for handling the extra long downtime while a
196
	    machine is booting up.  Time to take into consideration
197
	    when changing this value is file system checks and quota
198
	    checks.  The default value is 15 minutes.
199
	  </para>
200
	  <para>
201
	    The format of <replaceable>TIME</replaceable> is the same
202
	    as for <varname>timeout</varname> below.
203
	  </para>
204
	</listitem>
205
      </varlistentry>
206
      
207
      <varlistentry>
119 by Teddy Hogeborn
* mandos-clients.conf.xml (SYNOPSIS): Remove line breaks.
208
	<term><option>fingerprint<literal> = </literal
209
	><replaceable>HEXSTRING</replaceable></option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
210
	<listitem>
211
	  <para>
150 by Teddy Hogeborn
* mandos-clients.conf.xml (OPTIONS): Add info to all options about
212
	    This option is <emphasis>required</emphasis>.
213
	  </para>
214
	  <para>
94 by Teddy Hogeborn
* clients.conf ([DEFAULT]/checker): Update to new default value.
215
	    This option sets the OpenPGP fingerprint that identifies
216
	    the public key that clients authenticate themselves with
217
	    through TLS.  The string needs to be in hexidecimal form,
218
	    but spaces or upper/lower case are not significant.
24.1.23 by Björn Påhlsson
Added manual pages for:
219
	  </para>
220
	</listitem>
221
      </varlistentry>
222
      
223
      <varlistentry>
237.2.201 by Teddy Hogeborn
* mandos (Client.runtime_expansions): New attribute containing the
224
	<term><option><literal>host = </literal><replaceable
225
	>STRING</replaceable></option></term>
226
	<listitem>
227
	  <para>
228
	    This option is <emphasis>optional</emphasis>, but highly
229
	    <emphasis>recommended</emphasis> unless the
230
	    <option>checker</option> option is modified to a
231
	    non-standard value without <quote>%%(host)s</quote> in it.
232
	  </para>
233
	  <para>
234
	    Host name for this client.  This is not used by the server
235
	    directly, but can be, and is by default, used by the
236
	    checker.  See the <option>checker</option> option.
237
	  </para>
238
	</listitem>
239
      </varlistentry>
240
      
241
      <varlistentry>
242
	<term><option>interval<literal> = </literal><replaceable
243
	>TIME</replaceable></option></term>
244
	<listitem>
245
	  <para>
246
	    This option is <emphasis>optional</emphasis>.
247
	  </para>
248
	  <para>
249
	    How often to run the checker to confirm that a client is
250
	    still up.  <emphasis>Note:</emphasis> a new checker will
251
	    not be started if an old one is still running.  The server
252
	    will wait for a checker to complete until the below
253
	    <quote><varname>timeout</varname></quote> occurs, at which
254
	    time the client will be disabled, and any running checker
24.1.179 by Björn Påhlsson
New feature:
255
	    killed.  The default interval is 2 minutes.
237.2.201 by Teddy Hogeborn
* mandos (Client.runtime_expansions): New attribute containing the
256
	  </para>
257
	  <para>
258
	    The format of <replaceable>TIME</replaceable> is the same
259
	    as for <varname>timeout</varname> below.
260
	  </para>
261
	</listitem>
262
      </varlistentry>
263
      
264
      <varlistentry>
265
	<term><option>secfile<literal> = </literal><replaceable
266
	>FILENAME</replaceable></option></term>
267
	<listitem>
268
	  <para>
269
	    This option is only used if <option>secret</option> is not
270
	    specified, in which case this option is
271
	    <emphasis>required</emphasis>.
272
	  </para>
273
	  <para>
274
	    Similar to the <option>secret</option>, except the secret
275
	    data is in an external file.  The contents of the file
276
	    should <emphasis>not</emphasis> be base64-encoded, but
277
	    will be sent to clients verbatim.
278
	  </para>
279
	  <para>
280
	    File names of the form <filename>~user/foo/bar</filename>
281
	    and <filename>$<envar>ENVVAR</envar>/foo/bar</filename>
282
	    are supported.
283
	  </para>
284
	</listitem>
285
      </varlistentry>
286
      
287
      <varlistentry>
119 by Teddy Hogeborn
* mandos-clients.conf.xml (SYNOPSIS): Remove line breaks.
288
	<term><option>secret<literal> = </literal><replaceable
289
	>BASE64_ENCODED_DATA</replaceable></option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
290
	<listitem>
94 by Teddy Hogeborn
* clients.conf ([DEFAULT]/checker): Update to new default value.
291
	  <para>
150 by Teddy Hogeborn
* mandos-clients.conf.xml (OPTIONS): Add info to all options about
292
	    If this option is not specified, the <option
293
	    >secfile</option> option is <emphasis>required</emphasis>
294
	    to be present.
295
	  </para>
296
	  <para>
94 by Teddy Hogeborn
* clients.conf ([DEFAULT]/checker): Update to new default value.
297
	    If present, this option must be set to a string of
298
	    base64-encoded binary data.  It will be decoded and sent
299
	    to the client matching the above
300
	    <option>fingerprint</option>.  This should, of course, be
301
	    OpenPGP encrypted data, decryptable only by the client.
106 by Teddy Hogeborn
* mandos-clients.conf.xml (DESCRIPTION): Do not imply that this is the
302
	    The program <citerefentry><refentrytitle><command
303
	    >mandos-keygen</command></refentrytitle><manvolnum
304
	    >8</manvolnum></citerefentry> can, using its
305
	    <option>--password</option> option, be used to generate
306
	    this, if desired.
307
	  </para>
308
	  <para>
309
	    Note: this value of this option will probably be very
310
	    long.  A useful feature to avoid having unreadably-long
311
	    lines is that a line beginning with white space adds to
312
	    the value of the previous line, RFC 822-style.
313
	  </para>
24.1.23 by Björn Påhlsson
Added manual pages for:
314
	</listitem>
315
      </varlistentry>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
316
      
24.1.23 by Björn Påhlsson
Added manual pages for:
317
      <varlistentry>
237.2.201 by Teddy Hogeborn
* mandos (Client.runtime_expansions): New attribute containing the
318
	<term><option>timeout<literal> = </literal><replaceable
237.2.186 by Teddy Hogeborn
Documentation changes:
319
	>TIME</replaceable></option></term>
320
	<listitem>
321
	  <para>
322
	    This option is <emphasis>optional</emphasis>.
323
	  </para>
324
	  <para>
237.7.49 by Teddy Hogeborn
* mandos-clients.conf.xml (OPTIONS/timeout): No longer used when
325
	    The timeout is how long the server will wait, after a
326
	    successful checker run, until a client is disabled and not
327
	    allowed to get the data this server holds.  By default
328
	    Mandos will use 5 minutes.  See also the
329
	    <option>extended_timeout</option> option.
237.2.201 by Teddy Hogeborn
* mandos (Client.runtime_expansions): New attribute containing the
330
	  </para>
331
	  <para>
332
	    The <replaceable>TIME</replaceable> is specified as a
333
	    space-separated number of values, each of which is a
334
	    number and a one-character suffix.  The suffix must be one
335
	    of <quote>d</quote>, <quote>s</quote>, <quote>m</quote>,
336
	    <quote>h</quote>, and <quote>w</quote> for days, seconds,
337
	    minutes, hours, and weeks, respectively.  The values are
338
	    added together to give the total time value, so all of
339
	    <quote><literal>330s</literal></quote>,
340
	    <quote><literal>110s 110s 110s</literal></quote>, and
341
	    <quote><literal>5m 30s</literal></quote> will give a value
342
	    of five minutes and thirty seconds.
237.2.186 by Teddy Hogeborn
Documentation changes:
343
	  </para>
344
	</listitem>
345
      </varlistentry>
346
      
24.1.23 by Björn Påhlsson
Added manual pages for:
347
    </variablelist>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
348
  </refsect1>
93 by Teddy Hogeborn
* mandos (string_to_delta): Accept a whitespace-separated sequence of
349
  
350
  <refsect1 id="expansion">
351
    <title>EXPANSION</title>
352
    <para>
353
      There are two forms of expansion: Start time expansion and
354
      runtime expansion.
355
    </para>
94 by Teddy Hogeborn
* clients.conf ([DEFAULT]/checker): Update to new default value.
356
    <refsect2 id="start_time_expansion">
93 by Teddy Hogeborn
* mandos (string_to_delta): Accept a whitespace-separated sequence of
357
      <title>START TIME EXPANSION</title>
358
      <para>
359
	Any string in an option value of the form
360
	<quote><literal>%(<replaceable>foo</replaceable>)s</literal
361
	></quote> will be replaced by the value of the option
362
	<varname>foo</varname> either in the same section, or, if it
363
	does not exist there, the <literal>[DEFAULT]</literal>
364
	section.  This is done at start time, when the configuration
365
	file is read.
366
      </para>
367
      <para>
368
	Note that this means that, in order to include an actual
369
	percent character (<quote>%</quote>) in an option value, two
370
	percent characters in a row (<quote>%%</quote>) must be
371
	entered.
372
      </para>
373
    </refsect2>
94 by Teddy Hogeborn
* clients.conf ([DEFAULT]/checker): Update to new default value.
374
    <refsect2 id="runtime_expansion">
93 by Teddy Hogeborn
* mandos (string_to_delta): Accept a whitespace-separated sequence of
375
      <title>RUNTIME EXPANSION</title>
376
      <para>
377
	This is currently only done for the <varname>checker</varname>
378
	option.
379
      </para>
380
      <para>
381
	Any string in an option value of the form
382
	<quote><literal>%%(<replaceable>foo</replaceable>)s</literal
383
	></quote> will be replaced by the value of the attribute
384
	<varname>foo</varname> of the internal
237.2.212 by teddy at bsnet
* mandos-clients.conf.xml (EXPANSION/RUNTIME EXPANSION): List possible
385
	<quote><classname>Client</classname></quote> object in the
386
	Mandos server.  The currently allowed values for
387
	<replaceable>foo</replaceable> are:
388
	<quote><literal>approval_delay</literal></quote>,
389
	<quote><literal>approval_duration</literal></quote>,
390
	<quote><literal>created</literal></quote>,
391
	<quote><literal>enabled</literal></quote>,
392
	<quote><literal>fingerprint</literal></quote>,
393
	<quote><literal>host</literal></quote>,
394
	<quote><literal>interval</literal></quote>,
395
	<quote><literal>last_approval_request</literal></quote>,
396
	<quote><literal>last_checked_ok</literal></quote>,
397
	<quote><literal>last_enabled</literal></quote>,
398
	<quote><literal>name</literal></quote>,
399
	<quote><literal>timeout</literal></quote>, and, if using
400
	D-Bus, <quote><literal>dbus_object_path</literal></quote>.
401
	See the source code for details.  <emphasis role="strong"
402
	>Currently, <emphasis>none</emphasis> of these attributes
403
	except <quote><literal>host</literal></quote> are guaranteed
404
	to be valid in future versions.</emphasis> Therefore, please
405
	let the authors know of any attributes that are useful so they
406
	may be preserved to any new versions of this software.
93 by Teddy Hogeborn
* mandos (string_to_delta): Accept a whitespace-separated sequence of
407
      </para>
408
      <para>
409
	Note that this means that, in order to include an actual
410
	percent character (<quote>%</quote>) in a
106 by Teddy Hogeborn
* mandos-clients.conf.xml (DESCRIPTION): Do not imply that this is the
411
	<varname>checker</varname> option, <emphasis>four</emphasis>
93 by Teddy Hogeborn
* mandos (string_to_delta): Accept a whitespace-separated sequence of
412
	percent characters in a row (<quote>%%%%</quote>) must be
413
	entered.  Also, a bad format here will lead to an immediate
414
	but <emphasis>silent</emphasis> run-time fatal exit; debug
119 by Teddy Hogeborn
* mandos-clients.conf.xml (SYNOPSIS): Remove line breaks.
415
	mode is needed to expose an error of this kind.
93 by Teddy Hogeborn
* mandos (string_to_delta): Accept a whitespace-separated sequence of
416
      </para>
417
    </refsect2>
182 by Teddy Hogeborn
* Makefile (install): Use "install-client-nokey".
418
    
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
419
  </refsect1>
93 by Teddy Hogeborn
* mandos (string_to_delta): Accept a whitespace-separated sequence of
420
  
421
  <refsect1 id="files">
422
    <title>FILES</title>
423
    <para>
424
      The file described here is &CONFPATH;
425
    </para>
426
  </refsect1>
427
  
428
  <refsect1 id="bugs">
429
    <title>BUGS</title>
430
    <para>
431
      The format for specifying times for <varname>timeout</varname>
432
      and <varname>interval</varname> is not very good.
433
    </para>
434
    <para>
435
      The difference between
436
      <literal>%%(<replaceable>foo</replaceable>)s</literal> and
437
      <literal>%(<replaceable>foo</replaceable>)s</literal> is
438
      obscure.
439
    </para>
440
  </refsect1>
441
  
442
  <refsect1 id="example">
443
    <title>EXAMPLE</title>
24.1.23 by Björn Påhlsson
Added manual pages for:
444
    <informalexample>
445
      <programlisting>
446
[DEFAULT]
24.1.179 by Björn Påhlsson
New feature:
447
timeout = 5m
448
interval = 2m
237.2.20 by Teddy Hogeborn
Change the default value of the "checker" option command to make the
449
checker = fping -q -- %%(host)s
24.1.23 by Björn Påhlsson
Added manual pages for:
450
93 by Teddy Hogeborn
* mandos (string_to_delta): Accept a whitespace-separated sequence of
451
# Client "foo"
452
[foo]
24.1.23 by Björn Påhlsson
Added manual pages for:
453
fingerprint =  7788 2722 5BA7 DE53 9C5A  7CFA 59CF F7CD BD9A 5920
454
secret =
24.1.24 by Björn Påhlsson
minor edits
455
        hQIOA6QdEjBs2L/HEAf/TCyrDe5Xnm9esa+Pb/vWF9CUqfn4srzVgSu234
456
        REJMVv7lBSrPE2132Lmd2gqF1HeLKDJRSVxJpt6xoWOChGHg+TMyXDxK+N
457
        Xl89vGvdU1XfhKkVm9MDLOgT5ECDPysDGHFPDhqHOSu3Kaw2DWMV/iH9vz
458
        3Z20erVNbdcvyBnuojcoWO/6yfB5EQO0BXp7kcyy00USA3CjD5FGZdoQGI
459
        Tb8A/ar0tVA5crSQmaSotm6KmNLhrFnZ5BxX+TiE+eTUTqSloWRY6VAvqW
460
        QHC7OASxK5E6RXPBuFH5IohUA2Qbk5AHt99pYvsIPX88j2rWauOokoiKZo
461
        t/9leJ8VxO5l3wf/U64IH8bkPIoWmWZfd/nqh4uwGNbCgKMyT+AnvH7kMJ
462
        3i7DivfWl2mKLV0PyPHUNva0VQxX6yYjcOhj1R6fCr/at8/NSLe2OhLchz
463
        dC+Ls9h+kvJXgF8Sisv+Wk/1RadPLFmraRlqvJwt6Ww21LpiXqXHV2mIgq
464
        WnR98YgSvUi3TJHrUQiNc9YyBzuRo0AjgG2C9qiE3FM+Y28+iQ/sR3+bFs
465
        zYuZKVTObqiIslwXu7imO0cvvFRgJF/6u3HNFQ4LUTGhiM3FQmC6NNlF3/
466
        vJM2hwRDMcJqDd54Twx90Wh+tYz0z7QMsK4ANXWHHWHR0JchnLWmenzbtW
467
        5MHdW9AYsNJZAQSOpirE4Xi31CSlWAi9KV+cUCmWF5zOFy1x23P6PjdaRm
468
        4T2zw4dxS5NswXWU0sVEXxjs6PYxuIiCTL7vdpx8QjBkrPWDrAbcMyBr2O
469
        QlnHIvPzEArRQLo=
93 by Teddy Hogeborn
* mandos (string_to_delta): Accept a whitespace-separated sequence of
470
host = foo.example.org
106 by Teddy Hogeborn
* mandos-clients.conf.xml (DESCRIPTION): Do not imply that this is the
471
interval = 1m
93 by Teddy Hogeborn
* mandos (string_to_delta): Accept a whitespace-separated sequence of
472
473
# Client "bar"
474
[bar]
475
fingerprint = 3e393aeaefb84c7e89e2f547b3a107558fca3a27
106 by Teddy Hogeborn
* mandos-clients.conf.xml (DESCRIPTION): Do not imply that this is the
476
secfile = /etc/mandos/bar-secret
477
timeout = 15m
237.2.186 by Teddy Hogeborn
Documentation changes:
478
approved_by_default = False
479
approval_delay = 30s
24.1.23 by Björn Påhlsson
Added manual pages for:
480
      </programlisting>
481
    </informalexample>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
482
  </refsect1>
106 by Teddy Hogeborn
* mandos-clients.conf.xml (DESCRIPTION): Do not imply that this is the
483
  
484
  <refsect1 id="see_also">
485
    <title>SEE ALSO</title>
486
    <para>
237.7.41 by Teddy Hogeborn
* Makefile (DOCS): Added "intro.8mandos".
487
      <citerefentry><refentrytitle>intro</refentrytitle>
488
      <manvolnum>8mandos</manvolnum></citerefentry>,
114 by Teddy Hogeborn
* mandos-clients.conf.xml (SEE ALSO): Alphabetized, as per
489
      <citerefentry><refentrytitle>mandos-keygen</refentrytitle>
490
      <manvolnum>8</manvolnum></citerefentry>,
491
      <citerefentry><refentrytitle>mandos.conf</refentrytitle>
492
      <manvolnum>5</manvolnum></citerefentry>,
493
      <citerefentry><refentrytitle>mandos</refentrytitle>
494
      <manvolnum>8</manvolnum></citerefentry>
106 by Teddy Hogeborn
* mandos-clients.conf.xml (DESCRIPTION): Do not imply that this is the
495
    </para>
496
  </refsect1>
24.1.23 by Björn Påhlsson
Added manual pages for:
497
</refentry>
111 by Teddy Hogeborn
* mandos-clients.conf.xml (ENTITY TIMESTAMP): New. Automatically
498
<!-- Local Variables: -->
499
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
500
<!-- time-stamp-end: "[\"']>" -->
501
<!-- time-stamp-format: "%:y-%02m-%02d" -->
502
<!-- End: -->