/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 at bsnet
  • Date: 2010-09-27 17:39:03 UTC
  • Revision ID: teddy@fukt.bsnet.se-20100927173903-9s5e6a3hl5iswmp7
* mandos: Fixed "--help" output.
* mandos.xml (SYNOPSIS, OPTIONS): Document new option "--debuglevel".

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 "2015-07-20">
 
5
<!ENTITY TIMESTAMP "2009-01-04">
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@recompile.se</email>
 
22
          <email>belorn@fukt.bsnet.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@recompile.se</email>
 
29
          <email>teddy@fukt.bsnet.se</email>
30
30
        </address>
31
31
      </author>
32
32
    </authorgroup>
33
33
    <copyright>
34
34
      <year>2008</year>
35
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
36
      <holder>Teddy Hogeborn</holder>
43
37
      <holder>Björn Påhlsson</holder>
44
38
    </copyright>
123
117
        <replaceable>TIME</replaceable></option></arg>
124
118
      </group>
125
119
      <sbr/>
126
 
      <group>
127
 
        <arg choice="plain"><option>--force</option></arg>
128
 
        <arg choice="plain"><option>-f</option></arg>
129
 
      </group>
 
120
      <arg><option>--force</option></arg>
130
121
    </cmdsynopsis>
131
122
    <cmdsynopsis>
132
123
      <command>&COMMANDNAME;</command>
152
143
        <arg choice="plain"><option>-n
153
144
        <replaceable>NAME</replaceable></option></arg>
154
145
      </group>
155
 
      <group>
156
 
        <arg choice="plain"><option>--no-ssh</option></arg>
157
 
        <arg choice="plain"><option>-S</option></arg>
158
 
      </group>
159
146
    </cmdsynopsis>
160
147
    <cmdsynopsis>
161
148
      <command>&COMMANDNAME;</command>
226
213
        <listitem>
227
214
          <para>
228
215
            Target directory for key files.  Default is
229
 
            <filename class="directory">/etc/mandos</filename>.
 
216
            <filename>/etc/mandos</filename>.
230
217
          </para>
231
218
        </listitem>
232
219
      </varlistentry>
238
225
        <replaceable>TYPE</replaceable></option></term>
239
226
        <listitem>
240
227
          <para>
241
 
            Key type.  Default is <quote>RSA</quote>.
 
228
            Key type.  Default is <quote>DSA</quote>.
242
229
          </para>
243
230
        </listitem>
244
231
      </varlistentry>
250
237
        <replaceable>BITS</replaceable></option></term>
251
238
        <listitem>
252
239
          <para>
253
 
            Key length in bits.  Default is 4096.
 
240
            Key length in bits.  Default is 2048.
254
241
          </para>
255
242
        </listitem>
256
243
      </varlistentry>
262
249
        <replaceable>KEYTYPE</replaceable></option></term>
263
250
        <listitem>
264
251
          <para>
265
 
            Subkey type.  Default is <quote>RSA</quote> (Elgamal
 
252
            Subkey type.  Default is <quote>ELG-E</quote> (Elgamal
266
253
            encryption-only).
267
254
          </para>
268
255
        </listitem>
275
262
        <replaceable>BITS</replaceable></option></term>
276
263
        <listitem>
277
264
          <para>
278
 
            Subkey length in bits.  Default is 4096.
 
265
            Subkey length in bits.  Default is 2048.
279
266
          </para>
280
267
        </listitem>
281
268
      </varlistentry>
299
286
        <replaceable>TEXT</replaceable></option></term>
300
287
        <listitem>
301
288
          <para>
302
 
            Comment field for key.  Default is empty.
 
289
            Comment field for key.  The default value is
 
290
            <quote><literal>Mandos client key</literal></quote>.
303
291
          </para>
304
292
        </listitem>
305
293
      </varlistentry>
357
345
          </para>
358
346
        </listitem>
359
347
      </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.
373
 
          </para>
374
 
        </listitem>
375
 
      </varlistentry>
376
348
    </variablelist>
377
349
  </refsect1>
378
350
  
438
410
        </listitem>
439
411
      </varlistentry>
440
412
      <varlistentry>
441
 
        <term><filename class="directory">/tmp</filename></term>
 
413
        <term><filename>/tmp</filename></term>
442
414
        <listitem>
443
415
          <para>
444
416
            Temporary files will be written here if
479
451
    </informalexample>
480
452
    <informalexample>
481
453
      <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>.
 
454
        Prompt for a password, encrypt it with the key in
 
455
        <filename>/etc/mandos</filename> and output a section suitable
 
456
        for <filename>clients.conf</filename>.
485
457
      </para>
486
458
      <para>
487
459
        <userinput>&COMMANDNAME; --password</userinput>
520
492
  <refsect1 id="see_also">
521
493
    <title>SEE ALSO</title>
522
494
    <para>
523
 
      <citerefentry><refentrytitle>intro</refentrytitle>
524
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
525
495
      <citerefentry><refentrytitle>gpg</refentrytitle>
526
496
      <manvolnum>1</manvolnum></citerefentry>,
527
497
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
529
499
      <citerefentry><refentrytitle>mandos</refentrytitle>
530
500
      <manvolnum>8</manvolnum></citerefentry>,
531
501
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
532
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
533
 
      <citerefentry><refentrytitle>ssh-keyscan</refentrytitle>
534
 
      <manvolnum>1</manvolnum></citerefentry>
 
502
      <manvolnum>8mandos</manvolnum></citerefentry>
535
503
    </para>
536
504
  </refsect1>
537
505