/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

* plugins.d/mandos-client.c: Merge unified printing system.

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 "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
37
      <holder>Teddy Hogeborn</holder>
43
38
      <holder>Björn Påhlsson</holder>
44
39
    </copyright>
123
118
        <replaceable>TIME</replaceable></option></arg>
124
119
      </group>
125
120
      <sbr/>
126
 
      <group>
127
 
        <arg choice="plain"><option>--force</option></arg>
128
 
        <arg choice="plain"><option>-f</option></arg>
129
 
      </group>
 
121
      <arg><option>--force</option></arg>
130
122
    </cmdsynopsis>
131
123
    <cmdsynopsis>
132
124
      <command>&COMMANDNAME;</command>
152
144
        <arg choice="plain"><option>-n
153
145
        <replaceable>NAME</replaceable></option></arg>
154
146
      </group>
155
 
      <group>
156
 
        <arg choice="plain"><option>--no-ssh</option></arg>
157
 
        <arg choice="plain"><option>-S</option></arg>
158
 
      </group>
159
147
    </cmdsynopsis>
160
148
    <cmdsynopsis>
161
149
      <command>&COMMANDNAME;</command>
226
214
        <listitem>
227
215
          <para>
228
216
            Target directory for key files.  Default is
229
 
            <filename class="directory">/etc/mandos</filename>.
 
217
            <filename>/etc/mandos</filename>.
230
218
          </para>
231
219
        </listitem>
232
220
      </varlistentry>
238
226
        <replaceable>TYPE</replaceable></option></term>
239
227
        <listitem>
240
228
          <para>
241
 
            Key type.  Default is <quote>RSA</quote>.
 
229
            Key type.  Default is <quote>DSA</quote>.
242
230
          </para>
243
231
        </listitem>
244
232
      </varlistentry>
250
238
        <replaceable>BITS</replaceable></option></term>
251
239
        <listitem>
252
240
          <para>
253
 
            Key length in bits.  Default is 4096.
 
241
            Key length in bits.  Default is 2048.
254
242
          </para>
255
243
        </listitem>
256
244
      </varlistentry>
262
250
        <replaceable>KEYTYPE</replaceable></option></term>
263
251
        <listitem>
264
252
          <para>
265
 
            Subkey type.  Default is <quote>RSA</quote> (Elgamal
 
253
            Subkey type.  Default is <quote>ELG-E</quote> (Elgamal
266
254
            encryption-only).
267
255
          </para>
268
256
        </listitem>
275
263
        <replaceable>BITS</replaceable></option></term>
276
264
        <listitem>
277
265
          <para>
278
 
            Subkey length in bits.  Default is 4096.
 
266
            Subkey length in bits.  Default is 2048.
279
267
          </para>
280
268
        </listitem>
281
269
      </varlistentry>
299
287
        <replaceable>TEXT</replaceable></option></term>
300
288
        <listitem>
301
289
          <para>
302
 
            Comment field for key.  Default is empty.
 
290
            Comment field for key.  The default value is
 
291
            <quote><literal>Mandos client key</literal></quote>.
303
292
          </para>
304
293
        </listitem>
305
294
      </varlistentry>
357
346
          </para>
358
347
        </listitem>
359
348
      </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
349
    </variablelist>
377
350
  </refsect1>
378
351
  
438
411
        </listitem>
439
412
      </varlistentry>
440
413
      <varlistentry>
441
 
        <term><filename class="directory">/tmp</filename></term>
 
414
        <term><filename>/tmp</filename></term>
442
415
        <listitem>
443
416
          <para>
444
417
            Temporary files will be written here if
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