/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-18 23:55:28 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080818235528-dn628nlbrtzl7z4f
* Makefile: Bug fix: fixed creation of man pages for section 5 pages.

* mandos (main): Changed from requiring "[server]" in mandos.conf(5)
                 to requiring "[DEFAULT]".

* mandos.conf ([server]): Renamed to "[DEFAULT]".

* mandos.conf.xml: Removed <?xml-stylesheet>.  New entity "&OVERVIEW;"
                   referring to "overview.xml".
  (DESCRIPTION): Updated to specify the syntax more precisely.  Use
                 <varname> around the option names.

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 "2015-07-20">
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>2010</year>
37
 
      <year>2011</year>
38
 
      <year>2012</year>
39
 
      <year>2013</year>
40
 
      <year>2014</year>
41
 
      <year>2015</year>
42
 
      <holder>Teddy Hogeborn</holder>
43
 
      <holder>Björn Påhlsson</holder>
 
33
      <holder>Teddy Hogeborn &amp; Björn Påhlsson</holder>
44
34
    </copyright>
45
 
    <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>
46
58
  </refentryinfo>
47
 
  
 
59
 
48
60
  <refmeta>
49
61
    <refentrytitle>&COMMANDNAME;</refentrytitle>
50
62
    <manvolnum>8</manvolnum>
53
65
  <refnamediv>
54
66
    <refname><command>&COMMANDNAME;</command></refname>
55
67
    <refpurpose>
56
 
      Generate key and password for Mandos client and server.
 
68
      Generate keys for <citerefentry><refentrytitle>password-request
 
69
      </refentrytitle><manvolnum>8mandos</manvolnum></citerefentry>
57
70
    </refpurpose>
58
71
  </refnamediv>
59
 
  
 
72
 
60
73
  <refsynopsisdiv>
61
74
    <cmdsynopsis>
62
75
      <command>&COMMANDNAME;</command>
63
 
      <group>
64
 
        <arg choice="plain"><option>--dir
65
 
        <replaceable>DIRECTORY</replaceable></option></arg>
66
 
        <arg choice="plain"><option>-d
67
 
        <replaceable>DIRECTORY</replaceable></option></arg>
68
 
      </group>
69
 
      <sbr/>
70
 
      <group>
71
 
        <arg choice="plain"><option>--type
72
 
        <replaceable>KEYTYPE</replaceable></option></arg>
73
 
        <arg choice="plain"><option>-t
74
 
        <replaceable>KEYTYPE</replaceable></option></arg>
75
 
      </group>
76
 
      <sbr/>
77
 
      <group>
78
 
        <arg choice="plain"><option>--length
79
 
        <replaceable>BITS</replaceable></option></arg>
80
 
        <arg choice="plain"><option>-l
81
 
        <replaceable>BITS</replaceable></option></arg>
82
 
      </group>
83
 
      <sbr/>
84
 
      <group>
85
 
        <arg choice="plain"><option>--subtype
86
 
        <replaceable>KEYTYPE</replaceable></option></arg>
87
 
        <arg choice="plain"><option>-s
88
 
        <replaceable>KEYTYPE</replaceable></option></arg>
89
 
      </group>
90
 
      <sbr/>
91
 
      <group>
92
 
        <arg choice="plain"><option>--sublength
93
 
        <replaceable>BITS</replaceable></option></arg>
94
 
        <arg choice="plain"><option>-L
95
 
        <replaceable>BITS</replaceable></option></arg>
96
 
      </group>
97
 
      <sbr/>
98
 
      <group>
99
 
        <arg choice="plain"><option>--name
100
 
        <replaceable>NAME</replaceable></option></arg>
101
 
        <arg choice="plain"><option>-n
102
 
        <replaceable>NAME</replaceable></option></arg>
103
 
      </group>
104
 
      <sbr/>
105
 
      <group>
106
 
        <arg choice="plain"><option>--email
107
 
        <replaceable>ADDRESS</replaceable></option></arg>
108
 
        <arg choice="plain"><option>-e
109
 
        <replaceable>ADDRESS</replaceable></option></arg>
110
 
      </group>
111
 
      <sbr/>
112
 
      <group>
113
 
        <arg choice="plain"><option>--comment
114
 
        <replaceable>TEXT</replaceable></option></arg>
115
 
        <arg choice="plain"><option>-c
116
 
        <replaceable>TEXT</replaceable></option></arg>
117
 
      </group>
118
 
      <sbr/>
119
 
      <group>
120
 
        <arg choice="plain"><option>--expire
121
 
        <replaceable>TIME</replaceable></option></arg>
122
 
        <arg choice="plain"><option>-x
123
 
        <replaceable>TIME</replaceable></option></arg>
124
 
      </group>
125
 
      <sbr/>
126
 
      <group>
 
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">
127
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">
128
139
        <arg choice="plain"><option>-f</option></arg>
129
140
      </group>
130
141
    </cmdsynopsis>
131
142
    <cmdsynopsis>
132
143
      <command>&COMMANDNAME;</command>
133
144
      <group choice="req">
134
 
        <arg choice="plain"><option>--password</option></arg>
135
 
        <arg choice="plain"><option>-p</option></arg>
136
 
        <arg choice="plain"><option>--passfile
137
 
        <replaceable>FILE</replaceable></option></arg>
138
 
        <arg choice="plain"><option>-F</option>
139
 
        <replaceable>FILE</replaceable></arg>
140
 
      </group>
141
 
      <sbr/>
142
 
      <group>
143
 
        <arg choice="plain"><option>--dir
144
 
        <replaceable>DIRECTORY</replaceable></option></arg>
145
 
        <arg choice="plain"><option>-d
146
 
        <replaceable>DIRECTORY</replaceable></option></arg>
147
 
      </group>
148
 
      <sbr/>
149
 
      <group>
150
 
        <arg choice="plain"><option>--name
151
 
        <replaceable>NAME</replaceable></option></arg>
152
 
        <arg choice="plain"><option>-n
153
 
        <replaceable>NAME</replaceable></option></arg>
154
 
      </group>
155
 
      <group>
156
 
        <arg choice="plain"><option>--no-ssh</option></arg>
157
 
        <arg choice="plain"><option>-S</option></arg>
158
 
      </group>
159
 
    </cmdsynopsis>
160
 
    <cmdsynopsis>
161
 
      <command>&COMMANDNAME;</command>
162
 
      <group choice="req">
163
 
        <arg choice="plain"><option>--help</option></arg>
164
 
        <arg choice="plain"><option>-h</option></arg>
165
 
      </group>
166
 
    </cmdsynopsis>
167
 
    <cmdsynopsis>
168
 
      <command>&COMMANDNAME;</command>
169
 
      <group choice="req">
170
 
        <arg choice="plain"><option>--version</option></arg>
171
 
        <arg choice="plain"><option>-v</option></arg>
 
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>
172
154
      </group>
173
155
    </cmdsynopsis>
174
156
  </refsynopsisdiv>
175
 
  
 
157
 
176
158
  <refsect1 id="description">
177
159
    <title>DESCRIPTION</title>
178
160
    <para>
179
161
      <command>&COMMANDNAME;</command> is a program to generate the
180
 
      OpenPGP key used by
181
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
182
 
      <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
183
165
      normally written to /etc/mandos for later installation into the
184
 
      initrd image, but this, and most other things, can be changed
185
 
      with command line options.
186
 
    </para>
187
 
    <para>
188
 
      This program can also be used with the
189
 
      <option>--password</option> or <option>--passfile</option>
190
 
      options to generate a ready-made section for
191
 
      <filename>clients.conf</filename> (see
192
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
193
 
      <manvolnum>5</manvolnum></citerefentry>).
 
166
      initrd image, but this, like most things, can be changed with
 
167
      command line options.
194
168
    </para>
195
169
  </refsect1>
196
170
  
197
171
  <refsect1 id="purpose">
198
172
    <title>PURPOSE</title>
 
173
 
199
174
    <para>
200
175
      The purpose of this is to enable <emphasis>remote and unattended
201
176
      rebooting</emphasis> of client host computer with an
202
177
      <emphasis>encrypted root file system</emphasis>.  See <xref
203
178
      linkend="overview"/> for details.
204
179
    </para>
 
180
 
205
181
  </refsect1>
206
182
  
207
183
  <refsect1 id="options">
208
184
    <title>OPTIONS</title>
209
 
    
 
185
 
210
186
    <variablelist>
211
187
      <varlistentry>
212
 
        <term><option>--help</option></term>
213
 
        <term><option>-h</option></term>
 
188
        <term><literal>-h</literal>, <literal>--help</literal></term>
214
189
        <listitem>
215
190
          <para>
216
191
            Show a help message and exit
217
192
          </para>
218
193
        </listitem>
219
194
      </varlistentry>
220
 
      
221
 
      <varlistentry>
222
 
        <term><option>--dir
223
 
        <replaceable>DIRECTORY</replaceable></option></term>
224
 
        <term><option>-d
225
 
        <replaceable>DIRECTORY</replaceable></option></term>
226
 
        <listitem>
227
 
          <para>
228
 
            Target directory for key files.  Default is
229
 
            <filename class="directory">/etc/mandos</filename>.
230
 
          </para>
231
 
        </listitem>
232
 
      </varlistentry>
233
 
      
234
 
      <varlistentry>
235
 
        <term><option>--type
236
 
        <replaceable>TYPE</replaceable></option></term>
237
 
        <term><option>-t
238
 
        <replaceable>TYPE</replaceable></option></term>
239
 
        <listitem>
240
 
          <para>
241
 
            Key type.  Default is <quote>RSA</quote>.
242
 
          </para>
243
 
        </listitem>
244
 
      </varlistentry>
245
 
      
246
 
      <varlistentry>
247
 
        <term><option>--length
248
 
        <replaceable>BITS</replaceable></option></term>
249
 
        <term><option>-l
250
 
        <replaceable>BITS</replaceable></option></term>
251
 
        <listitem>
252
 
          <para>
253
 
            Key length in bits.  Default is 4096.
254
 
          </para>
255
 
        </listitem>
256
 
      </varlistentry>
257
 
      
258
 
      <varlistentry>
259
 
        <term><option>--subtype
260
 
        <replaceable>KEYTYPE</replaceable></option></term>
261
 
        <term><option>-s
262
 
        <replaceable>KEYTYPE</replaceable></option></term>
263
 
        <listitem>
264
 
          <para>
265
 
            Subkey type.  Default is <quote>RSA</quote> (Elgamal
266
 
            encryption-only).
267
 
          </para>
268
 
        </listitem>
269
 
      </varlistentry>
270
 
      
271
 
      <varlistentry>
272
 
        <term><option>--sublength
273
 
        <replaceable>BITS</replaceable></option></term>
274
 
        <term><option>-L
275
 
        <replaceable>BITS</replaceable></option></term>
276
 
        <listitem>
277
 
          <para>
278
 
            Subkey length in bits.  Default is 4096.
279
 
          </para>
280
 
        </listitem>
281
 
      </varlistentry>
282
 
      
283
 
      <varlistentry>
284
 
        <term><option>--email
285
 
        <replaceable>ADDRESS</replaceable></option></term>
286
 
        <term><option>-e
287
 
        <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>
288
229
        <listitem>
289
230
          <para>
290
231
            Email address of key.  Default is empty.
291
232
          </para>
292
233
        </listitem>
293
234
      </varlistentry>
294
 
      
 
235
 
295
236
      <varlistentry>
296
 
        <term><option>--comment
297
 
        <replaceable>TEXT</replaceable></option></term>
298
 
        <term><option>-c
299
 
        <replaceable>TEXT</replaceable></option></term>
 
237
        <term><literal>-c</literal>, <literal>--comment</literal>
 
238
        <replaceable>comment</replaceable></term>
300
239
        <listitem>
301
240
          <para>
302
 
            Comment field for key.  Default is empty.
 
241
            Comment field for key.  The default value is
 
242
            "<literal>Mandos client key</literal>".
303
243
          </para>
304
244
        </listitem>
305
245
      </varlistentry>
306
 
      
 
246
 
307
247
      <varlistentry>
308
 
        <term><option>--expire
309
 
        <replaceable>TIME</replaceable></option></term>
310
 
        <term><option>-x
311
 
        <replaceable>TIME</replaceable></option></term>
 
248
        <term><literal>-x</literal>, <literal>--expire</literal>
 
249
        <replaceable>time</replaceable></term>
312
250
        <listitem>
313
251
          <para>
314
252
            Key expire time.  Default is no expiration.  See
317
255
          </para>
318
256
        </listitem>
319
257
      </varlistentry>
320
 
      
321
 
      <varlistentry>
322
 
        <term><option>--force</option></term>
323
 
        <term><option>-f</option></term>
324
 
        <listitem>
325
 
          <para>
326
 
            Force overwriting old key.
327
 
          </para>
328
 
        </listitem>
329
 
      </varlistentry>
330
 
      <varlistentry>
331
 
        <term><option>--password</option></term>
332
 
        <term><option>-p</option></term>
333
 
        <listitem>
334
 
          <para>
335
 
            Prompt for a password and encrypt it with the key already
336
 
            present in either <filename>/etc/mandos</filename> or the
337
 
            directory specified with the <option>--dir</option>
338
 
            option.  Outputs, on standard output, a section suitable
339
 
            for inclusion in <citerefentry><refentrytitle
340
 
            >mandos-clients.conf</refentrytitle><manvolnum
341
 
            >8</manvolnum></citerefentry>.  The host name or the name
342
 
            specified with the <option>--name</option> option is used
343
 
            for the section header.  All other options are ignored,
344
 
            and no key is created.
345
 
          </para>
346
 
        </listitem>
347
 
      </varlistentry>
348
 
      <varlistentry>
349
 
        <term><option>--passfile
350
 
        <replaceable>FILE</replaceable></option></term>
351
 
        <term><option>-F
352
 
        <replaceable>FILE</replaceable></option></term>
353
 
        <listitem>
354
 
          <para>
355
 
            The same as <option>--password</option>, but read from
356
 
            <replaceable>FILE</replaceable>, not the terminal.
357
 
          </para>
358
 
        </listitem>
359
 
      </varlistentry>
360
 
      <varlistentry>
361
 
        <term><option>--no-ssh</option></term>
362
 
        <term><option>-S</option></term>
363
 
        <listitem>
364
 
          <para>
365
 
            When <option>--password</option> or
366
 
            <option>--passfile</option> is given, this option will
367
 
            prevent <command>&COMMANDNAME;</command> from calling
368
 
            <command>ssh-keyscan</command> to get an SSH fingerprint
369
 
            for this host and, if successful, output suitable config
370
 
            options to use this fingerprint as a
371
 
            <option>checker</option> option in the output.  This is
372
 
            otherwise the default behavior.
 
258
 
 
259
      <varlistentry>
 
260
        <term><literal>-f</literal>, <literal>--force</literal></term>
 
261
        <listitem>
 
262
          <para>
 
263
            Force overwriting old keys.
373
264
          </para>
374
265
        </listitem>
375
266
      </varlistentry>
376
267
    </variablelist>
377
268
  </refsect1>
378
 
  
 
269
 
379
270
  <refsect1 id="overview">
380
271
    <title>OVERVIEW</title>
381
 
    <xi:include href="overview.xml"/>
 
272
    &OVERVIEW;
382
273
    <para>
383
 
      This program is a small utility to generate new OpenPGP keys for
384
 
      new Mandos clients, and to generate sections for inclusion in
385
 
      <filename>clients.conf</filename> on the server.
 
274
      This program is a small program to generate new OpenPGP keys for
 
275
      new Mandos clients.
386
276
    </para>
387
277
  </refsect1>
388
 
  
 
278
 
389
279
  <refsect1 id="exit_status">
390
280
    <title>EXIT STATUS</title>
391
281
    <para>
392
 
      The exit status will be 0 if a new key (or password, if the
393
 
      <option>--password</option> option was used) was successfully
394
 
      created, otherwise not.
 
282
      The exit status will be 0 if new keys were successfully created,
 
283
      otherwise not.
395
284
    </para>
396
285
  </refsect1>
397
286
  
399
288
    <title>ENVIRONMENT</title>
400
289
    <variablelist>
401
290
      <varlistentry>
402
 
        <term><envar>TMPDIR</envar></term>
 
291
        <term><varname>TMPDIR</varname></term>
403
292
        <listitem>
404
293
          <para>
405
294
            If set, temporary files will be created here. See
411
300
    </variablelist>
412
301
  </refsect1>
413
302
  
414
 
  <refsect1 id="files">
 
303
  <refsect1 id="file">
415
304
    <title>FILES</title>
416
305
    <para>
417
306
      Use the <option>--dir</option> option to change where
438
327
        </listitem>
439
328
      </varlistentry>
440
329
      <varlistentry>
441
 
        <term><filename class="directory">/tmp</filename></term>
 
330
        <term><filename>/tmp</filename></term>
442
331
        <listitem>
443
332
          <para>
444
333
            Temporary files will be written here if
448
337
      </varlistentry>
449
338
    </variablelist>
450
339
  </refsect1>
451
 
  
452
 
<!--   <refsect1 id="bugs"> -->
453
 
<!--     <title>BUGS</title> -->
454
 
<!--     <para> -->
455
 
<!--     </para> -->
456
 
<!--   </refsect1> -->
457
 
  
 
340
 
 
341
  <refsect1 id="bugs">
 
342
    <title>BUGS</title>
 
343
    <para>
 
344
      None are known at this time.
 
345
    </para>
 
346
  </refsect1>
 
347
 
458
348
  <refsect1 id="example">
459
349
    <title>EXAMPLE</title>
460
350
    <informalexample>
462
352
        Normal invocation needs no options:
463
353
      </para>
464
354
      <para>
465
 
        <userinput>&COMMANDNAME;</userinput>
 
355
        <userinput>mandos-keygen</userinput>
466
356
      </para>
467
357
    </informalexample>
468
358
    <informalexample>
469
359
      <para>
470
 
        Create key in another directory and of another type.  Force
 
360
        Create keys in another directory and of another type.  Force
471
361
        overwriting old key files:
472
362
      </para>
473
363
      <para>
474
364
 
475
365
<!-- do not wrap this line -->
476
 
<userinput>&COMMANDNAME; --dir ~/keydir --type RSA --force</userinput>
477
 
 
478
 
      </para>
479
 
    </informalexample>
480
 
    <informalexample>
481
 
      <para>
482
 
        Prompt for a password, encrypt it with the key in <filename
483
 
        class="directory">/etc/mandos</filename> and output a section
484
 
        suitable for <filename>clients.conf</filename>.
485
 
      </para>
486
 
      <para>
487
 
        <userinput>&COMMANDNAME; --password</userinput>
488
 
      </para>
489
 
    </informalexample>
490
 
    <informalexample>
491
 
      <para>
492
 
        Prompt for a password, encrypt it with the key in the
493
 
        <filename>client-key</filename> directory and output a section
494
 
        suitable for <filename>clients.conf</filename>.
495
 
      </para>
496
 
      <para>
497
 
 
498
 
<!-- do not wrap this line -->
499
 
<userinput>&COMMANDNAME; --password --dir client-key</userinput>
 
366
<userinput>mandos-keygen --dir ~/keydir --type RSA --force</userinput>
500
367
 
501
368
      </para>
502
369
    </informalexample>
503
370
  </refsect1>
504
 
  
 
371
 
505
372
  <refsect1 id="security">
506
373
    <title>SECURITY</title>
507
374
    <para>
508
 
      The <option>--type</option>, <option>--length</option>,
509
 
      <option>--subtype</option>, and <option>--sublength</option>
510
 
      options can be used to create keys of low security.  If in
511
 
      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.
512
378
    </para>
513
379
    <para>
514
 
      The key expire time is <emphasis>not</emphasis> guaranteed to be
515
 
      honored by <citerefentry><refentrytitle>mandos</refentrytitle>
 
380
      The key expire time is not guaranteed to be honored by
 
381
      <citerefentry><refentrytitle>mandos</refentrytitle>
516
382
      <manvolnum>8</manvolnum></citerefentry>.
517
383
    </para>
518
384
  </refsect1>
519
 
  
 
385
 
520
386
  <refsect1 id="see_also">
521
387
    <title>SEE ALSO</title>
522
388
    <para>
523
 
      <citerefentry><refentrytitle>intro</refentrytitle>
 
389
      <citerefentry><refentrytitle>password-request</refentrytitle>
524
390
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
391
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
392
      <manvolnum>8</manvolnum></citerefentry>, and
525
393
      <citerefentry><refentrytitle>gpg</refentrytitle>
526
 
      <manvolnum>1</manvolnum></citerefentry>,
527
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
528
 
      <manvolnum>5</manvolnum></citerefentry>,
529
 
      <citerefentry><refentrytitle>mandos</refentrytitle>
530
 
      <manvolnum>8</manvolnum></citerefentry>,
531
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
532
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
533
 
      <citerefentry><refentrytitle>ssh-keyscan</refentrytitle>
534
394
      <manvolnum>1</manvolnum></citerefentry>
535
395
    </para>
536
396
  </refsect1>
537
397
  
538
398
</refentry>
539
 
<!-- Local Variables: -->
540
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
541
 
<!-- time-stamp-end: "[\"']>" -->
542
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
543
 
<!-- End: -->