/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: 2017-08-20 13:50:57 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 360.
  • Revision ID: teddy@recompile.se-20170820135057-u069yh7hhk2ha1a2
Don't import doctest module in mandos-ctl unless running tests.

* mandos-ctl: Don't import doctest module unless running tests.

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 "2012-01-01">
 
5
<!ENTITY TIMESTAMP "2017-02-23">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
33
33
    <copyright>
34
34
      <year>2008</year>
35
35
      <year>2009</year>
 
36
      <year>2010</year>
36
37
      <year>2011</year>
37
38
      <year>2012</year>
 
39
      <year>2013</year>
 
40
      <year>2014</year>
 
41
      <year>2015</year>
 
42
      <year>2016</year>
 
43
      <year>2017</year>
38
44
      <holder>Teddy Hogeborn</holder>
39
45
      <holder>Björn Påhlsson</holder>
40
46
    </copyright>
119
125
        <replaceable>TIME</replaceable></option></arg>
120
126
      </group>
121
127
      <sbr/>
122
 
      <arg><option>--force</option></arg>
 
128
      <group>
 
129
        <arg choice="plain"><option>--force</option></arg>
 
130
        <arg choice="plain"><option>-f</option></arg>
 
131
      </group>
123
132
    </cmdsynopsis>
124
133
    <cmdsynopsis>
125
134
      <command>&COMMANDNAME;</command>
145
154
        <arg choice="plain"><option>-n
146
155
        <replaceable>NAME</replaceable></option></arg>
147
156
      </group>
 
157
      <group>
 
158
        <arg choice="plain"><option>--no-ssh</option></arg>
 
159
        <arg choice="plain"><option>-S</option></arg>
 
160
      </group>
148
161
    </cmdsynopsis>
149
162
    <cmdsynopsis>
150
163
      <command>&COMMANDNAME;</command>
227
240
        <replaceable>TYPE</replaceable></option></term>
228
241
        <listitem>
229
242
          <para>
230
 
            Key type.  Default is <quote>DSA</quote>.
 
243
            Key type.  Default is <quote>RSA</quote>.
231
244
          </para>
232
245
        </listitem>
233
246
      </varlistentry>
239
252
        <replaceable>BITS</replaceable></option></term>
240
253
        <listitem>
241
254
          <para>
242
 
            Key length in bits.  Default is 2048.
 
255
            Key length in bits.  Default is 4096.
243
256
          </para>
244
257
        </listitem>
245
258
      </varlistentry>
251
264
        <replaceable>KEYTYPE</replaceable></option></term>
252
265
        <listitem>
253
266
          <para>
254
 
            Subkey type.  Default is <quote>ELG-E</quote> (Elgamal
 
267
            Subkey type.  Default is <quote>RSA</quote> (Elgamal
255
268
            encryption-only).
256
269
          </para>
257
270
        </listitem>
264
277
        <replaceable>BITS</replaceable></option></term>
265
278
        <listitem>
266
279
          <para>
267
 
            Subkey length in bits.  Default is 2048.
 
280
            Subkey length in bits.  Default is 4096.
268
281
          </para>
269
282
        </listitem>
270
283
      </varlistentry>
288
301
        <replaceable>TEXT</replaceable></option></term>
289
302
        <listitem>
290
303
          <para>
291
 
            Comment field for key.  The default value is
292
 
            <quote><literal>Mandos client key</literal></quote>.
 
304
            Comment field for key.  Default is empty.
293
305
          </para>
294
306
        </listitem>
295
307
      </varlistentry>
347
359
          </para>
348
360
        </listitem>
349
361
      </varlistentry>
 
362
      <varlistentry>
 
363
        <term><option>--no-ssh</option></term>
 
364
        <term><option>-S</option></term>
 
365
        <listitem>
 
366
          <para>
 
367
            When <option>--password</option> or
 
368
            <option>--passfile</option> is given, this option will
 
369
            prevent <command>&COMMANDNAME;</command> from calling
 
370
            <command>ssh-keyscan</command> to get an SSH fingerprint
 
371
            for this host and, if successful, output suitable config
 
372
            options to use this fingerprint as a
 
373
            <option>checker</option> option in the output.  This is
 
374
            otherwise the default behavior.
 
375
          </para>
 
376
        </listitem>
 
377
      </varlistentry>
350
378
    </variablelist>
351
379
  </refsect1>
352
380
  
423
451
    </variablelist>
424
452
  </refsect1>
425
453
  
426
 
<!--   <refsect1 id="bugs"> -->
427
 
<!--     <title>BUGS</title> -->
428
 
<!--     <para> -->
429
 
<!--     </para> -->
430
 
<!--   </refsect1> -->
 
454
  <refsect1 id="bugs">
 
455
    <title>BUGS</title>
 
456
    <xi:include href="bugs.xml"/>
 
457
  </refsect1>
431
458
  
432
459
  <refsect1 id="example">
433
460
    <title>EXAMPLE</title>
503
530
      <citerefentry><refentrytitle>mandos</refentrytitle>
504
531
      <manvolnum>8</manvolnum></citerefentry>,
505
532
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
506
 
      <manvolnum>8mandos</manvolnum></citerefentry>
 
533
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
534
      <citerefentry><refentrytitle>ssh-keyscan</refentrytitle>
 
535
      <manvolnum>1</manvolnum></citerefentry>
507
536
    </para>
508
537
  </refsect1>
509
538