/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
89
	<replaceable>KEYDIR</replaceable></option></arg>
90
	<arg choice="plain"><option>-d
91
	<replaceable>KEYDIR</replaceable></option></arg>
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>
167
	<term><literal>-c</literal>, <literal>--connect=<replaceable>
168
	IP</replaceable></literal></term>
169
	<listitem>
170
	  <para>
81 by Teddy Hogeborn
* Makefile (GNUTLS_CFLAGS, GNUTLS_LIBS, AVAHI_CFLAGS, AVAHI_LIBS,
171
	    Connect directly to a specified mandos server
24.1.23 by Björn Påhlsson
Added manual pages for:
172
	  </para>
173
	</listitem>
174
      </varlistentry>
175
176
      <varlistentry>
177
	<term><literal>-d</literal>, <literal>--keydir=<replaceable>
178
	KEYDIR</replaceable></literal></term>
179
	<listitem>
180
	  <para>
181
	    Directory where the openpgp keyring is
182
	  </para>
183
	</listitem>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
184
      </varlistentry>
24.1.23 by Björn Påhlsson
Added manual pages for:
185
186
      <varlistentry>
187
	<term><literal>-i</literal>, <literal>--interface=
188
	<replaceable>INTERFACE</replaceable></literal></term>
189
	<listitem>
190
	  <para>
191
	    Interface that Avahi will conntect through
192
	  </para>
193
	</listitem>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
194
      </varlistentry>
24.1.23 by Björn Påhlsson
Added manual pages for:
195
196
      <varlistentry>
197
	<term><literal>-p</literal>, <literal>--pubkey=<replaceable>
198
	PUBKEY</replaceable></literal></term>
199
	<listitem>
200
	  <para>
201
	    Public openpgp key for gnutls authentication
202
	  </para>
203
	</listitem>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
204
      </varlistentry>
24.1.23 by Björn Påhlsson
Added manual pages for:
205
206
      <varlistentry>
207
	<term><literal>-s</literal>, <literal>--seckey=<replaceable>
208
	SECKEY</replaceable></literal></term>
209
	<listitem>
210
	  <para>
211
	    Secret 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>
217
	<term><literal>--priority=<replaceable>PRIORITY</replaceable>
218
	</literal></term>
219
	<listitem>
220
	  <para>
221
	    GNUTLS priority
222
	  </para>
223
	</listitem>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
224
      </varlistentry>
24.1.23 by Björn Påhlsson
Added manual pages for:
225
226
      <varlistentry>
227
	<term><literal>--dh-bits=<replaceable>BITS</replaceable>
228
	</literal></term>
229
	<listitem>
230
	  <para>
231
	    dh-bits to use in gnutls communication
232
	  </para>
233
	</listitem>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
234
      </varlistentry>
24.1.23 by Björn Påhlsson
Added manual pages for:
235
      
236
      <varlistentry>
237
	<term><literal>--debug</literal></term>
238
	<listitem>
239
	  <para>
240
	    Debug mode
241
	  </para>
242
	</listitem>
243
      </varlistentry>
244
      
245
      <varlistentry>
246
	<term><literal>-?</literal>, <literal>--help</literal></term>
247
	<listitem>
248
	  <para>
249
	    Gives a help message
250
	  </para>
251
	</listitem>
252
      </varlistentry>
253
      
254
      <varlistentry>
255
	<term><literal>--usage</literal></term>
256
	<listitem>
257
	  <para>
258
	    Gives a short usage message
259
	  </para>
260
	</listitem>
261
      </varlistentry>
262
263
      <varlistentry>
264
	<term><literal>-V</literal>, <literal>--version</literal></term>
265
	<listitem>
266
	  <para>
267
	    Prints the program version
268
	  </para>
269
	</listitem>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
270
      </varlistentry>
24.1.23 by Björn Påhlsson
Added manual pages for:
271
    </variablelist>
272
  </refsect1>
24.1.55 by Björn Påhlsson
updated some partial manual pages
273
274
  <refsect1 id="exit_status">
275
    <title>EXIT STATUS</title>
276
    <para>
277
    </para>
278
  </refsect1>
279
87 by Teddy Hogeborn
* Makefile: Bug fix: fixed creation of man pages in "plugins.d".
280
  <refsect1 id="environment">
281
    <title>ENVIRONMENT</title>
282
    <para>
283
    </para>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
284
  </refsect1>
87 by Teddy Hogeborn
* Makefile: Bug fix: fixed creation of man pages in "plugins.d".
285
24.1.55 by Björn Påhlsson
updated some partial manual pages
286
  <refsect1 id="file">
287
    <title>FILES</title>
288
    <para>
289
    </para>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
290
  </refsect1>
24.1.55 by Björn Påhlsson
updated some partial manual pages
291
  
292
  <refsect1 id="bugs">
293
    <title>BUGS</title>
294
    <para>
295
    </para>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
296
  </refsect1>
24.1.55 by Björn Påhlsson
updated some partial manual pages
297
87 by Teddy Hogeborn
* Makefile: Bug fix: fixed creation of man pages in "plugins.d".
298
  <refsect1 id="example">
299
    <title>EXAMPLE</title>
24.1.55 by Björn Påhlsson
updated some partial manual pages
300
    <para>
301
    </para>
302
  </refsect1>
303
304
  <refsect1 id="security">
305
    <title>SECURITY</title>
306
    <para>
307
    </para>
308
  </refsect1>
309
310
  <refsect1 id="see_also">
311
    <title>SEE ALSO</title>
114 by Teddy Hogeborn
* mandos-clients.conf.xml (SEE ALSO): Alphabetized, as per
312
    <para>
313
      <citerefentry><refentrytitle>mandos</refentrytitle>
314
      <manvolnum>8</manvolnum></citerefentry>,
315
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
316
      <manvolnum>8mandos</manvolnum></citerefentry>,
317
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
318
      <manvolnum>8mandos</manvolnum></citerefentry>
319
    </para>
81 by Teddy Hogeborn
* Makefile (GNUTLS_CFLAGS, GNUTLS_LIBS, AVAHI_CFLAGS, AVAHI_LIBS,
320
    <itemizedlist>
321
      <listitem><para>
322
	<ulink url="http://www.zeroconf.org/">Zeroconf</ulink>
323
      </para></listitem>
324
      
325
      <listitem><para>
326
	<ulink url="http://www.avahi.org/">Avahi</ulink>
327
      </para></listitem>
328
      
329
      <listitem><para>
330
	<ulink
331
	    url="http://www.gnu.org/software/gnutls/">GnuTLS</ulink>
332
      </para></listitem>
333
      
334
      <listitem><para>
335
	<ulink
336
	url="http://www.gnupg.org/related_software/gpgme/">
337
	GPGME</ulink>
338
      </para></listitem>
339
      
340
      <listitem><para>
341
	<citation>RFC 4880: <citetitle>OpenPGP Message
342
	Format</citetitle></citation>
343
      </para></listitem>
344
      
345
      <listitem><para>
346
	<citation>RFC 5081: <citetitle>Using OpenPGP Keys for
347
	Transport Layer Security</citetitle></citation>
348
      </para></listitem>
349
      
350
      <listitem><para>
351
	<citation>RFC 4291: <citetitle>IP Version 6 Addressing
352
	Architecture</citetitle>, section 2.5.6, Link-Local IPv6
353
	Unicast Addresses</citation>
354
      </para></listitem>
355
    </itemizedlist>
356
  </refsect1>
357
24.1.23 by Björn Påhlsson
Added manual pages for:
358
</refentry>
111 by Teddy Hogeborn
* mandos-clients.conf.xml (ENTITY TIMESTAMP): New. Automatically
359
<!-- Local Variables: -->
360
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
361
<!-- time-stamp-end: "[\"']>" -->
362
<!-- time-stamp-format: "%:y-%02m-%02d" -->
363
<!-- End: -->