/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos-keygen.xml

  • Committer: Teddy Hogeborn
  • Date: 2008-08-31 08:47:38 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080831084738-uu70kayyt876982d
* mandos-keygen: Minor help text change.

* mandos-keygen.xml: Changed plural "keys" to singular "key"
                     throughout.
  (NAME): Improved wording.
  (DESCRIPTION): Improved wording.
  (OPTIONS): Split options in <term> tags into separate <term> tags.
             Use <option> tags.  Move long options before short
             options.  Uppercase replaceables.
  (OVERVIEW): Improved wording.
  (EXIT STATUS): Also cover --password option.
  (EXAMPLE): Add two examples using the --password option.
  (SECURITY): Improved wording.

* overview.xml: Improved wording.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-keygen.xml
3
3
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
4
<!ENTITY VERSION "1.0">
5
5
<!ENTITY COMMANDNAME "mandos-keygen">
6
 
<!ENTITY TIMESTAMP "2008-09-12">
 
6
<!ENTITY TIMESTAMP "2008-08-31">
7
7
]>
8
8
 
9
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
34
34
      <holder>Teddy Hogeborn</holder>
35
35
      <holder>Björn Påhlsson</holder>
36
36
    </copyright>
37
 
    <xi:include href="legalnotice.xml"/>
 
37
    <legalnotice>
 
38
      <para>
 
39
        This manual page is free software: you can redistribute it
 
40
        and/or modify it under the terms of the GNU General Public
 
41
        License as published by the Free Software Foundation,
 
42
        either version 3 of the License, or (at your option) any
 
43
        later version.
 
44
      </para>
 
45
 
 
46
      <para>
 
47
        This manual page is distributed in the hope that it will
 
48
        be useful, but WITHOUT ANY WARRANTY; without even the
 
49
        implied warranty of MERCHANTABILITY or FITNESS FOR A
 
50
        PARTICULAR PURPOSE.  See the GNU General Public License
 
51
        for more details.
 
52
      </para>
 
53
 
 
54
      <para>
 
55
        You should have received a copy of the GNU General Public
 
56
        License along with this program; If not, see
 
57
        <ulink url="http://www.gnu.org/licenses/"/>.
 
58
      </para>
 
59
    </legalnotice>
38
60
  </refentryinfo>
39
 
  
 
61
 
40
62
  <refmeta>
41
63
    <refentrytitle>&COMMANDNAME;</refentrytitle>
42
64
    <manvolnum>8</manvolnum>
48
70
      Generate key and password for Mandos client and server.
49
71
    </refpurpose>
50
72
  </refnamediv>
51
 
  
 
73
 
52
74
  <refsynopsisdiv>
53
75
    <cmdsynopsis>
54
76
      <command>&COMMANDNAME;</command>
159
181
    <para>
160
182
      <command>&COMMANDNAME;</command> is a program to generate the
161
183
      OpenPGP key used by
162
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
184
      <citerefentry><refentrytitle>password-request</refentrytitle>
163
185
      <manvolnum>8mandos</manvolnum></citerefentry>.  The key is
164
186
      normally written to /etc/mandos for later installation into the
165
187
      initrd image, but this, and most other things, can be changed
197
219
          </para>
198
220
        </listitem>
199
221
      </varlistentry>
200
 
      
 
222
 
201
223
      <varlistentry>
202
224
        <term><option>--dir
203
225
        <replaceable>DIRECTORY</replaceable></option></term>
210
232
          </para>
211
233
        </listitem>
212
234
      </varlistentry>
213
 
      
 
235
 
214
236
      <varlistentry>
215
237
        <term><option>--type
216
238
        <replaceable>TYPE</replaceable></option></term>
222
244
          </para>
223
245
        </listitem>
224
246
      </varlistentry>
225
 
      
 
247
 
226
248
      <varlistentry>
227
249
        <term><option>--length
228
250
        <replaceable>BITS</replaceable></option></term>
234
256
          </para>
235
257
        </listitem>
236
258
      </varlistentry>
237
 
      
 
259
 
238
260
      <varlistentry>
239
261
        <term><option>--subtype
240
262
        <replaceable>KEYTYPE</replaceable></option></term>
247
269
          </para>
248
270
        </listitem>
249
271
      </varlistentry>
250
 
      
 
272
 
251
273
      <varlistentry>
252
274
        <term><option>--sublength
253
275
        <replaceable>BITS</replaceable></option></term>
259
281
          </para>
260
282
        </listitem>
261
283
      </varlistentry>
262
 
      
 
284
 
263
285
      <varlistentry>
264
286
        <term><option>--email
265
287
        <replaceable>ADDRESS</replaceable></option></term>
271
293
          </para>
272
294
        </listitem>
273
295
      </varlistentry>
274
 
      
 
296
 
275
297
      <varlistentry>
276
298
        <term><option>--comment
277
299
        <replaceable>TEXT</replaceable></option></term>
284
306
          </para>
285
307
        </listitem>
286
308
      </varlistentry>
287
 
      
 
309
 
288
310
      <varlistentry>
289
311
        <term><option>--expire
290
312
        <replaceable>TIME</replaceable></option></term>
298
320
          </para>
299
321
        </listitem>
300
322
      </varlistentry>
301
 
      
 
323
 
302
324
      <varlistentry>
303
325
        <term><option>--force</option></term>
304
326
        <term><option>-f</option></term>
328
350
      </varlistentry>
329
351
    </variablelist>
330
352
  </refsect1>
331
 
  
 
353
 
332
354
  <refsect1 id="overview">
333
355
    <title>OVERVIEW</title>
334
356
    <xi:include href="overview.xml"/>
338
360
      <filename>clients.conf</filename> on the server.
339
361
    </para>
340
362
  </refsect1>
341
 
  
 
363
 
342
364
  <refsect1 id="exit_status">
343
365
    <title>EXIT STATUS</title>
344
366
    <para>
401
423
      </varlistentry>
402
424
    </variablelist>
403
425
  </refsect1>
404
 
  
405
 
<!--   <refsect1 id="bugs"> -->
406
 
<!--     <title>BUGS</title> -->
407
 
<!--     <para> -->
408
 
<!--     </para> -->
409
 
<!--   </refsect1> -->
410
 
  
 
426
 
 
427
  <refsect1 id="bugs">
 
428
    <title>BUGS</title>
 
429
    <para>
 
430
      None are known at this time.
 
431
    </para>
 
432
  </refsect1>
 
433
 
411
434
  <refsect1 id="example">
412
435
    <title>EXAMPLE</title>
413
436
    <informalexample>
454
477
      </para>
455
478
    </informalexample>
456
479
  </refsect1>
457
 
  
 
480
 
458
481
  <refsect1 id="security">
459
482
    <title>SECURITY</title>
460
483
    <para>
469
492
      <manvolnum>8</manvolnum></citerefentry>.
470
493
    </para>
471
494
  </refsect1>
472
 
  
 
495
 
473
496
  <refsect1 id="see_also">
474
497
    <title>SEE ALSO</title>
475
498
    <para>
479
502
      <manvolnum>5</manvolnum></citerefentry>,
480
503
      <citerefentry><refentrytitle>mandos</refentrytitle>
481
504
      <manvolnum>8</manvolnum></citerefentry>,
482
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
505
      <citerefentry><refentrytitle>password-request</refentrytitle>
483
506
      <manvolnum>8mandos</manvolnum></citerefentry>
484
507
    </para>
485
508
  </refsect1>