/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release
24.1.23 by Björn Påhlsson
Added manual pages for:
1
<?xml version='1.0' encoding='UTF-8'?>
2
<?xml-stylesheet type="text/xsl"
3
	href="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"?>
4
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
5
	"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
6
<!ENTITY VERSION "1.0">
7
<!ENTITY COMMANDNAME "password-request">
122 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Put long options before short.
8
<!ENTITY TIMESTAMP "2008-08-31">
24.1.23 by Björn Påhlsson
Added manual pages for:
9
]>
10
11
<refentry>
12
  <refentryinfo>
112 by Teddy Hogeborn
* mandos-clients.conf.xml (/refentry/refentryinfo/title): Changed to
13
    <title>Mandos Manual</title>
24.1.23 by Björn Påhlsson
Added manual pages for:
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>
24.1.23 by Björn Påhlsson
Added manual pages for:
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>
23
	  <email>belorn@fukt.bsnet.se</email>
24
	</address>
25
      </author>
26
      <author>
27
	<firstname>Teddy</firstname>
28
	<surname>Hogeborn</surname>
29
	<address>
30
	  <email>teddy@fukt.bsnet.se</email>
31
	</address>
32
      </author>
33
    </authorgroup>
34
    <copyright>
35
      <year>2008</year>
36
      <holder>Teddy Hogeborn &amp; Björn Påhlsson</holder>
37
    </copyright>
38
    <legalnotice>
39
      <para>
40
	This manual page is free software: you can redistribute it
41
	and/or modify it under the terms of the GNU General Public
42
	License as published by the Free Software Foundation,
43
	either version 3 of the License, or (at your option) any
44
	later version.
45
      </para>
46
47
      <para>
48
	This manual page is distributed in the hope that it will
49
	be useful, but WITHOUT ANY WARRANTY; without even the
50
	implied warranty of MERCHANTABILITY or FITNESS FOR A
51
	PARTICULAR PURPOSE.  See the GNU General Public License
52
	for more details.
53
      </para>
54
55
      <para>
56
	You should have received a copy of the GNU General Public
57
	License along with this program; If not, see
58
	<ulink url="http://www.gnu.org/licenses/"/>.
59
      </para>
60
    </legalnotice>
61
  </refentryinfo>
62
63
  <refmeta>
64
    <refentrytitle>&COMMANDNAME;</refentrytitle>
65
    <manvolnum>8mandos</manvolnum>
66
  </refmeta>
67
  
68
  <refnamediv>
69
    <refname><command>&COMMANDNAME;</command></refname>
70
    <refpurpose>
71
      Client for mandos
72
    </refpurpose>
73
  </refnamediv>
74
75
  <refsynopsisdiv>
76
    <cmdsynopsis>
77
      <command>&COMMANDNAME;</command>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
78
      <group>
79
	<arg choice="plain"><option>--connect
80
	<replaceable>IPADDR</replaceable><literal>:</literal
81
	><replaceable>PORT</replaceable></option></arg>
82
	<arg choice="plain"><option>-c
83
	<replaceable>IPADDR</replaceable><literal>:</literal
84
	><replaceable>PORT</replaceable></option></arg>
85
      </group>
86
      <sbr/>
87
      <group>
88
	<arg choice="plain"><option>--keydir
127 by Teddy Hogeborn
* plugins.d/password-request.xml (OPTIONS): Make replaceables match
89
	<replaceable>DIRECTORY</replaceable></option></arg>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
90
	<arg choice="plain"><option>-d
127 by Teddy Hogeborn
* plugins.d/password-request.xml (OPTIONS): Make replaceables match
91
	<replaceable>DIRECTORY</replaceable></option></arg>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
92
      </group>
93
      <sbr/>
94
      <group>
95
	<arg choice="plain"><option>--interface
96
	<replaceable>NAME</replaceable></option></arg>
97
	<arg choice="plain"><option>-i
98
	<replaceable>NAME</replaceable></option></arg>
99
      </group>
100
      <sbr/>
101
      <group>
102
	<arg choice="plain"><option>--pubkey
103
	<replaceable>FILE</replaceable></option></arg>
104
	<arg choice="plain"><option>-p
105
	<replaceable>FILE</replaceable></option></arg>
106
      </group>
107
      <sbr/>
108
      <group>
109
	<arg choice="plain"><option>--seckey
110
	<replaceable>FILE</replaceable></option></arg>
111
	<arg choice="plain"><option>-s
112
	<replaceable>FILE</replaceable></option></arg>
113
      </group>
114
      <sbr/>
115
      <arg>
116
	<option>--priority <replaceable>STRING</replaceable></option>
117
      </arg>
118
      <sbr/>
119
      <arg>
120
	<option>--dh-bits <replaceable>BITS</replaceable></option>
121
      </arg>
122
      <sbr/>
123
      <arg>
124
	<option>--debug</option>
125
      </arg>
126
    </cmdsynopsis>
127
    <cmdsynopsis>
128
      <command>&COMMANDNAME;</command>
129
      <group choice="req">
122 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Put long options before short.
130
	<arg choice='plain'><option>--help</option></arg>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
131
	<arg choice='plain'><option>-?</option></arg>
132
      </group>
133
    </cmdsynopsis>
134
    <cmdsynopsis>
135
      <command>&COMMANDNAME;</command>
136
      <arg choice='plain'><option>--usage</option></arg>
137
    </cmdsynopsis>
138
    <cmdsynopsis>
139
      <command>&COMMANDNAME;</command>
140
      <group choice="req">
122 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Put long options before short.
141
	<arg choice='plain'><option>--version</option></arg>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
142
	<arg choice='plain'><option>-V</option></arg>
143
      </group>
144
    </cmdsynopsis>
24.1.23 by Björn Påhlsson
Added manual pages for:
145
  </refsynopsisdiv>
146
147
  <refsect1 id="description">
148
    <title>DESCRIPTION</title>
149
    <para>
150
      <command>&COMMANDNAME;</command> is a mandos plugin that works
151
      like a client program that through avahi detects mandos servers,
152
      sets up a gnutls connect and request a encrypted password. Any
153
      passwords given is automaticly decrypted and passed to
154
      cryptsetup.
155
    </para>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
156
  </refsect1>
24.1.55 by Björn Påhlsson
updated some partial manual pages
157
  
158
  <refsect1 id="options">
159
    <title>OPTIONS</title>
160
    <para>
161
      Commonly not invoked as command lines but from configuration
162
      file of plugin runner.
163
    </para>
24.1.23 by Björn Påhlsson
Added manual pages for:
164
165
    <variablelist>
166
      <varlistentry>
127 by Teddy Hogeborn
* plugins.d/password-request.xml (OPTIONS): Make replaceables match
167
	<term><option>--connect=<replaceable
168
	>IPADDR</replaceable><literal>:</literal><replaceable
169
	>PORT</replaceable></option></term>
170
	<term><option>-c
171
	<replaceable>IPADDR</replaceable><literal>:</literal
172
	><replaceable>PORT</replaceable></option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
173
	<listitem>
174
	  <para>
81 by Teddy Hogeborn
* Makefile (GNUTLS_CFLAGS, GNUTLS_LIBS, AVAHI_CFLAGS, AVAHI_LIBS,
175
	    Connect directly to a specified mandos server
24.1.23 by Björn Påhlsson
Added manual pages for:
176
	  </para>
177
	</listitem>
178
      </varlistentry>
179
180
      <varlistentry>
127 by Teddy Hogeborn
* plugins.d/password-request.xml (OPTIONS): Make replaceables match
181
	<term><option>--keydir=<replaceable
182
	>DIRECTORY</replaceable></option></term>
183
	<term><option>-d
184
	<replaceable>DIRECTORY</replaceable></option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
185
	<listitem>
186
	  <para>
187
	    Directory where the openpgp keyring is
188
	  </para>
189
	</listitem>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
190
      </varlistentry>
24.1.23 by Björn Påhlsson
Added manual pages for:
191
192
      <varlistentry>
127 by Teddy Hogeborn
* plugins.d/password-request.xml (OPTIONS): Make replaceables match
193
	<term><option>--interface=
194
	<replaceable>NAME</replaceable></option></term>
195
	<term><option>-i
196
	<replaceable>NAME</replaceable></option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
197
	<listitem>
198
	  <para>
127 by Teddy Hogeborn
* plugins.d/password-request.xml (OPTIONS): Make replaceables match
199
	    Interface that Avahi will connect through
24.1.23 by Björn Påhlsson
Added manual pages for:
200
	  </para>
201
	</listitem>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
202
      </varlistentry>
24.1.23 by Björn Påhlsson
Added manual pages for:
203
204
      <varlistentry>
127 by Teddy Hogeborn
* plugins.d/password-request.xml (OPTIONS): Make replaceables match
205
	<term><option>--pubkey=<replaceable
206
	>FILE</replaceable></option></term>
207
	<term><option>-p
208
	<replaceable>FILE</replaceable></option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
209
	<listitem>
210
	  <para>
211
	    Public openpgp key for gnutls authentication
212
	  </para>
213
	</listitem>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
214
      </varlistentry>
24.1.23 by Björn Påhlsson
Added manual pages for:
215
216
      <varlistentry>
127 by Teddy Hogeborn
* plugins.d/password-request.xml (OPTIONS): Make replaceables match
217
	<term><option>--seckey=<replaceable
218
	>FILE</replaceable></option></term>
219
	<term><option>-s
220
	<replaceable>FILE</replaceable></option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
221
	<listitem>
222
	  <para>
127 by Teddy Hogeborn
* plugins.d/password-request.xml (OPTIONS): Make replaceables match
223
	    Secret OpenPGP key for GnuTLS authentication
24.1.23 by Björn Påhlsson
Added manual pages for:
224
	  </para>
225
	</listitem>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
226
      </varlistentry>
24.1.23 by Björn Påhlsson
Added manual pages for:
227
      
228
      <varlistentry>
127 by Teddy Hogeborn
* plugins.d/password-request.xml (OPTIONS): Make replaceables match
229
	<term><option>--priority=<replaceable
230
	>STRING</replaceable></option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
231
	<listitem>
232
	  <para>
127 by Teddy Hogeborn
* plugins.d/password-request.xml (OPTIONS): Make replaceables match
233
	    GnuTLS priority
24.1.23 by Björn Påhlsson
Added manual pages for:
234
	  </para>
235
	</listitem>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
236
      </varlistentry>
24.1.23 by Björn Påhlsson
Added manual pages for:
237
238
      <varlistentry>
127 by Teddy Hogeborn
* plugins.d/password-request.xml (OPTIONS): Make replaceables match
239
	<term><option>--dh-bits=<replaceable
240
	>BITS</replaceable></option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
241
	<listitem>
242
	  <para>
127 by Teddy Hogeborn
* plugins.d/password-request.xml (OPTIONS): Make replaceables match
243
	    DH bits to use in gnutls communication
24.1.23 by Björn Påhlsson
Added manual pages for:
244
	  </para>
245
	</listitem>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
246
      </varlistentry>
24.1.23 by Björn Påhlsson
Added manual pages for:
247
      
248
      <varlistentry>
127 by Teddy Hogeborn
* plugins.d/password-request.xml (OPTIONS): Make replaceables match
249
	<term><option>--debug</option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
250
	<listitem>
251
	  <para>
252
	    Debug mode
253
	  </para>
254
	</listitem>
255
      </varlistentry>
256
      
257
      <varlistentry>
127 by Teddy Hogeborn
* plugins.d/password-request.xml (OPTIONS): Make replaceables match
258
	<term><option>--help</option></term>
259
	<term><option>-?</option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
260
	<listitem>
261
	  <para>
262
	    Gives a help message
263
	  </para>
264
	</listitem>
265
      </varlistentry>
266
      
267
      <varlistentry>
127 by Teddy Hogeborn
* plugins.d/password-request.xml (OPTIONS): Make replaceables match
268
	<term><option>--usage</option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
269
	<listitem>
270
	  <para>
271
	    Gives a short usage message
272
	  </para>
273
	</listitem>
274
      </varlistentry>
275
276
      <varlistentry>
127 by Teddy Hogeborn
* plugins.d/password-request.xml (OPTIONS): Make replaceables match
277
	<term><option>--version</option></term>
278
	<term><option>-V</option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
279
	<listitem>
280
	  <para>
281
	    Prints the program version
282
	  </para>
283
	</listitem>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
284
      </varlistentry>
24.1.23 by Björn Påhlsson
Added manual pages for:
285
    </variablelist>
286
  </refsect1>
24.1.55 by Björn Påhlsson
updated some partial manual pages
287
288
  <refsect1 id="exit_status">
289
    <title>EXIT STATUS</title>
290
    <para>
291
    </para>
292
  </refsect1>
293
87 by Teddy Hogeborn
* Makefile: Bug fix: fixed creation of man pages in "plugins.d".
294
  <refsect1 id="environment">
295
    <title>ENVIRONMENT</title>
296
    <para>
297
    </para>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
298
  </refsect1>
87 by Teddy Hogeborn
* Makefile: Bug fix: fixed creation of man pages in "plugins.d".
299
24.1.55 by Björn Påhlsson
updated some partial manual pages
300
  <refsect1 id="file">
301
    <title>FILES</title>
302
    <para>
303
    </para>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
304
  </refsect1>
24.1.55 by Björn Påhlsson
updated some partial manual pages
305
  
306
  <refsect1 id="bugs">
307
    <title>BUGS</title>
308
    <para>
309
    </para>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
310
  </refsect1>
24.1.55 by Björn Påhlsson
updated some partial manual pages
311
87 by Teddy Hogeborn
* Makefile: Bug fix: fixed creation of man pages in "plugins.d".
312
  <refsect1 id="example">
313
    <title>EXAMPLE</title>
24.1.55 by Björn Påhlsson
updated some partial manual pages
314
    <para>
315
    </para>
316
  </refsect1>
317
318
  <refsect1 id="security">
319
    <title>SECURITY</title>
320
    <para>
321
    </para>
322
  </refsect1>
323
324
  <refsect1 id="see_also">
325
    <title>SEE ALSO</title>
114 by Teddy Hogeborn
* mandos-clients.conf.xml (SEE ALSO): Alphabetized, as per
326
    <para>
327
      <citerefentry><refentrytitle>mandos</refentrytitle>
328
      <manvolnum>8</manvolnum></citerefentry>,
329
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
330
      <manvolnum>8mandos</manvolnum></citerefentry>,
331
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
332
      <manvolnum>8mandos</manvolnum></citerefentry>
333
    </para>
81 by Teddy Hogeborn
* Makefile (GNUTLS_CFLAGS, GNUTLS_LIBS, AVAHI_CFLAGS, AVAHI_LIBS,
334
    <itemizedlist>
335
      <listitem><para>
336
	<ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
337
      </para></listitem>
338
      
339
      <listitem><para>
340
	<ulink url="http://www.avahi.org/">Avahi</ulink>
341
      </para></listitem>
342
      
343
      <listitem><para>
344
	<ulink
345
	    url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
346
      </para></listitem>
347
      
348
      <listitem><para>
349
	<ulink
350
	url="http://www.gnupg.org/related_software/gpgme/">
351
	GPGME</ulink>
352
      </para></listitem>
353
      
354
      <listitem><para>
355
	<citation>RFC 4880: <citetitle>OpenPGP Message
356
	Format</citetitle></citation>
357
      </para></listitem>
358
      
359
      <listitem><para>
360
	<citation>RFC 5081: <citetitle>Using OpenPGP Keys for
361
	Transport Layer Security</citetitle></citation>
362
      </para></listitem>
363
      
364
      <listitem><para>
365
	<citation>RFC 4291: <citetitle>IP Version 6 Addressing
366
	Architecture</citetitle>, section 2.5.6, Link-Local IPv6
367
	Unicast Addresses</citation>
368
      </para></listitem>
369
    </itemizedlist>
370
  </refsect1>
371
24.1.23 by Björn Påhlsson
Added manual pages for:
372
</refentry>
111 by Teddy Hogeborn
* mandos-clients.conf.xml (ENTITY TIMESTAMP): New. Automatically
373
<!-- Local Variables: -->
374
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
375
<!-- time-stamp-end: "[\"']>" -->
376
<!-- time-stamp-format: "%:y-%02m-%02d" -->
377
<!-- End: -->