/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

* debian/mandos-client.README.Debian: Improved wording and formatting.
                                      Updated location of nfsroot.txt.
* debian/mandos.README.Debian: Improved wording and formatting.

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 "2014-06-22">
 
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>2011</year>
37
 
      <year>2012</year>
38
36
      <holder>Teddy Hogeborn</holder>
39
37
      <holder>Björn Påhlsson</holder>
40
38
    </copyright>
119
117
        <replaceable>TIME</replaceable></option></arg>
120
118
      </group>
121
119
      <sbr/>
122
 
      <group>
123
 
        <arg choice="plain"><option>--force</option></arg>
124
 
        <arg choice="plain"><option>-f</option></arg>
125
 
      </group>
 
120
      <arg><option>--force</option></arg>
126
121
    </cmdsynopsis>
127
122
    <cmdsynopsis>
128
123
      <command>&COMMANDNAME;</command>
148
143
        <arg choice="plain"><option>-n
149
144
        <replaceable>NAME</replaceable></option></arg>
150
145
      </group>
151
 
      <group>
152
 
        <arg choice="plain"><option>--no-ssh</option></arg>
153
 
        <arg choice="plain"><option>-S</option></arg>
154
 
      </group>
155
146
    </cmdsynopsis>
156
147
    <cmdsynopsis>
157
148
      <command>&COMMANDNAME;</command>
222
213
        <listitem>
223
214
          <para>
224
215
            Target directory for key files.  Default is
225
 
            <filename class="directory">/etc/mandos</filename>.
 
216
            <filename>/etc/mandos</filename>.
226
217
          </para>
227
218
        </listitem>
228
219
      </varlistentry>
234
225
        <replaceable>TYPE</replaceable></option></term>
235
226
        <listitem>
236
227
          <para>
237
 
            Key type.  Default is <quote>RSA</quote>.
 
228
            Key type.  Default is <quote>DSA</quote>.
238
229
          </para>
239
230
        </listitem>
240
231
      </varlistentry>
246
237
        <replaceable>BITS</replaceable></option></term>
247
238
        <listitem>
248
239
          <para>
249
 
            Key length in bits.  Default is 4096.
 
240
            Key length in bits.  Default is 2048.
250
241
          </para>
251
242
        </listitem>
252
243
      </varlistentry>
258
249
        <replaceable>KEYTYPE</replaceable></option></term>
259
250
        <listitem>
260
251
          <para>
261
 
            Subkey type.  Default is <quote>RSA</quote> (Elgamal
 
252
            Subkey type.  Default is <quote>ELG-E</quote> (Elgamal
262
253
            encryption-only).
263
254
          </para>
264
255
        </listitem>
271
262
        <replaceable>BITS</replaceable></option></term>
272
263
        <listitem>
273
264
          <para>
274
 
            Subkey length in bits.  Default is 4096.
 
265
            Subkey length in bits.  Default is 2048.
275
266
          </para>
276
267
        </listitem>
277
268
      </varlistentry>
295
286
        <replaceable>TEXT</replaceable></option></term>
296
287
        <listitem>
297
288
          <para>
298
 
            Comment field for key.  Default is empty.
 
289
            Comment field for key.  The default value is
 
290
            <quote><literal>Mandos client key</literal></quote>.
299
291
          </para>
300
292
        </listitem>
301
293
      </varlistentry>
353
345
          </para>
354
346
        </listitem>
355
347
      </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>
372
348
    </variablelist>
373
349
  </refsect1>
374
350
  
434
410
        </listitem>
435
411
      </varlistentry>
436
412
      <varlistentry>
437
 
        <term><filename class="directory">/tmp</filename></term>
 
413
        <term><filename>/tmp</filename></term>
438
414
        <listitem>
439
415
          <para>
440
416
            Temporary files will be written here if
475
451
    </informalexample>
476
452
    <informalexample>
477
453
      <para>
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>.
 
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>.
481
457
      </para>
482
458
      <para>
483
459
        <userinput>&COMMANDNAME; --password</userinput>
516
492
  <refsect1 id="see_also">
517
493
    <title>SEE ALSO</title>
518
494
    <para>
519
 
      <citerefentry><refentrytitle>intro</refentrytitle>
520
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
521
495
      <citerefentry><refentrytitle>gpg</refentrytitle>
522
496
      <manvolnum>1</manvolnum></citerefentry>,
523
497
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
525
499
      <citerefentry><refentrytitle>mandos</refentrytitle>
526
500
      <manvolnum>8</manvolnum></citerefentry>,
527
501
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
528
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
529
 
      <citerefentry><refentrytitle>ssh-keyscan</refentrytitle>
530
 
      <manvolnum>1</manvolnum></citerefentry>
 
502
      <manvolnum>8mandos</manvolnum></citerefentry>
531
503
    </para>
532
504
  </refsect1>
533
505