/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

Merge change to add local route when network is "unreachable".

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-keygen.xml
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 COMMANDNAME "mandos-keygen">
5
 
<!ENTITY TIMESTAMP "2008-10-03">
 
5
<!ENTITY TIMESTAMP "2014-06-22">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
19
19
        <firstname>Björn</firstname>
20
20
        <surname>Påhlsson</surname>
21
21
        <address>
22
 
          <email>belorn@fukt.bsnet.se</email>
 
22
          <email>belorn@recompile.se</email>
23
23
        </address>
24
24
      </author>
25
25
      <author>
26
26
        <firstname>Teddy</firstname>
27
27
        <surname>Hogeborn</surname>
28
28
        <address>
29
 
          <email>teddy@fukt.bsnet.se</email>
 
29
          <email>teddy@recompile.se</email>
30
30
        </address>
31
31
      </author>
32
32
    </authorgroup>
33
33
    <copyright>
34
34
      <year>2008</year>
 
35
      <year>2009</year>
 
36
      <year>2011</year>
 
37
      <year>2012</year>
35
38
      <holder>Teddy Hogeborn</holder>
36
39
      <holder>Björn Påhlsson</holder>
37
40
    </copyright>
116
119
        <replaceable>TIME</replaceable></option></arg>
117
120
      </group>
118
121
      <sbr/>
119
 
      <arg><option>--force</option></arg>
 
122
      <group>
 
123
        <arg choice="plain"><option>--force</option></arg>
 
124
        <arg choice="plain"><option>-f</option></arg>
 
125
      </group>
120
126
    </cmdsynopsis>
121
127
    <cmdsynopsis>
122
128
      <command>&COMMANDNAME;</command>
142
148
        <arg choice="plain"><option>-n
143
149
        <replaceable>NAME</replaceable></option></arg>
144
150
      </group>
 
151
      <group>
 
152
        <arg choice="plain"><option>--no-ssh</option></arg>
 
153
        <arg choice="plain"><option>-S</option></arg>
 
154
      </group>
145
155
    </cmdsynopsis>
146
156
    <cmdsynopsis>
147
157
      <command>&COMMANDNAME;</command>
212
222
        <listitem>
213
223
          <para>
214
224
            Target directory for key files.  Default is
215
 
            <filename>/etc/mandos</filename>.
 
225
            <filename class="directory">/etc/mandos</filename>.
216
226
          </para>
217
227
        </listitem>
218
228
      </varlistentry>
224
234
        <replaceable>TYPE</replaceable></option></term>
225
235
        <listitem>
226
236
          <para>
227
 
            Key type.  Default is <quote>DSA</quote>.
 
237
            Key type.  Default is <quote>RSA</quote>.
228
238
          </para>
229
239
        </listitem>
230
240
      </varlistentry>
236
246
        <replaceable>BITS</replaceable></option></term>
237
247
        <listitem>
238
248
          <para>
239
 
            Key length in bits.  Default is 2048.
 
249
            Key length in bits.  Default is 4096.
240
250
          </para>
241
251
        </listitem>
242
252
      </varlistentry>
248
258
        <replaceable>KEYTYPE</replaceable></option></term>
249
259
        <listitem>
250
260
          <para>
251
 
            Subkey type.  Default is <quote>ELG-E</quote> (Elgamal
 
261
            Subkey type.  Default is <quote>RSA</quote> (Elgamal
252
262
            encryption-only).
253
263
          </para>
254
264
        </listitem>
261
271
        <replaceable>BITS</replaceable></option></term>
262
272
        <listitem>
263
273
          <para>
264
 
            Subkey length in bits.  Default is 2048.
 
274
            Subkey length in bits.  Default is 4096.
265
275
          </para>
266
276
        </listitem>
267
277
      </varlistentry>
285
295
        <replaceable>TEXT</replaceable></option></term>
286
296
        <listitem>
287
297
          <para>
288
 
            Comment field for key.  The default value is
289
 
            <quote><literal>Mandos client key</literal></quote>.
 
298
            Comment field for key.  Default is empty.
290
299
          </para>
291
300
        </listitem>
292
301
      </varlistentry>
344
353
          </para>
345
354
        </listitem>
346
355
      </varlistentry>
 
356
      <varlistentry>
 
357
        <term><option>--no-ssh</option></term>
 
358
        <term><option>-S</option></term>
 
359
        <listitem>
 
360
          <para>
 
361
            When <option>--password</option> or
 
362
            <option>--passfile</option> is given, this option will
 
363
            prevent <command>&COMMANDNAME;</command> from calling
 
364
            <command>ssh-keyscan</command> to get an SSH fingerprint
 
365
            for this host and, if successful, output suitable config
 
366
            options to use this fingerprint as a
 
367
            <option>checker</option> option in the output.  This is
 
368
            otherwise the default behavior.
 
369
          </para>
 
370
        </listitem>
 
371
      </varlistentry>
347
372
    </variablelist>
348
373
  </refsect1>
349
374
  
409
434
        </listitem>
410
435
      </varlistentry>
411
436
      <varlistentry>
412
 
        <term><filename>/tmp</filename></term>
 
437
        <term><filename class="directory">/tmp</filename></term>
413
438
        <listitem>
414
439
          <para>
415
440
            Temporary files will be written here if
450
475
    </informalexample>
451
476
    <informalexample>
452
477
      <para>
453
 
        Prompt for a password, encrypt it with the key in
454
 
        <filename>/etc/mandos</filename> and output a section suitable
455
 
        for <filename>clients.conf</filename>.
 
478
        Prompt for a password, encrypt it with the key in <filename
 
479
        class="directory">/etc/mandos</filename> and output a section
 
480
        suitable for <filename>clients.conf</filename>.
456
481
      </para>
457
482
      <para>
458
483
        <userinput>&COMMANDNAME; --password</userinput>
491
516
  <refsect1 id="see_also">
492
517
    <title>SEE ALSO</title>
493
518
    <para>
 
519
      <citerefentry><refentrytitle>intro</refentrytitle>
 
520
      <manvolnum>8mandos</manvolnum></citerefentry>,
494
521
      <citerefentry><refentrytitle>gpg</refentrytitle>
495
522
      <manvolnum>1</manvolnum></citerefentry>,
496
523
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
498
525
      <citerefentry><refentrytitle>mandos</refentrytitle>
499
526
      <manvolnum>8</manvolnum></citerefentry>,
500
527
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
501
 
      <manvolnum>8mandos</manvolnum></citerefentry>
 
528
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
529
      <citerefentry><refentrytitle>ssh-keyscan</refentrytitle>
 
530
      <manvolnum>1</manvolnum></citerefentry>
502
531
    </para>
503
532
  </refsect1>
504
533