/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-30 19:05:15 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080830190515-l7e6vu81yyw5kcku
* mandos.xml (SYNOPSIS): Use <option> and <replaceable> tags.  Unify
                         short and long options.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-keygen.xml
1
 
<?xml version='1.0' encoding='UTF-8'?>
 
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
4
<!ENTITY VERSION "1.0">
5
5
<!ENTITY COMMANDNAME "mandos-keygen">
6
 
<!ENTITY OVERVIEW SYSTEM "overview.xml">
 
6
<!ENTITY TIMESTAMP "2008-08-30">
7
7
]>
8
8
 
9
 
<refentry>
 
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
10
10
  <refentryinfo>
11
 
    <title>&COMMANDNAME;</title>
12
 
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
13
 
    <productname>&COMMANDNAME;</productname>
 
11
    <title>Mandos Manual</title>
 
12
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
 
13
    <productname>Mandos</productname>
14
14
    <productnumber>&VERSION;</productnumber>
 
15
    <date>&TIMESTAMP;</date>
15
16
    <authorgroup>
16
17
      <author>
17
18
        <firstname>Björn</firstname>
30
31
    </authorgroup>
31
32
    <copyright>
32
33
      <year>2008</year>
33
 
      <holder>Teddy Hogeborn &amp; Björn Påhlsson</holder>
 
34
      <holder>Teddy Hogeborn</holder>
 
35
      <holder>Björn Påhlsson</holder>
34
36
    </copyright>
35
37
    <legalnotice>
36
38
      <para>
73
75
  <refsynopsisdiv>
74
76
    <cmdsynopsis>
75
77
      <command>&COMMANDNAME;</command>
76
 
      <group choice="opt">
77
 
        <arg choice="plain"><option>--dir</option>
78
 
        <replaceable>directory</replaceable></arg>
79
 
      </group>
80
 
      <group choice="opt">
81
 
        <arg choice="plain"><option>--type</option>
82
 
        <replaceable>type</replaceable></arg>
83
 
      </group>
84
 
      <group choice="opt">
85
 
        <arg choice="plain"><option>--length</option>
86
 
        <replaceable>bits</replaceable></arg>
87
 
      </group>
88
 
      <group choice="opt">
89
 
        <arg choice="plain"><option>--name</option>
90
 
        <replaceable>NAME</replaceable></arg>
91
 
      </group>
92
 
      <group choice="opt">
93
 
        <arg choice="plain"><option>--email</option>
94
 
        <replaceable>EMAIL</replaceable></arg>
95
 
      </group>
96
 
      <group choice="opt">
97
 
        <arg choice="plain"><option>--comment</option>
98
 
        <replaceable>COMMENT</replaceable></arg>
99
 
      </group>
100
 
      <group choice="opt">
101
 
        <arg choice="plain"><option>--expire</option>
102
 
        <replaceable>TIME</replaceable></arg>
103
 
      </group>
104
 
      <group choice="opt">
105
 
        <arg choice="plain"><option>--force</option></arg>
106
 
      </group>
107
 
    </cmdsynopsis>
108
 
    <cmdsynopsis>
109
 
      <command>&COMMANDNAME;</command>
110
 
      <group choice="opt">
111
 
        <arg choice="plain"><option>-d</option>
112
 
        <replaceable>directory</replaceable></arg>
113
 
      </group>
114
 
      <group choice="opt">
115
 
        <arg choice="plain"><option>-t</option>
116
 
        <replaceable>type</replaceable></arg>
117
 
      </group>
118
 
      <group choice="opt">
119
 
        <arg choice="plain"><option>-l</option>
120
 
        <replaceable>bits</replaceable></arg>
121
 
      </group>
122
 
      <group choice="opt">
123
 
        <arg choice="plain"><option>-n</option>
124
 
        <replaceable>NAME</replaceable></arg>
125
 
      </group>
126
 
      <group choice="opt">
127
 
        <arg choice="plain"><option>-e</option>
128
 
        <replaceable>EMAIL</replaceable></arg>
129
 
      </group>
130
 
      <group choice="opt">
131
 
        <arg choice="plain"><option>-c</option>
132
 
        <replaceable>COMMENT</replaceable></arg>
133
 
      </group>
134
 
      <group choice="opt">
135
 
        <arg choice="plain"><option>-x</option>
136
 
        <replaceable>TIME</replaceable></arg>
137
 
      </group>
138
 
      <group choice="opt">
139
 
        <arg choice="plain"><option>-f</option></arg>
140
 
      </group>
141
 
    </cmdsynopsis>
142
 
    <cmdsynopsis>
143
 
      <command>&COMMANDNAME;</command>
144
 
      <group choice="req">
145
 
        <arg choice='plain'><option>-h</option></arg>
146
 
        <arg choice='plain'><option>--help</option></arg>
147
 
      </group>
148
 
    </cmdsynopsis>
149
 
    <cmdsynopsis>
150
 
      <command>&COMMANDNAME;</command>
151
 
      <group choice="req">
152
 
        <arg choice='plain'><option>-v</option></arg>
153
 
        <arg choice='plain'><option>--version</option></arg>
 
78
      <group>
 
79
        <arg choice="plain"><option>--dir
 
80
        <replaceable>DIRECTORY</replaceable></option></arg>
 
81
        <arg choice="plain"><option>-d
 
82
        <replaceable>DIRECTORY</replaceable></option></arg>
 
83
      </group>
 
84
      <sbr/>
 
85
      <group>
 
86
        <arg choice="plain"><option>--type
 
87
        <replaceable>KEYTYPE</replaceable></option></arg>
 
88
        <arg choice="plain"><option>-t
 
89
        <replaceable>KEYTYPE</replaceable></option></arg>
 
90
      </group>
 
91
      <sbr/>
 
92
      <group>
 
93
        <arg choice="plain"><option>--length
 
94
        <replaceable>BITS</replaceable></option></arg>
 
95
        <arg choice="plain"><option>-l
 
96
        <replaceable>BITS</replaceable></option></arg>
 
97
      </group>
 
98
      <sbr/>
 
99
      <group>
 
100
        <arg choice="plain"><option>--subtype
 
101
        <replaceable>KEYTYPE</replaceable></option></arg>
 
102
        <arg choice="plain"><option>-s
 
103
        <replaceable>KEYTYPE</replaceable></option></arg>
 
104
      </group>
 
105
      <sbr/>
 
106
      <group>
 
107
        <arg choice="plain"><option>--sublength
 
108
        <replaceable>BITS</replaceable></option></arg>
 
109
        <arg choice="plain"><option>-L
 
110
        <replaceable>BITS</replaceable></option></arg>
 
111
      </group>
 
112
      <sbr/>
 
113
      <group>
 
114
        <arg choice="plain"><option>--name
 
115
        <replaceable>NAME</replaceable></option></arg>
 
116
        <arg choice="plain"><option>-n
 
117
        <replaceable>NAME</replaceable></option></arg>
 
118
      </group>
 
119
      <sbr/>
 
120
      <group>
 
121
        <arg choice="plain"><option>--email
 
122
        <replaceable>ADDRESS</replaceable></option></arg>
 
123
        <arg choice="plain"><option>-e
 
124
        <replaceable>ADDRESS</replaceable></option></arg>
 
125
      </group>
 
126
      <sbr/>
 
127
      <group>
 
128
        <arg choice="plain"><option>--comment
 
129
        <replaceable>TEXT</replaceable></option></arg>
 
130
        <arg choice="plain"><option>-c
 
131
        <replaceable>TEXT</replaceable></option></arg>
 
132
      </group>
 
133
      <sbr/>
 
134
      <group>
 
135
        <arg choice="plain"><option>--expire
 
136
        <replaceable>TIME</replaceable></option></arg>
 
137
        <arg choice="plain"><option>-x
 
138
        <replaceable>TIME</replaceable></option></arg>
 
139
      </group>
 
140
      <sbr/>
 
141
      <arg><option>--force</option></arg>
 
142
    </cmdsynopsis>
 
143
    <cmdsynopsis>
 
144
      <command>&COMMANDNAME;</command>
 
145
      <group choice="req">
 
146
        <arg choice="plain"><option>-p</option></arg>
 
147
        <arg choice="plain"><option>--password</option></arg>
 
148
      </group>
 
149
      <sbr/>
 
150
      <group>
 
151
        <arg choice="plain"><option>--dir
 
152
        <replaceable>DIRECTORY</replaceable></option></arg>
 
153
        <arg choice="plain"><option>-d
 
154
        <replaceable>DIRECTORY</replaceable></option></arg>
 
155
      </group>
 
156
      <sbr/>
 
157
      <group>
 
158
        <arg choice="plain"><option>--name
 
159
        <replaceable>NAME</replaceable></option></arg>
 
160
        <arg choice="plain"><option>-n
 
161
        <replaceable>NAME</replaceable></option></arg>
 
162
      </group>
 
163
    </cmdsynopsis>
 
164
    <cmdsynopsis>
 
165
      <command>&COMMANDNAME;</command>
 
166
      <group choice="req">
 
167
        <arg choice="plain"><option>-h</option></arg>
 
168
        <arg choice="plain"><option>--help</option></arg>
 
169
      </group>
 
170
    </cmdsynopsis>
 
171
    <cmdsynopsis>
 
172
      <command>&COMMANDNAME;</command>
 
173
      <group choice="req">
 
174
        <arg choice="plain"><option>-v</option></arg>
 
175
        <arg choice="plain"><option>--version</option></arg>
154
176
      </group>
155
177
    </cmdsynopsis>
156
178
  </refsynopsisdiv>
166
188
      initrd image, but this, like most things, can be changed with
167
189
      command line options.
168
190
    </para>
 
191
    <para>
 
192
      It can also be used to generate ready-made sections for
 
193
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
194
      <manvolnum>5</manvolnum></citerefentry> using the
 
195
      <option>--password</option> option.
 
196
    </para>
169
197
  </refsect1>
170
198
  
171
199
  <refsect1 id="purpose">
198
226
        <replaceable>directory</replaceable></literal></term>
199
227
        <listitem>
200
228
          <para>
201
 
            Target directory for key files.
 
229
            Target directory for key files.  Default is
 
230
            <filename>/etc/mandos</filename>.
202
231
          </para>
203
232
        </listitem>
204
233
      </varlistentry>
208
237
        <replaceable>type</replaceable></literal></term>
209
238
        <listitem>
210
239
          <para>
211
 
            Key type.  Default is DSA.
 
240
            Key type.  Default is <quote>DSA</quote>.
212
241
          </para>
213
242
        </listitem>
214
243
      </varlistentry>
218
247
        <replaceable>bits</replaceable></literal></term>
219
248
        <listitem>
220
249
          <para>
221
 
            Key length in bits.  Default is 1024.
 
250
            Key length in bits.  Default is 2048.
 
251
          </para>
 
252
        </listitem>
 
253
      </varlistentry>
 
254
 
 
255
      <varlistentry>
 
256
        <term><literal>-s</literal>, <literal>--subtype
 
257
        <replaceable>type</replaceable></literal></term>
 
258
        <listitem>
 
259
          <para>
 
260
            Subkey type.  Default is <quote>ELG-E</quote> (Elgamal
 
261
            encryption-only).
 
262
          </para>
 
263
        </listitem>
 
264
      </varlistentry>
 
265
 
 
266
      <varlistentry>
 
267
        <term><literal>-L</literal>, <literal>--sublength
 
268
        <replaceable>bits</replaceable></literal></term>
 
269
        <listitem>
 
270
          <para>
 
271
            Subkey length in bits.  Default is 2048.
222
272
          </para>
223
273
        </listitem>
224
274
      </varlistentry>
239
289
        <listitem>
240
290
          <para>
241
291
            Comment field for key.  The default value is
242
 
            "<literal>Mandos client key</literal>".
 
292
            <quote><literal>Mandos client key</literal></quote>.
243
293
          </para>
244
294
        </listitem>
245
295
      </varlistentry>
264
314
          </para>
265
315
        </listitem>
266
316
      </varlistentry>
 
317
      <varlistentry>
 
318
        <term><literal>-p</literal>, <literal>--password</literal
 
319
        ></term>
 
320
        <listitem>
 
321
          <para>
 
322
            Prompt for a password and encrypt it with the key already
 
323
            present in either <filename>/etc/mandos</filename> or the
 
324
            directory specified with the <option>--dir</option>
 
325
            option.  Outputs, on standard output, a section suitable
 
326
            for inclusion in <citerefentry><refentrytitle
 
327
            >mandos-clients.conf</refentrytitle><manvolnum
 
328
            >8</manvolnum></citerefentry>.  The host name or the name
 
329
            specified with the <option>--name</option> option is used
 
330
            for the section header.  All other options are ignored,
 
331
            and no keys are created.
 
332
          </para>
 
333
        </listitem>
 
334
      </varlistentry>
267
335
    </variablelist>
268
336
  </refsect1>
269
337
 
270
338
  <refsect1 id="overview">
271
339
    <title>OVERVIEW</title>
272
 
    &OVERVIEW;
 
340
    <xi:include href="overview.xml"/>
273
341
    <para>
274
 
      This program is a small program to generate new OpenPGP keys for
 
342
      This program is a small utility to generate new OpenPGP keys for
275
343
      new Mandos clients.
276
344
    </para>
277
345
  </refsect1>
279
347
  <refsect1 id="exit_status">
280
348
    <title>EXIT STATUS</title>
281
349
    <para>
 
350
      The exit status will be 0 if new keys were successfully created,
 
351
      otherwise not.
282
352
    </para>
283
353
  </refsect1>
284
354
  
 
355
  <refsect1 id="environment">
 
356
    <title>ENVIRONMENT</title>
 
357
    <variablelist>
 
358
      <varlistentry>
 
359
        <term><envar>TMPDIR</envar></term>
 
360
        <listitem>
 
361
          <para>
 
362
            If set, temporary files will be created here. See
 
363
            <citerefentry><refentrytitle>mktemp</refentrytitle>
 
364
            <manvolnum>1</manvolnum></citerefentry>.
 
365
          </para>
 
366
        </listitem>
 
367
      </varlistentry>
 
368
    </variablelist>
 
369
  </refsect1>
 
370
  
285
371
  <refsect1 id="file">
286
372
    <title>FILES</title>
287
373
    <para>
 
374
      Use the <option>--dir</option> option to change where
 
375
      <command>&COMMANDNAME;</command> will write the key files.  The
 
376
      default file names are shown here.
288
377
    </para>
 
378
    <variablelist>
 
379
      <varlistentry>
 
380
        <term><filename>/etc/mandos/seckey.txt</filename></term>
 
381
        <listitem>
 
382
          <para>
 
383
            OpenPGP secret key file which will be created or
 
384
            overwritten.
 
385
          </para>
 
386
        </listitem>
 
387
      </varlistentry>
 
388
      <varlistentry>
 
389
        <term><filename>/etc/mandos/pubkey.txt</filename></term>
 
390
        <listitem>
 
391
          <para>
 
392
            OpenPGP public key file which will be created or
 
393
            overwritten.
 
394
          </para>
 
395
        </listitem>
 
396
      </varlistentry>
 
397
      <varlistentry>
 
398
        <term><filename>/tmp</filename></term>
 
399
        <listitem>
 
400
          <para>
 
401
            Temporary files will be written here if
 
402
            <varname>TMPDIR</varname> is not set.
 
403
          </para>
 
404
        </listitem>
 
405
      </varlistentry>
 
406
    </variablelist>
289
407
  </refsect1>
290
408
 
291
409
  <refsect1 id="bugs">
292
410
    <title>BUGS</title>
293
411
    <para>
 
412
      None are known at this time.
294
413
    </para>
295
414
  </refsect1>
296
415
 
297
416
  <refsect1 id="example">
298
417
    <title>EXAMPLE</title>
299
 
    <para>
300
 
    </para>
 
418
    <informalexample>
 
419
      <para>
 
420
        Normal invocation needs no options:
 
421
      </para>
 
422
      <para>
 
423
        <userinput>&COMMANDNAME;</userinput>
 
424
      </para>
 
425
    </informalexample>
 
426
    <informalexample>
 
427
      <para>
 
428
        Create keys in another directory and of another type.  Force
 
429
        overwriting old key files:
 
430
      </para>
 
431
      <para>
 
432
 
 
433
<!-- do not wrap this line -->
 
434
<userinput>&COMMANDNAME; --dir ~/keydir --type RSA --force</userinput>
 
435
 
 
436
      </para>
 
437
    </informalexample>
301
438
  </refsect1>
302
439
 
303
440
  <refsect1 id="security">
304
441
    <title>SECURITY</title>
305
442
    <para>
 
443
      The <option>--type</option>, <option>--length</option>,
 
444
      <option>--subtype</option>, and <option>--sublength</option>
 
445
      options can be used to create keys of insufficient security.  If
 
446
      in doubt, leave them to the default values.
 
447
    </para>
 
448
    <para>
 
449
      The key expire time is not guaranteed to be honored by
 
450
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
451
      <manvolnum>8</manvolnum></citerefentry>.
306
452
    </para>
307
453
  </refsect1>
308
454
 
309
455
  <refsect1 id="see_also">
310
456
    <title>SEE ALSO</title>
311
457
    <para>
312
 
      <citerefentry><refentrytitle>password-request</refentrytitle>
313
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
314
 
      <citerefentry><refentrytitle>mandos</refentrytitle>
315
 
      <manvolnum>8</manvolnum></citerefentry>, and
316
458
      <citerefentry><refentrytitle>gpg</refentrytitle>
317
 
      <manvolnum>1</manvolnum></citerefentry>
 
459
      <manvolnum>1</manvolnum></citerefentry>,
 
460
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
461
      <manvolnum>8</manvolnum></citerefentry>,
 
462
      <citerefentry><refentrytitle>password-request</refentrytitle>
 
463
      <manvolnum>8mandos</manvolnum></citerefentry>
318
464
    </para>
319
465
  </refsect1>
320
466
  
321
467
</refentry>
 
468
<!-- Local Variables: -->
 
469
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
470
<!-- time-stamp-end: "[\"']>" -->
 
471
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
472
<!-- End: -->