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