/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

* mandos-ctl (main): Bug fix: Handle empty strings correctly.

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 "2016-03-05">
 
5
<!ENTITY TIMESTAMP "2011-10-03">
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>
37
36
      <year>2011</year>
38
 
      <year>2012</year>
39
 
      <year>2013</year>
40
 
      <year>2014</year>
41
 
      <year>2015</year>
42
 
      <year>2016</year>
43
37
      <holder>Teddy Hogeborn</holder>
44
38
      <holder>Björn Påhlsson</holder>
45
39
    </copyright>
124
118
        <replaceable>TIME</replaceable></option></arg>
125
119
      </group>
126
120
      <sbr/>
127
 
      <group>
128
 
        <arg choice="plain"><option>--force</option></arg>
129
 
        <arg choice="plain"><option>-f</option></arg>
130
 
      </group>
 
121
      <arg><option>--force</option></arg>
131
122
    </cmdsynopsis>
132
123
    <cmdsynopsis>
133
124
      <command>&COMMANDNAME;</command>
153
144
        <arg choice="plain"><option>-n
154
145
        <replaceable>NAME</replaceable></option></arg>
155
146
      </group>
156
 
      <group>
157
 
        <arg choice="plain"><option>--no-ssh</option></arg>
158
 
        <arg choice="plain"><option>-S</option></arg>
159
 
      </group>
160
147
    </cmdsynopsis>
161
148
    <cmdsynopsis>
162
149
      <command>&COMMANDNAME;</command>
227
214
        <listitem>
228
215
          <para>
229
216
            Target directory for key files.  Default is
230
 
            <filename class="directory">/etc/mandos</filename>.
 
217
            <filename>/etc/mandos</filename>.
231
218
          </para>
232
219
        </listitem>
233
220
      </varlistentry>
239
226
        <replaceable>TYPE</replaceable></option></term>
240
227
        <listitem>
241
228
          <para>
242
 
            Key type.  Default is <quote>RSA</quote>.
 
229
            Key type.  Default is <quote>DSA</quote>.
243
230
          </para>
244
231
        </listitem>
245
232
      </varlistentry>
251
238
        <replaceable>BITS</replaceable></option></term>
252
239
        <listitem>
253
240
          <para>
254
 
            Key length in bits.  Default is 4096.
 
241
            Key length in bits.  Default is 2048.
255
242
          </para>
256
243
        </listitem>
257
244
      </varlistentry>
263
250
        <replaceable>KEYTYPE</replaceable></option></term>
264
251
        <listitem>
265
252
          <para>
266
 
            Subkey type.  Default is <quote>RSA</quote> (Elgamal
 
253
            Subkey type.  Default is <quote>ELG-E</quote> (Elgamal
267
254
            encryption-only).
268
255
          </para>
269
256
        </listitem>
276
263
        <replaceable>BITS</replaceable></option></term>
277
264
        <listitem>
278
265
          <para>
279
 
            Subkey length in bits.  Default is 4096.
 
266
            Subkey length in bits.  Default is 2048.
280
267
          </para>
281
268
        </listitem>
282
269
      </varlistentry>
300
287
        <replaceable>TEXT</replaceable></option></term>
301
288
        <listitem>
302
289
          <para>
303
 
            Comment field for key.  Default is empty.
 
290
            Comment field for key.  The default value is
 
291
            <quote><literal>Mandos client key</literal></quote>.
304
292
          </para>
305
293
        </listitem>
306
294
      </varlistentry>
358
346
          </para>
359
347
        </listitem>
360
348
      </varlistentry>
361
 
      <varlistentry>
362
 
        <term><option>--no-ssh</option></term>
363
 
        <term><option>-S</option></term>
364
 
        <listitem>
365
 
          <para>
366
 
            When <option>--password</option> or
367
 
            <option>--passfile</option> is given, this option will
368
 
            prevent <command>&COMMANDNAME;</command> from calling
369
 
            <command>ssh-keyscan</command> to get an SSH fingerprint
370
 
            for this host and, if successful, output suitable config
371
 
            options to use this fingerprint as a
372
 
            <option>checker</option> option in the output.  This is
373
 
            otherwise the default behavior.
374
 
          </para>
375
 
        </listitem>
376
 
      </varlistentry>
377
349
    </variablelist>
378
350
  </refsect1>
379
351
  
439
411
        </listitem>
440
412
      </varlistentry>
441
413
      <varlistentry>
442
 
        <term><filename class="directory">/tmp</filename></term>
 
414
        <term><filename>/tmp</filename></term>
443
415
        <listitem>
444
416
          <para>
445
417
            Temporary files will be written here if
450
422
    </variablelist>
451
423
  </refsect1>
452
424
  
453
 
  <refsect1 id="bugs">
454
 
    <title>BUGS</title>
455
 
    <xi:include href="bugs.xml"/>
456
 
  </refsect1>
 
425
<!--   <refsect1 id="bugs"> -->
 
426
<!--     <title>BUGS</title> -->
 
427
<!--     <para> -->
 
428
<!--     </para> -->
 
429
<!--   </refsect1> -->
457
430
  
458
431
  <refsect1 id="example">
459
432
    <title>EXAMPLE</title>
479
452
    </informalexample>
480
453
    <informalexample>
481
454
      <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>.
 
455
        Prompt for a password, encrypt it with the key in
 
456
        <filename>/etc/mandos</filename> and output a section suitable
 
457
        for <filename>clients.conf</filename>.
485
458
      </para>
486
459
      <para>
487
460
        <userinput>&COMMANDNAME; --password</userinput>
529
502
      <citerefentry><refentrytitle>mandos</refentrytitle>
530
503
      <manvolnum>8</manvolnum></citerefentry>,
531
504
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
532
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
533
 
      <citerefentry><refentrytitle>ssh-keyscan</refentrytitle>
534
 
      <manvolnum>1</manvolnum></citerefentry>
 
505
      <manvolnum>8mandos</manvolnum></citerefentry>
535
506
    </para>
536
507
  </refsect1>
537
508