/mandos/trunk

To get this branch, use:
bzr branch http://bzr.recompile.se/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 VERSION "1.0">
5
<!ENTITY COMMANDNAME "password-request">
143 by Teddy Hogeborn
* Makefile (mandos.8): Add dependency on "overview.xml" and
6
<!ENTITY TIMESTAMP "2008-09-03">
24.1.23 by Björn Påhlsson
Added manual pages for:
7
]>
8
131 by Teddy Hogeborn
* Makefile: Make all DocBook rules include legalnotice.xml as a
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
24.1.23 by Björn Påhlsson
Added manual pages for:
10
  <refentryinfo>
112 by Teddy Hogeborn
* mandos-clients.conf.xml (/refentry/refentryinfo/title): Changed to
11
    <title>Mandos Manual</title>
129 by Teddy Hogeborn
* mandos-clients.conf.xml: Changed all single quotes to double quotes
12
    <!-- Nwalsh’s docbook scripts use this to generate the footer: -->
112 by Teddy Hogeborn
* mandos-clients.conf.xml (/refentry/refentryinfo/title): Changed to
13
    <productname>Mandos</productname>
24.1.23 by Björn Påhlsson
Added manual pages for:
14
    <productnumber>&VERSION;</productnumber>
111 by Teddy Hogeborn
* mandos-clients.conf.xml (ENTITY TIMESTAMP): New. Automatically
15
    <date>&TIMESTAMP;</date>
24.1.23 by Björn Påhlsson
Added manual pages for:
16
    <authorgroup>
17
      <author>
18
	<firstname>Björn</firstname>
19
	<surname>Påhlsson</surname>
20
	<address>
21
	  <email>belorn@fukt.bsnet.se</email>
22
	</address>
23
      </author>
24
      <author>
25
	<firstname>Teddy</firstname>
26
	<surname>Hogeborn</surname>
27
	<address>
28
	  <email>teddy@fukt.bsnet.se</email>
29
	</address>
30
      </author>
31
    </authorgroup>
32
    <copyright>
33
      <year>2008</year>
128 by Teddy Hogeborn
* plugin-runner.xml (/refentry/refentryinfo/copyright): Split
34
      <holder>Teddy Hogeborn</holder>
35
      <holder>Björn Påhlsson</holder>
24.1.23 by Björn Påhlsson
Added manual pages for:
36
    </copyright>
131 by Teddy Hogeborn
* Makefile: Make all DocBook rules include legalnotice.xml as a
37
    <xi:include href="../legalnotice.xml"/>
24.1.23 by Björn Påhlsson
Added manual pages for:
38
  </refentryinfo>
39
40
  <refmeta>
41
    <refentrytitle>&COMMANDNAME;</refentrytitle>
42
    <manvolnum>8mandos</manvolnum>
43
  </refmeta>
44
  
45
  <refnamediv>
46
    <refname><command>&COMMANDNAME;</command></refname>
47
    <refpurpose>
48
      Client for mandos
49
    </refpurpose>
50
  </refnamediv>
51
52
  <refsynopsisdiv>
53
    <cmdsynopsis>
54
      <command>&COMMANDNAME;</command>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
55
      <group>
56
	<arg choice="plain"><option>--connect
57
	<replaceable>IPADDR</replaceable><literal>:</literal
58
	><replaceable>PORT</replaceable></option></arg>
59
	<arg choice="plain"><option>-c
60
	<replaceable>IPADDR</replaceable><literal>:</literal
61
	><replaceable>PORT</replaceable></option></arg>
62
      </group>
63
      <sbr/>
64
      <group>
65
	<arg choice="plain"><option>--keydir
127 by Teddy Hogeborn
* plugins.d/password-request.xml (OPTIONS): Make replaceables match
66
	<replaceable>DIRECTORY</replaceable></option></arg>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
67
	<arg choice="plain"><option>-d
127 by Teddy Hogeborn
* plugins.d/password-request.xml (OPTIONS): Make replaceables match
68
	<replaceable>DIRECTORY</replaceable></option></arg>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
69
      </group>
70
      <sbr/>
71
      <group>
72
	<arg choice="plain"><option>--interface
73
	<replaceable>NAME</replaceable></option></arg>
74
	<arg choice="plain"><option>-i
75
	<replaceable>NAME</replaceable></option></arg>
76
      </group>
77
      <sbr/>
78
      <group>
79
	<arg choice="plain"><option>--pubkey
80
	<replaceable>FILE</replaceable></option></arg>
81
	<arg choice="plain"><option>-p
82
	<replaceable>FILE</replaceable></option></arg>
83
      </group>
84
      <sbr/>
85
      <group>
86
	<arg choice="plain"><option>--seckey
87
	<replaceable>FILE</replaceable></option></arg>
88
	<arg choice="plain"><option>-s
89
	<replaceable>FILE</replaceable></option></arg>
90
      </group>
91
      <sbr/>
92
      <arg>
93
	<option>--priority <replaceable>STRING</replaceable></option>
94
      </arg>
95
      <sbr/>
96
      <arg>
97
	<option>--dh-bits <replaceable>BITS</replaceable></option>
98
      </arg>
99
      <sbr/>
100
      <arg>
101
	<option>--debug</option>
102
      </arg>
103
    </cmdsynopsis>
104
    <cmdsynopsis>
105
      <command>&COMMANDNAME;</command>
106
      <group choice="req">
129 by Teddy Hogeborn
* mandos-clients.conf.xml: Changed all single quotes to double quotes
107
	<arg choice="plain"><option>--help</option></arg>
108
	<arg choice="plain"><option>-?</option></arg>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
109
      </group>
110
    </cmdsynopsis>
111
    <cmdsynopsis>
112
      <command>&COMMANDNAME;</command>
129 by Teddy Hogeborn
* mandos-clients.conf.xml: Changed all single quotes to double quotes
113
      <arg choice="plain"><option>--usage</option></arg>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
114
    </cmdsynopsis>
115
    <cmdsynopsis>
116
      <command>&COMMANDNAME;</command>
117
      <group choice="req">
129 by Teddy Hogeborn
* mandos-clients.conf.xml: Changed all single quotes to double quotes
118
	<arg choice="plain"><option>--version</option></arg>
119
	<arg choice="plain"><option>-V</option></arg>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
120
      </group>
121
    </cmdsynopsis>
24.1.23 by Björn Påhlsson
Added manual pages for:
122
  </refsynopsisdiv>
123
124
  <refsect1 id="description">
125
    <title>DESCRIPTION</title>
126
    <para>
142 by Teddy Hogeborn
* plugins.d/password-request.c (main): Change default GnuTLS priority
127
      <command>&COMMANDNAME;</command> is a client program that
128
      communicates with <citerefentry><refentrytitle
129
      >mandos</refentrytitle><manvolnum>8</manvolnum></citerefentry>
130
      to get a password.  It uses IPv6 link-local addresses to get
145 by Teddy Hogeborn
* plugins.d/password-request.xml (DESCRIPTION): Improved wording.
131
      network connectivity, Zeroconf to find servers, and TLS with an
132
      OpenPGP key to ensure authenticity and confidentiality.  It
142 by Teddy Hogeborn
* plugins.d/password-request.c (main): Change default GnuTLS priority
133
      keeps running, trying all servers on the network, until it
145 by Teddy Hogeborn
* plugins.d/password-request.xml (DESCRIPTION): Improved wording.
134
      receives a satisfactory reply or a TERM signal is recieved.
142 by Teddy Hogeborn
* plugins.d/password-request.c (main): Change default GnuTLS priority
135
    </para>
136
    <para>
137
      This program is not meant to be run directly; it is really meant
138
      to run as a plugin of the <application>Mandos</application>
139
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
143 by Teddy Hogeborn
* Makefile (mandos.8): Add dependency on "overview.xml" and
140
      <manvolnum>8mandos</manvolnum></citerefentry>, which runs in the
141
      initial <acronym>RAM</acronym> disk environment because it is
142
      specified as a <quote>keyscript</quote> in the <citerefentry>
143
      <refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum>
144
      </citerefentry> file.
142 by Teddy Hogeborn
* plugins.d/password-request.c (main): Change default GnuTLS priority
145
    </para>
146
  </refsect1>
147
  
148
  <refsect1 id="purpose">
149
    <title>PURPOSE</title>
150
    <para>
151
      The purpose of this is to enable <emphasis>remote and unattended
152
      rebooting</emphasis> of client host computer with an
153
      <emphasis>encrypted root file system</emphasis>.  See <xref
154
      linkend="overview"/> for details.
155
    </para>
156
  </refsect1>
157
  
24.1.55 by Björn Påhlsson
updated some partial manual pages
158
  <refsect1 id="options">
159
    <title>OPTIONS</title>
160
    <para>
142 by Teddy Hogeborn
* plugins.d/password-request.c (main): Change default GnuTLS priority
161
      This program is commonly not invoked from the command line; it
162
      is normally started by the <application>Mandos</application>
163
      plugin runner, see <citerefentry><refentrytitle
164
      >plugin-runner</refentrytitle><manvolnum>8mandos</manvolnum>
165
      </citerefentry>.  Any command line options this program accepts
166
      are therefore normally provided by the plugin runner, and not
167
      directly.
24.1.55 by Björn Påhlsson
updated some partial manual pages
168
    </para>
142 by Teddy Hogeborn
* plugins.d/password-request.c (main): Change default GnuTLS priority
169
    
24.1.23 by Björn Påhlsson
Added manual pages for:
170
    <variablelist>
171
      <varlistentry>
127 by Teddy Hogeborn
* plugins.d/password-request.xml (OPTIONS): Make replaceables match
172
	<term><option>--connect=<replaceable
143 by Teddy Hogeborn
* Makefile (mandos.8): Add dependency on "overview.xml" and
173
	>ADDRESS</replaceable><literal>:</literal><replaceable
127 by Teddy Hogeborn
* plugins.d/password-request.xml (OPTIONS): Make replaceables match
174
	>PORT</replaceable></option></term>
175
	<term><option>-c
143 by Teddy Hogeborn
* Makefile (mandos.8): Add dependency on "overview.xml" and
176
	<replaceable>ADDRESS</replaceable><literal>:</literal
127 by Teddy Hogeborn
* plugins.d/password-request.xml (OPTIONS): Make replaceables match
177
	><replaceable>PORT</replaceable></option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
178
	<listitem>
179
	  <para>
142 by Teddy Hogeborn
* plugins.d/password-request.c (main): Change default GnuTLS priority
180
	    Do not use Zeroconf to locate servers.  Connect directly
181
	    to only one specified <application>Mandos</application>
182
	    server.  Note that an IPv6 address has colon characters in
183
	    it, so the <emphasis>last</emphasis> colon character is
184
	    assumed to separate the address from the port number.
185
	  </para>
186
	  <para>
143 by Teddy Hogeborn
* Makefile (mandos.8): Add dependency on "overview.xml" and
187
	    This option is normally only useful for testing and
188
	    debugging.
24.1.23 by Björn Påhlsson
Added manual pages for:
189
	  </para>
190
	</listitem>
191
      </varlistentry>
142 by Teddy Hogeborn
* plugins.d/password-request.c (main): Change default GnuTLS priority
192
      
24.1.23 by Björn Påhlsson
Added manual pages for:
193
      <varlistentry>
127 by Teddy Hogeborn
* plugins.d/password-request.xml (OPTIONS): Make replaceables match
194
	<term><option>--keydir=<replaceable
195
	>DIRECTORY</replaceable></option></term>
196
	<term><option>-d
197
	<replaceable>DIRECTORY</replaceable></option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
198
	<listitem>
199
	  <para>
142 by Teddy Hogeborn
* plugins.d/password-request.c (main): Change default GnuTLS priority
200
	    Directory to read the OpenPGP key files
201
	    <filename>pubkey.txt</filename> and
202
	    <filename>seckey.txt</filename> from.  The default is
203
	    <filename>/conf/conf.d/mandos</filename> (in the initial
204
	    <acronym>RAM</acronym> disk environment).
24.1.23 by Björn Påhlsson
Added manual pages for:
205
	  </para>
206
	</listitem>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
207
      </varlistentry>
24.1.23 by Björn Påhlsson
Added manual pages for:
208
209
      <varlistentry>
127 by Teddy Hogeborn
* plugins.d/password-request.xml (OPTIONS): Make replaceables match
210
	<term><option>--interface=
211
	<replaceable>NAME</replaceable></option></term>
212
	<term><option>-i
213
	<replaceable>NAME</replaceable></option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
214
	<listitem>
215
	  <para>
142 by Teddy Hogeborn
* plugins.d/password-request.c (main): Change default GnuTLS priority
216
	    Network interface that will be brought up and scanned for
217
	    Mandos servers to connect to.  The default it
218
	    <quote><literal>eth0</literal></quote>.
24.1.23 by Björn Påhlsson
Added manual pages for:
219
	  </para>
146 by Teddy Hogeborn
* plugins.d/password-request.xml (OPTIONS): Improved wording.
220
	  <para>
221
	    If the <option>--connect</option> option is used, this
222
	    specifies the interface to use to connect to the address
223
	    given.
224
	  </para>
24.1.23 by Björn Påhlsson
Added manual pages for:
225
	</listitem>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
226
      </varlistentry>
142 by Teddy Hogeborn
* plugins.d/password-request.c (main): Change default GnuTLS priority
227
      
24.1.23 by Björn Påhlsson
Added manual pages for:
228
      <varlistentry>
127 by Teddy Hogeborn
* plugins.d/password-request.xml (OPTIONS): Make replaceables match
229
	<term><option>--pubkey=<replaceable
230
	>FILE</replaceable></option></term>
231
	<term><option>-p
232
	<replaceable>FILE</replaceable></option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
233
	<listitem>
234
	  <para>
143 by Teddy Hogeborn
* Makefile (mandos.8): Add dependency on "overview.xml" and
235
	    OpenPGP public key file base name.  This will be combined
236
	    with the directory from the <option>--keydir</option>
237
	    option to form an absolute file name.  The default name is
142 by Teddy Hogeborn
* plugins.d/password-request.c (main): Change default GnuTLS priority
238
	    <quote><literal>pubkey.txt</literal></quote>.
24.1.23 by Björn Påhlsson
Added manual pages for:
239
	  </para>
240
	</listitem>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
241
      </varlistentry>
24.1.23 by Björn Påhlsson
Added manual pages for:
242
243
      <varlistentry>
127 by Teddy Hogeborn
* plugins.d/password-request.xml (OPTIONS): Make replaceables match
244
	<term><option>--seckey=<replaceable
245
	>FILE</replaceable></option></term>
246
	<term><option>-s
247
	<replaceable>FILE</replaceable></option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
248
	<listitem>
249
	  <para>
143 by Teddy Hogeborn
* Makefile (mandos.8): Add dependency on "overview.xml" and
250
	    OpenPGP secret key file base name.  This will be combined
251
	    with the directory from the <option>--keydir</option>
252
	    option to form an absolute file name.  The default name is
142 by Teddy Hogeborn
* plugins.d/password-request.c (main): Change default GnuTLS priority
253
	    <quote><literal>seckey.txt</literal></quote>.
24.1.23 by Björn Påhlsson
Added manual pages for:
254
	  </para>
255
	</listitem>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
256
      </varlistentry>
24.1.23 by Björn Påhlsson
Added manual pages for:
257
      
258
      <varlistentry>
127 by Teddy Hogeborn
* plugins.d/password-request.xml (OPTIONS): Make replaceables match
259
	<term><option>--priority=<replaceable
260
	>STRING</replaceable></option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
261
	<listitem>
143 by Teddy Hogeborn
* Makefile (mandos.8): Add dependency on "overview.xml" and
262
	  <xi:include href="../mandos-options.xml"
263
		      xpointer="priority"/>
24.1.23 by Björn Påhlsson
Added manual pages for:
264
	</listitem>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
265
      </varlistentry>
24.1.23 by Björn Påhlsson
Added manual pages for:
266
267
      <varlistentry>
127 by Teddy Hogeborn
* plugins.d/password-request.xml (OPTIONS): Make replaceables match
268
	<term><option>--dh-bits=<replaceable
269
	>BITS</replaceable></option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
270
	<listitem>
271
	  <para>
142 by Teddy Hogeborn
* plugins.d/password-request.c (main): Change default GnuTLS priority
272
	    Sets the number of bits to use for the prime number in the
273
	    TLS Diffie-Hellman key exchange.  Default is 1024.
24.1.23 by Björn Påhlsson
Added manual pages for:
274
	  </para>
275
	</listitem>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
276
      </varlistentry>
24.1.23 by Björn Påhlsson
Added manual pages for:
277
      
278
      <varlistentry>
127 by Teddy Hogeborn
* plugins.d/password-request.xml (OPTIONS): Make replaceables match
279
	<term><option>--debug</option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
280
	<listitem>
281
	  <para>
142 by Teddy Hogeborn
* plugins.d/password-request.c (main): Change default GnuTLS priority
282
	    Enable debug mode.  This will enable a lot of output to
283
	    standard error about what the program is doing.  The
284
	    program will still perform all other functions normally.
285
	  </para>
286
	  <para>
287
	    It will also enable debug mode in the Avahi and GnuTLS
288
	    libraries, making them print large amounts of debugging
289
	    output.
24.1.23 by Björn Påhlsson
Added manual pages for:
290
	  </para>
291
	</listitem>
292
      </varlistentry>
293
      
294
      <varlistentry>
127 by Teddy Hogeborn
* plugins.d/password-request.xml (OPTIONS): Make replaceables match
295
	<term><option>--help</option></term>
296
	<term><option>-?</option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
297
	<listitem>
298
	  <para>
142 by Teddy Hogeborn
* plugins.d/password-request.c (main): Change default GnuTLS priority
299
	    Gives a help message about options and their meanings.
24.1.23 by Björn Påhlsson
Added manual pages for:
300
	  </para>
301
	</listitem>
302
      </varlistentry>
303
      
304
      <varlistentry>
127 by Teddy Hogeborn
* plugins.d/password-request.xml (OPTIONS): Make replaceables match
305
	<term><option>--usage</option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
306
	<listitem>
307
	  <para>
142 by Teddy Hogeborn
* plugins.d/password-request.c (main): Change default GnuTLS priority
308
	    Gives a short usage message.
24.1.23 by Björn Påhlsson
Added manual pages for:
309
	  </para>
310
	</listitem>
311
      </varlistentry>
312
313
      <varlistentry>
127 by Teddy Hogeborn
* plugins.d/password-request.xml (OPTIONS): Make replaceables match
314
	<term><option>--version</option></term>
315
	<term><option>-V</option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
316
	<listitem>
317
	  <para>
142 by Teddy Hogeborn
* plugins.d/password-request.c (main): Change default GnuTLS priority
318
	    Prints the program version.
24.1.23 by Björn Påhlsson
Added manual pages for:
319
	  </para>
320
	</listitem>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
321
      </varlistentry>
24.1.23 by Björn Påhlsson
Added manual pages for:
322
    </variablelist>
323
  </refsect1>
24.1.55 by Björn Påhlsson
updated some partial manual pages
324
143 by Teddy Hogeborn
* Makefile (mandos.8): Add dependency on "overview.xml" and
325
  <refsect1 id="overview">
326
    <title>OVERVIEW</title>
327
    <xi:include href="../overview.xml"/>
328
    <para>
329
      This program is the client part.  It is a plugin started by
330
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
331
      <manvolnum>8mandos</manvolnum></citerefentry> which will run in
332
      an initial <acronym>RAM</acronym> disk environment.
333
    </para>
334
    <para>
335
      This program could, theoretically, be used as a keyscript in
336
      <filename>/etc/crypttab</filename>, but it would then be
144 by Teddy Hogeborn
* plugins.d/password-request.xml (OVERVIEW): Improved wording.
337
      impossible to enter a password for the encrypted root disk at
338
      the console, since this program does not read from the console
339
      at all.  This is why a separate plugin does that, which will be
340
      run in parallell to this one by the plugin runner.
143 by Teddy Hogeborn
* Makefile (mandos.8): Add dependency on "overview.xml" and
341
    </para>
342
  </refsect1>
343
  
24.1.55 by Björn Påhlsson
updated some partial manual pages
344
  <refsect1 id="exit_status">
345
    <title>EXIT STATUS</title>
346
    <para>
142 by Teddy Hogeborn
* plugins.d/password-request.c (main): Change default GnuTLS priority
347
      This program will exit with a successful (zero) exit status if a
348
      server could be found and the password received from it could be
349
      successfully decrypted and output on standard output.  The
350
      program will exit with a non-zero exit status only if a critical
351
      error occurs.  Otherwise, it will forever connect to new
144 by Teddy Hogeborn
* plugins.d/password-request.xml (OVERVIEW): Improved wording.
352
      <application>Mandos</application> servers as they appear, trying
353
      to get a decryptable password.
142 by Teddy Hogeborn
* plugins.d/password-request.c (main): Change default GnuTLS priority
354
    </para>
355
  </refsect1>
356
  
143 by Teddy Hogeborn
* Makefile (mandos.8): Add dependency on "overview.xml" and
357
  <refsect1 id="environment">
358
    <title>ENVIRONMENT</title>
359
    <para>
360
      This program does not use any environment variables, not even
361
      the ones provided by <citerefentry><refentrytitle
362
      >cryptsetup</refentrytitle><manvolnum>8</manvolnum>
363
    </citerefentry>.
364
    </para>
365
  </refsect1>
142 by Teddy Hogeborn
* plugins.d/password-request.c (main): Change default GnuTLS priority
366
  
24.1.55 by Björn Påhlsson
updated some partial manual pages
367
  <refsect1 id="file">
368
    <title>FILES</title>
146 by Teddy Hogeborn
* plugins.d/password-request.xml (OPTIONS): Improved wording.
369
    <variablelist>
370
      <varlistentry>
371
	<term><filename>/conf/conf.d/mandos/pubkey.txt</filename
372
	></term>
373
	<term><filename>/conf/conf.d/mandos/seckey.txt</filename
374
	></term>
375
	<listitem>
376
	  <para>
377
	    OpenPGP public and private key files, in <quote>ASCII
378
	    Armor</quote> format.  These are the default file names,
379
	    they can be changed with the <option>--pubkey</option> and
380
	    <option>--seckey</option> options.
381
	  </para>
382
	</listitem>
383
      </varlistentry>
384
    </variablelist>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
385
  </refsect1>
24.1.55 by Björn Påhlsson
updated some partial manual pages
386
  
146 by Teddy Hogeborn
* plugins.d/password-request.xml (OPTIONS): Improved wording.
387
<!--   <refsect1 id="bugs"> -->
388
<!--     <title>BUGS</title> -->
389
<!--     <para> -->
390
<!--     </para> -->
391
<!--   </refsect1> -->
24.1.55 by Björn Påhlsson
updated some partial manual pages
392
87 by Teddy Hogeborn
* Makefile: Bug fix: fixed creation of man pages in "plugins.d".
393
  <refsect1 id="example">
394
    <title>EXAMPLE</title>
24.1.55 by Björn Påhlsson
updated some partial manual pages
395
    <para>
146 by Teddy Hogeborn
* plugins.d/password-request.xml (OPTIONS): Improved wording.
396
      Note that normally, command line options will not be given
397
      directly, but via options for the Mandos <citerefentry
398
      ><refentrytitle>plugin-runner</refentrytitle>
399
      <manvolnum>8mandos</manvolnum></citerefentry>.
24.1.55 by Björn Påhlsson
updated some partial manual pages
400
    </para>
146 by Teddy Hogeborn
* plugins.d/password-request.xml (OPTIONS): Improved wording.
401
    <informalexample>
402
      <para>
403
	Normal invocation needs no options, if the network interface
404
	is <quote>eth0</quote>:
405
      </para>
406
      <para>
407
	<userinput>&COMMANDNAME;</userinput>
408
      </para>
409
    </informalexample>
410
    <informalexample>
411
      <para>
412
	Search for Mandos servers on another interface:
413
      </para>
414
      <para>
415
	<!-- do not wrap this line -->
416
	<userinput>&COMMANDNAME; --interface eth1</userinput>
417
      </para>
418
    </informalexample>
419
    <informalexample>
420
      <para>
421
	Run in debug mode, and use a custom key directory:
422
      </para>
423
      <para>
424
	<!-- do not wrap this line -->
425
	<userinput>&COMMANDNAME; --debug --keydir keydir</userinput>
426
      </para>
427
    </informalexample>
428
    <informalexample>
429
      <para>
430
	Run in debug mode, with a custom key directory, and do not use
431
	Zeroconf to locate a server; connect directly to the IPv6
432
	address <quote><systemitem class="ipaddress"
433
	>2001:db8:f983:bd0b:30de:ae4a:71f2:f672</systemitem></quote>,
434
	port 4711, using interface eth2:
435
      </para>
436
      <para>
437
438
<!-- do not wrap this line -->
439
<userinput>&COMMANDNAME; --debug --keydir keydir --connect 2001:db8:f983:bd0b:30de:ae4a:71f2:f672:4711 --interface eth2</userinput>
440
441
      </para>
442
    </informalexample>
24.1.55 by Björn Påhlsson
updated some partial manual pages
443
  </refsect1>
444
445
  <refsect1 id="security">
446
    <title>SECURITY</title>
447
    <para>
448
    </para>
449
  </refsect1>
450
451
  <refsect1 id="see_also">
452
    <title>SEE ALSO</title>
114 by Teddy Hogeborn
* mandos-clients.conf.xml (SEE ALSO): Alphabetized, as per
453
    <para>
454
      <citerefentry><refentrytitle>mandos</refentrytitle>
455
      <manvolnum>8</manvolnum></citerefentry>,
456
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
457
      <manvolnum>8mandos</manvolnum></citerefentry>,
458
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
459
      <manvolnum>8mandos</manvolnum></citerefentry>
460
    </para>
81 by Teddy Hogeborn
* Makefile (GNUTLS_CFLAGS, GNUTLS_LIBS, AVAHI_CFLAGS, AVAHI_LIBS,
461
    <itemizedlist>
462
      <listitem><para>
463
	<ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
464
      </para></listitem>
465
      
466
      <listitem><para>
467
	<ulink url="http://www.avahi.org/">Avahi</ulink>
468
      </para></listitem>
469
      
470
      <listitem><para>
471
	<ulink
472
	    url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
473
      </para></listitem>
474
      
475
      <listitem><para>
476
	<ulink
143 by Teddy Hogeborn
* Makefile (mandos.8): Add dependency on "overview.xml" and
477
	url="http://www.gnupg.org/related_software/gpgme/"
478
	>GPGME</ulink>
81 by Teddy Hogeborn
* Makefile (GNUTLS_CFLAGS, GNUTLS_LIBS, AVAHI_CFLAGS, AVAHI_LIBS,
479
      </para></listitem>
480
      
481
      <listitem><para>
482
	<citation>RFC 4880: <citetitle>OpenPGP Message
483
	Format</citetitle></citation>
484
      </para></listitem>
485
      
486
      <listitem><para>
487
	<citation>RFC 5081: <citetitle>Using OpenPGP Keys for
488
	Transport Layer Security</citetitle></citation>
489
      </para></listitem>
490
      
491
      <listitem><para>
492
	<citation>RFC 4291: <citetitle>IP Version 6 Addressing
493
	Architecture</citetitle>, section 2.5.6, Link-Local IPv6
494
	Unicast Addresses</citation>
495
      </para></listitem>
496
    </itemizedlist>
497
  </refsect1>
498
24.1.23 by Björn Påhlsson
Added manual pages for:
499
</refentry>
111 by Teddy Hogeborn
* mandos-clients.conf.xml (ENTITY TIMESTAMP): New. Automatically
500
<!-- Local Variables: -->
501
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
502
<!-- time-stamp-end: "[\"']>" -->
503
<!-- time-stamp-format: "%:y-%02m-%02d" -->
504
<!-- End: -->