/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

  • 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 "2009-01-04">
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>
32
31
    </authorgroup>
33
32
    <copyright>
34
33
      <year>2008</year>
35
 
      <year>2009</year>
36
34
      <holder>Teddy Hogeborn</holder>
37
35
      <holder>Björn Påhlsson</holder>
38
36
    </copyright>
39
 
    <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>
40
60
  </refentryinfo>
41
 
  
 
61
 
42
62
  <refmeta>
43
63
    <refentrytitle>&COMMANDNAME;</refentrytitle>
44
64
    <manvolnum>8</manvolnum>
50
70
      Generate key and password for Mandos client and server.
51
71
    </refpurpose>
52
72
  </refnamediv>
53
 
  
 
73
 
54
74
  <refsynopsisdiv>
55
75
    <cmdsynopsis>
56
76
      <command>&COMMANDNAME;</command>
124
144
      <group choice="req">
125
145
        <arg choice="plain"><option>--password</option></arg>
126
146
        <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>
131
147
      </group>
132
148
      <sbr/>
133
149
      <group>
165
181
    <para>
166
182
      <command>&COMMANDNAME;</command> is a program to generate the
167
183
      OpenPGP key used by
168
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
184
      <citerefentry><refentrytitle>password-request</refentrytitle>
169
185
      <manvolnum>8mandos</manvolnum></citerefentry>.  The key is
170
186
      normally written to /etc/mandos for later installation into the
171
187
      initrd image, but this, and most other things, can be changed
173
189
    </para>
174
190
    <para>
175
191
      This program can also be used with the
176
 
      <option>--password</option> or <option>--passfile</option>
177
 
      options to generate a ready-made section for
178
 
      <filename>clients.conf</filename> (see
 
192
      <option>--password</option> option to generate a ready-made
 
193
      section for <filename>clients.conf</filename> (see
179
194
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
180
195
      <manvolnum>5</manvolnum></citerefentry>).
181
196
    </para>
204
219
          </para>
205
220
        </listitem>
206
221
      </varlistentry>
207
 
      
 
222
 
208
223
      <varlistentry>
209
224
        <term><option>--dir
210
225
        <replaceable>DIRECTORY</replaceable></option></term>
217
232
          </para>
218
233
        </listitem>
219
234
      </varlistentry>
220
 
      
 
235
 
221
236
      <varlistentry>
222
237
        <term><option>--type
223
238
        <replaceable>TYPE</replaceable></option></term>
229
244
          </para>
230
245
        </listitem>
231
246
      </varlistentry>
232
 
      
 
247
 
233
248
      <varlistentry>
234
249
        <term><option>--length
235
250
        <replaceable>BITS</replaceable></option></term>
241
256
          </para>
242
257
        </listitem>
243
258
      </varlistentry>
244
 
      
 
259
 
245
260
      <varlistentry>
246
261
        <term><option>--subtype
247
262
        <replaceable>KEYTYPE</replaceable></option></term>
254
269
          </para>
255
270
        </listitem>
256
271
      </varlistentry>
257
 
      
 
272
 
258
273
      <varlistentry>
259
274
        <term><option>--sublength
260
275
        <replaceable>BITS</replaceable></option></term>
266
281
          </para>
267
282
        </listitem>
268
283
      </varlistentry>
269
 
      
 
284
 
270
285
      <varlistentry>
271
286
        <term><option>--email
272
287
        <replaceable>ADDRESS</replaceable></option></term>
278
293
          </para>
279
294
        </listitem>
280
295
      </varlistentry>
281
 
      
 
296
 
282
297
      <varlistentry>
283
298
        <term><option>--comment
284
299
        <replaceable>TEXT</replaceable></option></term>
291
306
          </para>
292
307
        </listitem>
293
308
      </varlistentry>
294
 
      
 
309
 
295
310
      <varlistentry>
296
311
        <term><option>--expire
297
312
        <replaceable>TIME</replaceable></option></term>
305
320
          </para>
306
321
        </listitem>
307
322
      </varlistentry>
308
 
      
 
323
 
309
324
      <varlistentry>
310
325
        <term><option>--force</option></term>
311
326
        <term><option>-f</option></term>
333
348
          </para>
334
349
        </listitem>
335
350
      </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>
348
351
    </variablelist>
349
352
  </refsect1>
350
 
  
 
353
 
351
354
  <refsect1 id="overview">
352
355
    <title>OVERVIEW</title>
353
356
    <xi:include href="overview.xml"/>
357
360
      <filename>clients.conf</filename> on the server.
358
361
    </para>
359
362
  </refsect1>
360
 
  
 
363
 
361
364
  <refsect1 id="exit_status">
362
365
    <title>EXIT STATUS</title>
363
366
    <para>
383
386
    </variablelist>
384
387
  </refsect1>
385
388
  
386
 
  <refsect1 id="files">
 
389
  <refsect1 id="file">
387
390
    <title>FILES</title>
388
391
    <para>
389
392
      Use the <option>--dir</option> option to change where
420
423
      </varlistentry>
421
424
    </variablelist>
422
425
  </refsect1>
423
 
  
424
 
<!--   <refsect1 id="bugs"> -->
425
 
<!--     <title>BUGS</title> -->
426
 
<!--     <para> -->
427
 
<!--     </para> -->
428
 
<!--   </refsect1> -->
429
 
  
 
426
 
 
427
  <refsect1 id="bugs">
 
428
    <title>BUGS</title>
 
429
    <para>
 
430
      None are known at this time.
 
431
    </para>
 
432
  </refsect1>
 
433
 
430
434
  <refsect1 id="example">
431
435
    <title>EXAMPLE</title>
432
436
    <informalexample>
473
477
      </para>
474
478
    </informalexample>
475
479
  </refsect1>
476
 
  
 
480
 
477
481
  <refsect1 id="security">
478
482
    <title>SECURITY</title>
479
483
    <para>
488
492
      <manvolnum>8</manvolnum></citerefentry>.
489
493
    </para>
490
494
  </refsect1>
491
 
  
 
495
 
492
496
  <refsect1 id="see_also">
493
497
    <title>SEE ALSO</title>
494
498
    <para>
498
502
      <manvolnum>5</manvolnum></citerefentry>,
499
503
      <citerefentry><refentrytitle>mandos</refentrytitle>
500
504
      <manvolnum>8</manvolnum></citerefentry>,
501
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
505
      <citerefentry><refentrytitle>password-request</refentrytitle>
502
506
      <manvolnum>8mandos</manvolnum></citerefentry>
503
507
    </para>
504
508
  </refsect1>