/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-20">
 
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>
122
144
      <group choice="req">
123
145
        <arg choice="plain"><option>--password</option></arg>
124
146
        <arg choice="plain"><option>-p</option></arg>
125
 
        <arg choice="plain"><option>--passfile
126
 
        <replaceable>FILE</replaceable></option></arg>
127
 
        <arg choice="plain"><option>-F</option>
128
 
        <replaceable>FILE</replaceable></arg>
129
147
      </group>
130
148
      <sbr/>
131
149
      <group>
163
181
    <para>
164
182
      <command>&COMMANDNAME;</command> is a program to generate the
165
183
      OpenPGP key used by
166
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
184
      <citerefentry><refentrytitle>password-request</refentrytitle>
167
185
      <manvolnum>8mandos</manvolnum></citerefentry>.  The key is
168
186
      normally written to /etc/mandos for later installation into the
169
187
      initrd image, but this, and most other things, can be changed
171
189
    </para>
172
190
    <para>
173
191
      This program can also be used with the
174
 
      <option>--password</option> or <option>--passfile</option>
175
 
      options to generate a ready-made section for
176
 
      <filename>clients.conf</filename> (see
 
192
      <option>--password</option> option to generate a ready-made
 
193
      section for <filename>clients.conf</filename> (see
177
194
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
178
195
      <manvolnum>5</manvolnum></citerefentry>).
179
196
    </para>
202
219
          </para>
203
220
        </listitem>
204
221
      </varlistentry>
205
 
      
 
222
 
206
223
      <varlistentry>
207
224
        <term><option>--dir
208
225
        <replaceable>DIRECTORY</replaceable></option></term>
215
232
          </para>
216
233
        </listitem>
217
234
      </varlistentry>
218
 
      
 
235
 
219
236
      <varlistentry>
220
237
        <term><option>--type
221
238
        <replaceable>TYPE</replaceable></option></term>
227
244
          </para>
228
245
        </listitem>
229
246
      </varlistentry>
230
 
      
 
247
 
231
248
      <varlistentry>
232
249
        <term><option>--length
233
250
        <replaceable>BITS</replaceable></option></term>
239
256
          </para>
240
257
        </listitem>
241
258
      </varlistentry>
242
 
      
 
259
 
243
260
      <varlistentry>
244
261
        <term><option>--subtype
245
262
        <replaceable>KEYTYPE</replaceable></option></term>
252
269
          </para>
253
270
        </listitem>
254
271
      </varlistentry>
255
 
      
 
272
 
256
273
      <varlistentry>
257
274
        <term><option>--sublength
258
275
        <replaceable>BITS</replaceable></option></term>
264
281
          </para>
265
282
        </listitem>
266
283
      </varlistentry>
267
 
      
 
284
 
268
285
      <varlistentry>
269
286
        <term><option>--email
270
287
        <replaceable>ADDRESS</replaceable></option></term>
276
293
          </para>
277
294
        </listitem>
278
295
      </varlistentry>
279
 
      
 
296
 
280
297
      <varlistentry>
281
298
        <term><option>--comment
282
299
        <replaceable>TEXT</replaceable></option></term>
289
306
          </para>
290
307
        </listitem>
291
308
      </varlistentry>
292
 
      
 
309
 
293
310
      <varlistentry>
294
311
        <term><option>--expire
295
312
        <replaceable>TIME</replaceable></option></term>
303
320
          </para>
304
321
        </listitem>
305
322
      </varlistentry>
306
 
      
 
323
 
307
324
      <varlistentry>
308
325
        <term><option>--force</option></term>
309
326
        <term><option>-f</option></term>
331
348
          </para>
332
349
        </listitem>
333
350
      </varlistentry>
334
 
      <varlistentry>
335
 
        <term><option>--passfile
336
 
        <replaceable>FILE</replaceable></option></term>
337
 
        <term><option>-F
338
 
        <replaceable>FILE</replaceable></option></term>
339
 
        <listitem>
340
 
          <para>
341
 
            The same as <option>--password</option>, but read from
342
 
            <replaceable>FILE</replaceable>, not the terminal.
343
 
          </para>
344
 
        </listitem>
345
 
      </varlistentry>
346
351
    </variablelist>
347
352
  </refsect1>
348
 
  
 
353
 
349
354
  <refsect1 id="overview">
350
355
    <title>OVERVIEW</title>
351
356
    <xi:include href="overview.xml"/>
355
360
      <filename>clients.conf</filename> on the server.
356
361
    </para>
357
362
  </refsect1>
358
 
  
 
363
 
359
364
  <refsect1 id="exit_status">
360
365
    <title>EXIT STATUS</title>
361
366
    <para>
418
423
      </varlistentry>
419
424
    </variablelist>
420
425
  </refsect1>
421
 
  
422
 
<!--   <refsect1 id="bugs"> -->
423
 
<!--     <title>BUGS</title> -->
424
 
<!--     <para> -->
425
 
<!--     </para> -->
426
 
<!--   </refsect1> -->
427
 
  
 
426
 
 
427
  <refsect1 id="bugs">
 
428
    <title>BUGS</title>
 
429
    <para>
 
430
      None are known at this time.
 
431
    </para>
 
432
  </refsect1>
 
433
 
428
434
  <refsect1 id="example">
429
435
    <title>EXAMPLE</title>
430
436
    <informalexample>
471
477
      </para>
472
478
    </informalexample>
473
479
  </refsect1>
474
 
  
 
480
 
475
481
  <refsect1 id="security">
476
482
    <title>SECURITY</title>
477
483
    <para>
486
492
      <manvolnum>8</manvolnum></citerefentry>.
487
493
    </para>
488
494
  </refsect1>
489
 
  
 
495
 
490
496
  <refsect1 id="see_also">
491
497
    <title>SEE ALSO</title>
492
498
    <para>
496
502
      <manvolnum>5</manvolnum></citerefentry>,
497
503
      <citerefentry><refentrytitle>mandos</refentrytitle>
498
504
      <manvolnum>8</manvolnum></citerefentry>,
499
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
505
      <citerefentry><refentrytitle>password-request</refentrytitle>
500
506
      <manvolnum>8mandos</manvolnum></citerefentry>
501
507
    </para>
502
508
  </refsect1>