/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-19 13:25:14 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080819132514-wawrvgmfjovg9poj
* Makefile (DOCBOOKTOMAN): Added "--xinclude".

* mandos-options.xml: New file; moved mandos(8) option descriptions
                      here.

* mandos.conf.xml: Add XInclude namespace.
  (OPTIONS): New separate section with options from old "DESCRIPTION"
             section.  Changed all options to include a synopsis and
             include its paragraph from "mandos-options.xml".
  (FILES): Moved to before "EXAMPLES".
  (BUGS): New section.
  (EXAMPLES): Renamed to "EXAMPLE", as per man-pages(7).  Unindented
              example text.

* mandos.xml: Removed OVERVIEW entity.  Add XInclude namespace.
  (OPTIONS): Moved all descriptive paragraphs to "mandos-options.xml"
             and just <xi:include/> them from here.
  (OVERVIEW): Changed to do <xi:include/>.

* overview.xml: Added DOCTYPE; reportedly needed for XInclude to work.

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
<!ENTITY VERSION "1.0">
4
5
<!ENTITY COMMANDNAME "mandos-keygen">
5
 
<!ENTITY TIMESTAMP "2011-10-03">
6
 
<!ENTITY % common SYSTEM "common.ent">
7
 
%common;
 
6
<!ENTITY OVERVIEW SYSTEM "overview.xml">
8
7
]>
9
8
 
10
 
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
 
9
<refentry>
11
10
  <refentryinfo>
12
 
    <title>Mandos Manual</title>
13
 
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
 
    <productname>Mandos</productname>
15
 
    <productnumber>&version;</productnumber>
16
 
    <date>&TIMESTAMP;</date>
 
11
    <title>&COMMANDNAME;</title>
 
12
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
 
13
    <productname>&COMMANDNAME;</productname>
 
14
    <productnumber>&VERSION;</productnumber>
17
15
    <authorgroup>
18
16
      <author>
19
17
        <firstname>Björn</firstname>
20
18
        <surname>Påhlsson</surname>
21
19
        <address>
22
 
          <email>belorn@recompile.se</email>
 
20
          <email>belorn@fukt.bsnet.se</email>
23
21
        </address>
24
22
      </author>
25
23
      <author>
26
24
        <firstname>Teddy</firstname>
27
25
        <surname>Hogeborn</surname>
28
26
        <address>
29
 
          <email>teddy@recompile.se</email>
 
27
          <email>teddy@fukt.bsnet.se</email>
30
28
        </address>
31
29
      </author>
32
30
    </authorgroup>
33
31
    <copyright>
34
32
      <year>2008</year>
35
 
      <year>2009</year>
36
 
      <year>2011</year>
37
 
      <holder>Teddy Hogeborn</holder>
38
 
      <holder>Björn Påhlsson</holder>
 
33
      <holder>Teddy Hogeborn &amp; Björn Påhlsson</holder>
39
34
    </copyright>
40
 
    <xi:include href="legalnotice.xml"/>
 
35
    <legalnotice>
 
36
      <para>
 
37
        This manual page is free software: you can redistribute it
 
38
        and/or modify it under the terms of the GNU General Public
 
39
        License as published by the Free Software Foundation,
 
40
        either version 3 of the License, or (at your option) any
 
41
        later version.
 
42
      </para>
 
43
 
 
44
      <para>
 
45
        This manual page is distributed in the hope that it will
 
46
        be useful, but WITHOUT ANY WARRANTY; without even the
 
47
        implied warranty of MERCHANTABILITY or FITNESS FOR A
 
48
        PARTICULAR PURPOSE.  See the GNU General Public License
 
49
        for more details.
 
50
      </para>
 
51
 
 
52
      <para>
 
53
        You should have received a copy of the GNU General Public
 
54
        License along with this program; If not, see
 
55
        <ulink url="http://www.gnu.org/licenses/"/>.
 
56
      </para>
 
57
    </legalnotice>
41
58
  </refentryinfo>
42
 
  
 
59
 
43
60
  <refmeta>
44
61
    <refentrytitle>&COMMANDNAME;</refentrytitle>
45
62
    <manvolnum>8</manvolnum>
48
65
  <refnamediv>
49
66
    <refname><command>&COMMANDNAME;</command></refname>
50
67
    <refpurpose>
51
 
      Generate key and password for Mandos client and server.
 
68
      Generate keys for <citerefentry><refentrytitle>password-request
 
69
      </refentrytitle><manvolnum>8mandos</manvolnum></citerefentry>
52
70
    </refpurpose>
53
71
  </refnamediv>
54
 
  
 
72
 
55
73
  <refsynopsisdiv>
56
74
    <cmdsynopsis>
57
75
      <command>&COMMANDNAME;</command>
58
 
      <group>
59
 
        <arg choice="plain"><option>--dir
60
 
        <replaceable>DIRECTORY</replaceable></option></arg>
61
 
        <arg choice="plain"><option>-d
62
 
        <replaceable>DIRECTORY</replaceable></option></arg>
63
 
      </group>
64
 
      <sbr/>
65
 
      <group>
66
 
        <arg choice="plain"><option>--type
67
 
        <replaceable>KEYTYPE</replaceable></option></arg>
68
 
        <arg choice="plain"><option>-t
69
 
        <replaceable>KEYTYPE</replaceable></option></arg>
70
 
      </group>
71
 
      <sbr/>
72
 
      <group>
73
 
        <arg choice="plain"><option>--length
74
 
        <replaceable>BITS</replaceable></option></arg>
75
 
        <arg choice="plain"><option>-l
76
 
        <replaceable>BITS</replaceable></option></arg>
77
 
      </group>
78
 
      <sbr/>
79
 
      <group>
80
 
        <arg choice="plain"><option>--subtype
81
 
        <replaceable>KEYTYPE</replaceable></option></arg>
82
 
        <arg choice="plain"><option>-s
83
 
        <replaceable>KEYTYPE</replaceable></option></arg>
84
 
      </group>
85
 
      <sbr/>
86
 
      <group>
87
 
        <arg choice="plain"><option>--sublength
88
 
        <replaceable>BITS</replaceable></option></arg>
89
 
        <arg choice="plain"><option>-L
90
 
        <replaceable>BITS</replaceable></option></arg>
91
 
      </group>
92
 
      <sbr/>
93
 
      <group>
94
 
        <arg choice="plain"><option>--name
95
 
        <replaceable>NAME</replaceable></option></arg>
96
 
        <arg choice="plain"><option>-n
97
 
        <replaceable>NAME</replaceable></option></arg>
98
 
      </group>
99
 
      <sbr/>
100
 
      <group>
101
 
        <arg choice="plain"><option>--email
102
 
        <replaceable>ADDRESS</replaceable></option></arg>
103
 
        <arg choice="plain"><option>-e
104
 
        <replaceable>ADDRESS</replaceable></option></arg>
105
 
      </group>
106
 
      <sbr/>
107
 
      <group>
108
 
        <arg choice="plain"><option>--comment
109
 
        <replaceable>TEXT</replaceable></option></arg>
110
 
        <arg choice="plain"><option>-c
111
 
        <replaceable>TEXT</replaceable></option></arg>
112
 
      </group>
113
 
      <sbr/>
114
 
      <group>
115
 
        <arg choice="plain"><option>--expire
116
 
        <replaceable>TIME</replaceable></option></arg>
117
 
        <arg choice="plain"><option>-x
118
 
        <replaceable>TIME</replaceable></option></arg>
119
 
      </group>
120
 
      <sbr/>
121
 
      <arg><option>--force</option></arg>
122
 
    </cmdsynopsis>
123
 
    <cmdsynopsis>
124
 
      <command>&COMMANDNAME;</command>
125
 
      <group choice="req">
126
 
        <arg choice="plain"><option>--password</option></arg>
127
 
        <arg choice="plain"><option>-p</option></arg>
128
 
        <arg choice="plain"><option>--passfile
129
 
        <replaceable>FILE</replaceable></option></arg>
130
 
        <arg choice="plain"><option>-F</option>
131
 
        <replaceable>FILE</replaceable></arg>
132
 
      </group>
133
 
      <sbr/>
134
 
      <group>
135
 
        <arg choice="plain"><option>--dir
136
 
        <replaceable>DIRECTORY</replaceable></option></arg>
137
 
        <arg choice="plain"><option>-d
138
 
        <replaceable>DIRECTORY</replaceable></option></arg>
139
 
      </group>
140
 
      <sbr/>
141
 
      <group>
142
 
        <arg choice="plain"><option>--name
143
 
        <replaceable>NAME</replaceable></option></arg>
144
 
        <arg choice="plain"><option>-n
145
 
        <replaceable>NAME</replaceable></option></arg>
146
 
      </group>
147
 
    </cmdsynopsis>
148
 
    <cmdsynopsis>
149
 
      <command>&COMMANDNAME;</command>
150
 
      <group choice="req">
151
 
        <arg choice="plain"><option>--help</option></arg>
152
 
        <arg choice="plain"><option>-h</option></arg>
153
 
      </group>
154
 
    </cmdsynopsis>
155
 
    <cmdsynopsis>
156
 
      <command>&COMMANDNAME;</command>
157
 
      <group choice="req">
158
 
        <arg choice="plain"><option>--version</option></arg>
159
 
        <arg choice="plain"><option>-v</option></arg>
 
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>
160
154
      </group>
161
155
    </cmdsynopsis>
162
156
  </refsynopsisdiv>
163
 
  
 
157
 
164
158
  <refsect1 id="description">
165
159
    <title>DESCRIPTION</title>
166
160
    <para>
167
161
      <command>&COMMANDNAME;</command> is a program to generate the
168
 
      OpenPGP key used by
169
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
170
 
      <manvolnum>8mandos</manvolnum></citerefentry>.  The key is
 
162
      OpenPGP keys used by
 
163
      <citerefentry><refentrytitle>password-request</refentrytitle>
 
164
      <manvolnum>8mandos</manvolnum></citerefentry>.  The keys are
171
165
      normally written to /etc/mandos for later installation into the
172
 
      initrd image, but this, and most other things, can be changed
173
 
      with command line options.
174
 
    </para>
175
 
    <para>
176
 
      This program can also be used with the
177
 
      <option>--password</option> or <option>--passfile</option>
178
 
      options to generate a ready-made section for
179
 
      <filename>clients.conf</filename> (see
180
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
181
 
      <manvolnum>5</manvolnum></citerefentry>).
 
166
      initrd image, but this, like most things, can be changed with
 
167
      command line options.
182
168
    </para>
183
169
  </refsect1>
184
170
  
185
171
  <refsect1 id="purpose">
186
172
    <title>PURPOSE</title>
 
173
 
187
174
    <para>
188
175
      The purpose of this is to enable <emphasis>remote and unattended
189
176
      rebooting</emphasis> of client host computer with an
190
177
      <emphasis>encrypted root file system</emphasis>.  See <xref
191
178
      linkend="overview"/> for details.
192
179
    </para>
 
180
 
193
181
  </refsect1>
194
182
  
195
183
  <refsect1 id="options">
196
184
    <title>OPTIONS</title>
197
 
    
 
185
 
198
186
    <variablelist>
199
187
      <varlistentry>
200
 
        <term><option>--help</option></term>
201
 
        <term><option>-h</option></term>
 
188
        <term><literal>-h</literal>, <literal>--help</literal></term>
202
189
        <listitem>
203
190
          <para>
204
191
            Show a help message and exit
205
192
          </para>
206
193
        </listitem>
207
194
      </varlistentry>
208
 
      
209
 
      <varlistentry>
210
 
        <term><option>--dir
211
 
        <replaceable>DIRECTORY</replaceable></option></term>
212
 
        <term><option>-d
213
 
        <replaceable>DIRECTORY</replaceable></option></term>
214
 
        <listitem>
215
 
          <para>
216
 
            Target directory for key files.  Default is
217
 
            <filename class="directory">/etc/mandos</filename>.
218
 
          </para>
219
 
        </listitem>
220
 
      </varlistentry>
221
 
      
222
 
      <varlistentry>
223
 
        <term><option>--type
224
 
        <replaceable>TYPE</replaceable></option></term>
225
 
        <term><option>-t
226
 
        <replaceable>TYPE</replaceable></option></term>
227
 
        <listitem>
228
 
          <para>
229
 
            Key type.  Default is <quote>DSA</quote>.
230
 
          </para>
231
 
        </listitem>
232
 
      </varlistentry>
233
 
      
234
 
      <varlistentry>
235
 
        <term><option>--length
236
 
        <replaceable>BITS</replaceable></option></term>
237
 
        <term><option>-l
238
 
        <replaceable>BITS</replaceable></option></term>
239
 
        <listitem>
240
 
          <para>
241
 
            Key length in bits.  Default is 2048.
242
 
          </para>
243
 
        </listitem>
244
 
      </varlistentry>
245
 
      
246
 
      <varlistentry>
247
 
        <term><option>--subtype
248
 
        <replaceable>KEYTYPE</replaceable></option></term>
249
 
        <term><option>-s
250
 
        <replaceable>KEYTYPE</replaceable></option></term>
251
 
        <listitem>
252
 
          <para>
253
 
            Subkey type.  Default is <quote>ELG-E</quote> (Elgamal
254
 
            encryption-only).
255
 
          </para>
256
 
        </listitem>
257
 
      </varlistentry>
258
 
      
259
 
      <varlistentry>
260
 
        <term><option>--sublength
261
 
        <replaceable>BITS</replaceable></option></term>
262
 
        <term><option>-L
263
 
        <replaceable>BITS</replaceable></option></term>
264
 
        <listitem>
265
 
          <para>
266
 
            Subkey length in bits.  Default is 2048.
267
 
          </para>
268
 
        </listitem>
269
 
      </varlistentry>
270
 
      
271
 
      <varlistentry>
272
 
        <term><option>--email
273
 
        <replaceable>ADDRESS</replaceable></option></term>
274
 
        <term><option>-e
275
 
        <replaceable>ADDRESS</replaceable></option></term>
 
195
 
 
196
      <varlistentry>
 
197
        <term><literal>-d</literal>, <literal>--dir
 
198
        <replaceable>directory</replaceable></literal></term>
 
199
        <listitem>
 
200
          <para>
 
201
            Target directory for key files.
 
202
          </para>
 
203
        </listitem>
 
204
      </varlistentry>
 
205
 
 
206
      <varlistentry>
 
207
        <term><literal>-t</literal>, <literal>--type
 
208
        <replaceable>type</replaceable></literal></term>
 
209
        <listitem>
 
210
          <para>
 
211
            Key type.  Default is DSA.
 
212
          </para>
 
213
        </listitem>
 
214
      </varlistentry>
 
215
 
 
216
      <varlistentry>
 
217
        <term><literal>-l</literal>, <literal>--length
 
218
        <replaceable>bits</replaceable></literal></term>
 
219
        <listitem>
 
220
          <para>
 
221
            Key length in bits.  Default is 1024.
 
222
          </para>
 
223
        </listitem>
 
224
      </varlistentry>
 
225
 
 
226
      <varlistentry>
 
227
        <term><literal>-e</literal>, <literal>--email</literal>
 
228
        <replaceable>address</replaceable></term>
276
229
        <listitem>
277
230
          <para>
278
231
            Email address of key.  Default is empty.
279
232
          </para>
280
233
        </listitem>
281
234
      </varlistentry>
282
 
      
 
235
 
283
236
      <varlistentry>
284
 
        <term><option>--comment
285
 
        <replaceable>TEXT</replaceable></option></term>
286
 
        <term><option>-c
287
 
        <replaceable>TEXT</replaceable></option></term>
 
237
        <term><literal>-c</literal>, <literal>--comment</literal>
 
238
        <replaceable>comment</replaceable></term>
288
239
        <listitem>
289
240
          <para>
290
241
            Comment field for key.  The default value is
291
 
            <quote><literal>Mandos client key</literal></quote>.
 
242
            "<literal>Mandos client key</literal>".
292
243
          </para>
293
244
        </listitem>
294
245
      </varlistentry>
295
 
      
 
246
 
296
247
      <varlistentry>
297
 
        <term><option>--expire
298
 
        <replaceable>TIME</replaceable></option></term>
299
 
        <term><option>-x
300
 
        <replaceable>TIME</replaceable></option></term>
 
248
        <term><literal>-x</literal>, <literal>--expire</literal>
 
249
        <replaceable>time</replaceable></term>
301
250
        <listitem>
302
251
          <para>
303
252
            Key expire time.  Default is no expiration.  See
306
255
          </para>
307
256
        </listitem>
308
257
      </varlistentry>
309
 
      
310
 
      <varlistentry>
311
 
        <term><option>--force</option></term>
312
 
        <term><option>-f</option></term>
313
 
        <listitem>
314
 
          <para>
315
 
            Force overwriting old key.
316
 
          </para>
317
 
        </listitem>
318
 
      </varlistentry>
319
 
      <varlistentry>
320
 
        <term><option>--password</option></term>
321
 
        <term><option>-p</option></term>
322
 
        <listitem>
323
 
          <para>
324
 
            Prompt for a password and encrypt it with the key already
325
 
            present in either <filename>/etc/mandos</filename> or the
326
 
            directory specified with the <option>--dir</option>
327
 
            option.  Outputs, on standard output, a section suitable
328
 
            for inclusion in <citerefentry><refentrytitle
329
 
            >mandos-clients.conf</refentrytitle><manvolnum
330
 
            >8</manvolnum></citerefentry>.  The host name or the name
331
 
            specified with the <option>--name</option> option is used
332
 
            for the section header.  All other options are ignored,
333
 
            and no key is created.
334
 
          </para>
335
 
        </listitem>
336
 
      </varlistentry>
337
 
      <varlistentry>
338
 
        <term><option>--passfile
339
 
        <replaceable>FILE</replaceable></option></term>
340
 
        <term><option>-F
341
 
        <replaceable>FILE</replaceable></option></term>
342
 
        <listitem>
343
 
          <para>
344
 
            The same as <option>--password</option>, but read from
345
 
            <replaceable>FILE</replaceable>, not the terminal.
 
258
 
 
259
      <varlistentry>
 
260
        <term><literal>-f</literal>, <literal>--force</literal></term>
 
261
        <listitem>
 
262
          <para>
 
263
            Force overwriting old keys.
346
264
          </para>
347
265
        </listitem>
348
266
      </varlistentry>
349
267
    </variablelist>
350
268
  </refsect1>
351
 
  
 
269
 
352
270
  <refsect1 id="overview">
353
271
    <title>OVERVIEW</title>
354
 
    <xi:include href="overview.xml"/>
 
272
    &OVERVIEW;
355
273
    <para>
356
 
      This program is a small utility to generate new OpenPGP keys for
357
 
      new Mandos clients, and to generate sections for inclusion in
358
 
      <filename>clients.conf</filename> on the server.
 
274
      This program is a small program to generate new OpenPGP keys for
 
275
      new Mandos clients.
359
276
    </para>
360
277
  </refsect1>
361
 
  
 
278
 
362
279
  <refsect1 id="exit_status">
363
280
    <title>EXIT STATUS</title>
364
281
    <para>
365
 
      The exit status will be 0 if a new key (or password, if the
366
 
      <option>--password</option> option was used) was successfully
367
 
      created, otherwise not.
 
282
      The exit status will be 0 if new keys were successfully created,
 
283
      otherwise not.
368
284
    </para>
369
285
  </refsect1>
370
286
  
372
288
    <title>ENVIRONMENT</title>
373
289
    <variablelist>
374
290
      <varlistentry>
375
 
        <term><envar>TMPDIR</envar></term>
 
291
        <term><varname>TMPDIR</varname></term>
376
292
        <listitem>
377
293
          <para>
378
294
            If set, temporary files will be created here. See
384
300
    </variablelist>
385
301
  </refsect1>
386
302
  
387
 
  <refsect1 id="files">
 
303
  <refsect1 id="file">
388
304
    <title>FILES</title>
389
305
    <para>
390
306
      Use the <option>--dir</option> option to change where
411
327
        </listitem>
412
328
      </varlistentry>
413
329
      <varlistentry>
414
 
        <term><filename class="directory">/tmp</filename></term>
 
330
        <term><filename>/tmp</filename></term>
415
331
        <listitem>
416
332
          <para>
417
333
            Temporary files will be written here if
421
337
      </varlistentry>
422
338
    </variablelist>
423
339
  </refsect1>
424
 
  
425
 
<!--   <refsect1 id="bugs"> -->
426
 
<!--     <title>BUGS</title> -->
427
 
<!--     <para> -->
428
 
<!--     </para> -->
429
 
<!--   </refsect1> -->
430
 
  
 
340
 
 
341
  <refsect1 id="bugs">
 
342
    <title>BUGS</title>
 
343
    <para>
 
344
      None are known at this time.
 
345
    </para>
 
346
  </refsect1>
 
347
 
431
348
  <refsect1 id="example">
432
349
    <title>EXAMPLE</title>
433
350
    <informalexample>
435
352
        Normal invocation needs no options:
436
353
      </para>
437
354
      <para>
438
 
        <userinput>&COMMANDNAME;</userinput>
 
355
        <userinput>mandos-keygen</userinput>
439
356
      </para>
440
357
    </informalexample>
441
358
    <informalexample>
442
359
      <para>
443
 
        Create key in another directory and of another type.  Force
 
360
        Create keys in another directory and of another type.  Force
444
361
        overwriting old key files:
445
362
      </para>
446
363
      <para>
447
364
 
448
365
<!-- do not wrap this line -->
449
 
<userinput>&COMMANDNAME; --dir ~/keydir --type RSA --force</userinput>
450
 
 
451
 
      </para>
452
 
    </informalexample>
453
 
    <informalexample>
454
 
      <para>
455
 
        Prompt for a password, encrypt it with the key in <filename
456
 
        class="directory">/etc/mandos</filename> and output a section
457
 
        suitable for <filename>clients.conf</filename>.
458
 
      </para>
459
 
      <para>
460
 
        <userinput>&COMMANDNAME; --password</userinput>
461
 
      </para>
462
 
    </informalexample>
463
 
    <informalexample>
464
 
      <para>
465
 
        Prompt for a password, encrypt it with the key in the
466
 
        <filename>client-key</filename> directory and output a section
467
 
        suitable for <filename>clients.conf</filename>.
468
 
      </para>
469
 
      <para>
470
 
 
471
 
<!-- do not wrap this line -->
472
 
<userinput>&COMMANDNAME; --password --dir client-key</userinput>
 
366
<userinput>mandos-keygen --dir ~/keydir --type RSA --force</userinput>
473
367
 
474
368
      </para>
475
369
    </informalexample>
476
370
  </refsect1>
477
 
  
 
371
 
478
372
  <refsect1 id="security">
479
373
    <title>SECURITY</title>
480
374
    <para>
481
 
      The <option>--type</option>, <option>--length</option>,
482
 
      <option>--subtype</option>, and <option>--sublength</option>
483
 
      options can be used to create keys of low security.  If in
484
 
      doubt, leave them to the default values.
 
375
      The <option>--type</option> and <option>--length</option>
 
376
      options can be used to create keys of insufficient security.  If
 
377
      in doubt, leave them to the default values.
485
378
    </para>
486
379
    <para>
487
 
      The key expire time is <emphasis>not</emphasis> guaranteed to be
488
 
      honored by <citerefentry><refentrytitle>mandos</refentrytitle>
 
380
      The key expire time is not guaranteed to be honored by
 
381
      <citerefentry><refentrytitle>mandos</refentrytitle>
489
382
      <manvolnum>8</manvolnum></citerefentry>.
490
383
    </para>
491
384
  </refsect1>
492
 
  
 
385
 
493
386
  <refsect1 id="see_also">
494
387
    <title>SEE ALSO</title>
495
388
    <para>
496
 
      <citerefentry><refentrytitle>intro</refentrytitle>
 
389
      <citerefentry><refentrytitle>password-request</refentrytitle>
497
390
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
391
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
392
      <manvolnum>8</manvolnum></citerefentry>, and
498
393
      <citerefentry><refentrytitle>gpg</refentrytitle>
499
 
      <manvolnum>1</manvolnum></citerefentry>,
500
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
501
 
      <manvolnum>5</manvolnum></citerefentry>,
502
 
      <citerefentry><refentrytitle>mandos</refentrytitle>
503
 
      <manvolnum>8</manvolnum></citerefentry>,
504
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
505
 
      <manvolnum>8mandos</manvolnum></citerefentry>
 
394
      <manvolnum>1</manvolnum></citerefentry>
506
395
    </para>
507
396
  </refsect1>
508
397
  
509
398
</refentry>
510
 
<!-- Local Variables: -->
511
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
512
 
<!-- time-stamp-end: "[\"']>" -->
513
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
514
 
<!-- End: -->