/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
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">
4
5
<!ENTITY COMMANDNAME "mandos-keygen">
5
 
<!ENTITY TIMESTAMP "2008-10-03">
6
 
<!ENTITY % common SYSTEM "common.ent">
7
 
%common;
 
6
<!ENTITY TIMESTAMP "2008-08-31">
8
7
]>
9
8
 
10
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
12
11
    <title>Mandos Manual</title>
13
12
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
13
    <productname>Mandos</productname>
15
 
    <productnumber>&version;</productnumber>
 
14
    <productnumber>&VERSION;</productnumber>
16
15
    <date>&TIMESTAMP;</date>
17
16
    <authorgroup>
18
17
      <author>
35
34
      <holder>Teddy Hogeborn</holder>
36
35
      <holder>Björn Påhlsson</holder>
37
36
    </copyright>
38
 
    <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>
39
60
  </refentryinfo>
40
 
  
 
61
 
41
62
  <refmeta>
42
63
    <refentrytitle>&COMMANDNAME;</refentrytitle>
43
64
    <manvolnum>8</manvolnum>
49
70
      Generate key and password for Mandos client and server.
50
71
    </refpurpose>
51
72
  </refnamediv>
52
 
  
 
73
 
53
74
  <refsynopsisdiv>
54
75
    <cmdsynopsis>
55
76
      <command>&COMMANDNAME;</command>
123
144
      <group choice="req">
124
145
        <arg choice="plain"><option>--password</option></arg>
125
146
        <arg choice="plain"><option>-p</option></arg>
126
 
        <arg choice="plain"><option>--passfile
127
 
        <replaceable>FILE</replaceable></option></arg>
128
 
        <arg choice="plain"><option>-F</option>
129
 
        <replaceable>FILE</replaceable></arg>
130
147
      </group>
131
148
      <sbr/>
132
149
      <group>
164
181
    <para>
165
182
      <command>&COMMANDNAME;</command> is a program to generate the
166
183
      OpenPGP key used by
167
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
184
      <citerefentry><refentrytitle>password-request</refentrytitle>
168
185
      <manvolnum>8mandos</manvolnum></citerefentry>.  The key is
169
186
      normally written to /etc/mandos for later installation into the
170
187
      initrd image, but this, and most other things, can be changed
172
189
    </para>
173
190
    <para>
174
191
      This program can also be used with the
175
 
      <option>--password</option> or <option>--passfile</option>
176
 
      options to generate a ready-made section for
177
 
      <filename>clients.conf</filename> (see
 
192
      <option>--password</option> option to generate a ready-made
 
193
      section for <filename>clients.conf</filename> (see
178
194
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
179
195
      <manvolnum>5</manvolnum></citerefentry>).
180
196
    </para>
203
219
          </para>
204
220
        </listitem>
205
221
      </varlistentry>
206
 
      
 
222
 
207
223
      <varlistentry>
208
224
        <term><option>--dir
209
225
        <replaceable>DIRECTORY</replaceable></option></term>
216
232
          </para>
217
233
        </listitem>
218
234
      </varlistentry>
219
 
      
 
235
 
220
236
      <varlistentry>
221
237
        <term><option>--type
222
238
        <replaceable>TYPE</replaceable></option></term>
228
244
          </para>
229
245
        </listitem>
230
246
      </varlistentry>
231
 
      
 
247
 
232
248
      <varlistentry>
233
249
        <term><option>--length
234
250
        <replaceable>BITS</replaceable></option></term>
240
256
          </para>
241
257
        </listitem>
242
258
      </varlistentry>
243
 
      
 
259
 
244
260
      <varlistentry>
245
261
        <term><option>--subtype
246
262
        <replaceable>KEYTYPE</replaceable></option></term>
253
269
          </para>
254
270
        </listitem>
255
271
      </varlistentry>
256
 
      
 
272
 
257
273
      <varlistentry>
258
274
        <term><option>--sublength
259
275
        <replaceable>BITS</replaceable></option></term>
265
281
          </para>
266
282
        </listitem>
267
283
      </varlistentry>
268
 
      
 
284
 
269
285
      <varlistentry>
270
286
        <term><option>--email
271
287
        <replaceable>ADDRESS</replaceable></option></term>
277
293
          </para>
278
294
        </listitem>
279
295
      </varlistentry>
280
 
      
 
296
 
281
297
      <varlistentry>
282
298
        <term><option>--comment
283
299
        <replaceable>TEXT</replaceable></option></term>
290
306
          </para>
291
307
        </listitem>
292
308
      </varlistentry>
293
 
      
 
309
 
294
310
      <varlistentry>
295
311
        <term><option>--expire
296
312
        <replaceable>TIME</replaceable></option></term>
304
320
          </para>
305
321
        </listitem>
306
322
      </varlistentry>
307
 
      
 
323
 
308
324
      <varlistentry>
309
325
        <term><option>--force</option></term>
310
326
        <term><option>-f</option></term>
332
348
          </para>
333
349
        </listitem>
334
350
      </varlistentry>
335
 
      <varlistentry>
336
 
        <term><option>--passfile
337
 
        <replaceable>FILE</replaceable></option></term>
338
 
        <term><option>-F
339
 
        <replaceable>FILE</replaceable></option></term>
340
 
        <listitem>
341
 
          <para>
342
 
            The same as <option>--password</option>, but read from
343
 
            <replaceable>FILE</replaceable>, not the terminal.
344
 
          </para>
345
 
        </listitem>
346
 
      </varlistentry>
347
351
    </variablelist>
348
352
  </refsect1>
349
 
  
 
353
 
350
354
  <refsect1 id="overview">
351
355
    <title>OVERVIEW</title>
352
356
    <xi:include href="overview.xml"/>
356
360
      <filename>clients.conf</filename> on the server.
357
361
    </para>
358
362
  </refsect1>
359
 
  
 
363
 
360
364
  <refsect1 id="exit_status">
361
365
    <title>EXIT STATUS</title>
362
366
    <para>
382
386
    </variablelist>
383
387
  </refsect1>
384
388
  
385
 
  <refsect1 id="files">
 
389
  <refsect1 id="file">
386
390
    <title>FILES</title>
387
391
    <para>
388
392
      Use the <option>--dir</option> option to change where
419
423
      </varlistentry>
420
424
    </variablelist>
421
425
  </refsect1>
422
 
  
423
 
<!--   <refsect1 id="bugs"> -->
424
 
<!--     <title>BUGS</title> -->
425
 
<!--     <para> -->
426
 
<!--     </para> -->
427
 
<!--   </refsect1> -->
428
 
  
 
426
 
 
427
  <refsect1 id="bugs">
 
428
    <title>BUGS</title>
 
429
    <para>
 
430
      None are known at this time.
 
431
    </para>
 
432
  </refsect1>
 
433
 
429
434
  <refsect1 id="example">
430
435
    <title>EXAMPLE</title>
431
436
    <informalexample>
472
477
      </para>
473
478
    </informalexample>
474
479
  </refsect1>
475
 
  
 
480
 
476
481
  <refsect1 id="security">
477
482
    <title>SECURITY</title>
478
483
    <para>
487
492
      <manvolnum>8</manvolnum></citerefentry>.
488
493
    </para>
489
494
  </refsect1>
490
 
  
 
495
 
491
496
  <refsect1 id="see_also">
492
497
    <title>SEE ALSO</title>
493
498
    <para>
497
502
      <manvolnum>5</manvolnum></citerefentry>,
498
503
      <citerefentry><refentrytitle>mandos</refentrytitle>
499
504
      <manvolnum>8</manvolnum></citerefentry>,
500
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
505
      <citerefentry><refentrytitle>password-request</refentrytitle>
501
506
      <manvolnum>8mandos</manvolnum></citerefentry>
502
507
    </para>
503
508
  </refsect1>