/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to mandos-keygen.xml

* mandos-keygen (password): Remove bashism "${PIPESTATUS}".

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-keygen.xml
1
1
<?xml version="1.0" encoding="UTF-8"?>
2
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
3
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
 
<!ENTITY VERSION "1.0">
5
4
<!ENTITY COMMANDNAME "mandos-keygen">
6
 
<!ENTITY TIMESTAMP "2008-08-31">
 
5
<!ENTITY TIMESTAMP "2009-01-04">
 
6
<!ENTITY % common SYSTEM "common.ent">
 
7
%common;
7
8
]>
8
9
 
9
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
12
    <title>Mandos Manual</title>
12
13
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
13
14
    <productname>Mandos</productname>
14
 
    <productnumber>&VERSION;</productnumber>
 
15
    <productnumber>&version;</productnumber>
15
16
    <date>&TIMESTAMP;</date>
16
17
    <authorgroup>
17
18
      <author>
31
32
    </authorgroup>
32
33
    <copyright>
33
34
      <year>2008</year>
 
35
      <year>2009</year>
34
36
      <holder>Teddy Hogeborn</holder>
35
37
      <holder>Björn Påhlsson</holder>
36
38
    </copyright>
37
39
    <xi:include href="legalnotice.xml"/>
38
40
  </refentryinfo>
39
 
 
 
41
  
40
42
  <refmeta>
41
43
    <refentrytitle>&COMMANDNAME;</refentrytitle>
42
44
    <manvolnum>8</manvolnum>
48
50
      Generate key and password for Mandos client and server.
49
51
    </refpurpose>
50
52
  </refnamediv>
51
 
 
 
53
  
52
54
  <refsynopsisdiv>
53
55
    <cmdsynopsis>
54
56
      <command>&COMMANDNAME;</command>
122
124
      <group choice="req">
123
125
        <arg choice="plain"><option>--password</option></arg>
124
126
        <arg choice="plain"><option>-p</option></arg>
 
127
        <arg choice="plain"><option>--passfile
 
128
        <replaceable>FILE</replaceable></option></arg>
 
129
        <arg choice="plain"><option>-F</option>
 
130
        <replaceable>FILE</replaceable></arg>
125
131
      </group>
126
132
      <sbr/>
127
133
      <group>
159
165
    <para>
160
166
      <command>&COMMANDNAME;</command> is a program to generate the
161
167
      OpenPGP key used by
162
 
      <citerefentry><refentrytitle>password-request</refentrytitle>
 
168
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
163
169
      <manvolnum>8mandos</manvolnum></citerefentry>.  The key is
164
170
      normally written to /etc/mandos for later installation into the
165
171
      initrd image, but this, and most other things, can be changed
167
173
    </para>
168
174
    <para>
169
175
      This program can also be used with the
170
 
      <option>--password</option> option to generate a ready-made
171
 
      section for <filename>clients.conf</filename> (see
 
176
      <option>--password</option> or <option>--passfile</option>
 
177
      options to generate a ready-made section for
 
178
      <filename>clients.conf</filename> (see
172
179
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
173
180
      <manvolnum>5</manvolnum></citerefentry>).
174
181
    </para>
197
204
          </para>
198
205
        </listitem>
199
206
      </varlistentry>
200
 
 
 
207
      
201
208
      <varlistentry>
202
209
        <term><option>--dir
203
210
        <replaceable>DIRECTORY</replaceable></option></term>
210
217
          </para>
211
218
        </listitem>
212
219
      </varlistentry>
213
 
 
 
220
      
214
221
      <varlistentry>
215
222
        <term><option>--type
216
223
        <replaceable>TYPE</replaceable></option></term>
222
229
          </para>
223
230
        </listitem>
224
231
      </varlistentry>
225
 
 
 
232
      
226
233
      <varlistentry>
227
234
        <term><option>--length
228
235
        <replaceable>BITS</replaceable></option></term>
234
241
          </para>
235
242
        </listitem>
236
243
      </varlistentry>
237
 
 
 
244
      
238
245
      <varlistentry>
239
246
        <term><option>--subtype
240
247
        <replaceable>KEYTYPE</replaceable></option></term>
247
254
          </para>
248
255
        </listitem>
249
256
      </varlistentry>
250
 
 
 
257
      
251
258
      <varlistentry>
252
259
        <term><option>--sublength
253
260
        <replaceable>BITS</replaceable></option></term>
259
266
          </para>
260
267
        </listitem>
261
268
      </varlistentry>
262
 
 
 
269
      
263
270
      <varlistentry>
264
271
        <term><option>--email
265
272
        <replaceable>ADDRESS</replaceable></option></term>
271
278
          </para>
272
279
        </listitem>
273
280
      </varlistentry>
274
 
 
 
281
      
275
282
      <varlistentry>
276
283
        <term><option>--comment
277
284
        <replaceable>TEXT</replaceable></option></term>
284
291
          </para>
285
292
        </listitem>
286
293
      </varlistentry>
287
 
 
 
294
      
288
295
      <varlistentry>
289
296
        <term><option>--expire
290
297
        <replaceable>TIME</replaceable></option></term>
298
305
          </para>
299
306
        </listitem>
300
307
      </varlistentry>
301
 
 
 
308
      
302
309
      <varlistentry>
303
310
        <term><option>--force</option></term>
304
311
        <term><option>-f</option></term>
326
333
          </para>
327
334
        </listitem>
328
335
      </varlistentry>
 
336
      <varlistentry>
 
337
        <term><option>--passfile
 
338
        <replaceable>FILE</replaceable></option></term>
 
339
        <term><option>-F
 
340
        <replaceable>FILE</replaceable></option></term>
 
341
        <listitem>
 
342
          <para>
 
343
            The same as <option>--password</option>, but read from
 
344
            <replaceable>FILE</replaceable>, not the terminal.
 
345
          </para>
 
346
        </listitem>
 
347
      </varlistentry>
329
348
    </variablelist>
330
349
  </refsect1>
331
 
 
 
350
  
332
351
  <refsect1 id="overview">
333
352
    <title>OVERVIEW</title>
334
353
    <xi:include href="overview.xml"/>
338
357
      <filename>clients.conf</filename> on the server.
339
358
    </para>
340
359
  </refsect1>
341
 
 
 
360
  
342
361
  <refsect1 id="exit_status">
343
362
    <title>EXIT STATUS</title>
344
363
    <para>
364
383
    </variablelist>
365
384
  </refsect1>
366
385
  
367
 
  <refsect1 id="file">
 
386
  <refsect1 id="files">
368
387
    <title>FILES</title>
369
388
    <para>
370
389
      Use the <option>--dir</option> option to change where
401
420
      </varlistentry>
402
421
    </variablelist>
403
422
  </refsect1>
404
 
 
405
 
  <refsect1 id="bugs">
406
 
    <title>BUGS</title>
407
 
    <para>
408
 
      None are known at this time.
409
 
    </para>
410
 
  </refsect1>
411
 
 
 
423
  
 
424
<!--   <refsect1 id="bugs"> -->
 
425
<!--     <title>BUGS</title> -->
 
426
<!--     <para> -->
 
427
<!--     </para> -->
 
428
<!--   </refsect1> -->
 
429
  
412
430
  <refsect1 id="example">
413
431
    <title>EXAMPLE</title>
414
432
    <informalexample>
455
473
      </para>
456
474
    </informalexample>
457
475
  </refsect1>
458
 
 
 
476
  
459
477
  <refsect1 id="security">
460
478
    <title>SECURITY</title>
461
479
    <para>
470
488
      <manvolnum>8</manvolnum></citerefentry>.
471
489
    </para>
472
490
  </refsect1>
473
 
 
 
491
  
474
492
  <refsect1 id="see_also">
475
493
    <title>SEE ALSO</title>
476
494
    <para>
480
498
      <manvolnum>5</manvolnum></citerefentry>,
481
499
      <citerefentry><refentrytitle>mandos</refentrytitle>
482
500
      <manvolnum>8</manvolnum></citerefentry>,
483
 
      <citerefentry><refentrytitle>password-request</refentrytitle>
 
501
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
484
502
      <manvolnum>8mandos</manvolnum></citerefentry>
485
503
    </para>
486
504
  </refsect1>