/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 Hogeborn
  • Date: 2014-03-01 10:59:22 UTC
  • Revision ID: teddy@recompile.se-20140301105922-xq8gjlvr22187si3
* debian/control (Standards-Version): Updated to "3.9.5".

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-keygen.xml
1
1
<?xml version="1.0" encoding="UTF-8"?>
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
 
<!ENTITY VERSION "1.0">
5
4
<!ENTITY COMMANDNAME "mandos-keygen">
6
 
<!ENTITY TIMESTAMP "2008-09-20">
 
5
<!ENTITY TIMESTAMP "2013-10-22">
 
6
<!ENTITY % common SYSTEM "common.ent">
 
7
%common;
7
8
]>
8
9
 
9
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
12
    <title>Mandos Manual</title>
12
13
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
13
14
    <productname>Mandos</productname>
14
 
    <productnumber>&VERSION;</productnumber>
 
15
    <productnumber>&version;</productnumber>
15
16
    <date>&TIMESTAMP;</date>
16
17
    <authorgroup>
17
18
      <author>
18
19
        <firstname>Björn</firstname>
19
20
        <surname>Påhlsson</surname>
20
21
        <address>
21
 
          <email>belorn@fukt.bsnet.se</email>
 
22
          <email>belorn@recompile.se</email>
22
23
        </address>
23
24
      </author>
24
25
      <author>
25
26
        <firstname>Teddy</firstname>
26
27
        <surname>Hogeborn</surname>
27
28
        <address>
28
 
          <email>teddy@fukt.bsnet.se</email>
 
29
          <email>teddy@recompile.se</email>
29
30
        </address>
30
31
      </author>
31
32
    </authorgroup>
32
33
    <copyright>
33
34
      <year>2008</year>
 
35
      <year>2009</year>
 
36
      <year>2011</year>
 
37
      <year>2012</year>
34
38
      <holder>Teddy Hogeborn</holder>
35
39
      <holder>Björn Påhlsson</holder>
36
40
    </copyright>
211
215
        <listitem>
212
216
          <para>
213
217
            Target directory for key files.  Default is
214
 
            <filename>/etc/mandos</filename>.
 
218
            <filename class="directory">/etc/mandos</filename>.
215
219
          </para>
216
220
        </listitem>
217
221
      </varlistentry>
223
227
        <replaceable>TYPE</replaceable></option></term>
224
228
        <listitem>
225
229
          <para>
226
 
            Key type.  Default is <quote>DSA</quote>.
 
230
            Key type.  Default is <quote>RSA</quote>.
227
231
          </para>
228
232
        </listitem>
229
233
      </varlistentry>
235
239
        <replaceable>BITS</replaceable></option></term>
236
240
        <listitem>
237
241
          <para>
238
 
            Key length in bits.  Default is 2048.
 
242
            Key length in bits.  Default is 4096.
239
243
          </para>
240
244
        </listitem>
241
245
      </varlistentry>
247
251
        <replaceable>KEYTYPE</replaceable></option></term>
248
252
        <listitem>
249
253
          <para>
250
 
            Subkey type.  Default is <quote>ELG-E</quote> (Elgamal
 
254
            Subkey type.  Default is <quote>RSA</quote> (Elgamal
251
255
            encryption-only).
252
256
          </para>
253
257
        </listitem>
260
264
        <replaceable>BITS</replaceable></option></term>
261
265
        <listitem>
262
266
          <para>
263
 
            Subkey length in bits.  Default is 2048.
 
267
            Subkey length in bits.  Default is 4096.
264
268
          </para>
265
269
        </listitem>
266
270
      </varlistentry>
284
288
        <replaceable>TEXT</replaceable></option></term>
285
289
        <listitem>
286
290
          <para>
287
 
            Comment field for key.  The default value is
288
 
            <quote><literal>Mandos client key</literal></quote>.
 
291
            Comment field for key.  Default is empty.
289
292
          </para>
290
293
        </listitem>
291
294
      </varlistentry>
381
384
    </variablelist>
382
385
  </refsect1>
383
386
  
384
 
  <refsect1 id="file">
 
387
  <refsect1 id="files">
385
388
    <title>FILES</title>
386
389
    <para>
387
390
      Use the <option>--dir</option> option to change where
408
411
        </listitem>
409
412
      </varlistentry>
410
413
      <varlistentry>
411
 
        <term><filename>/tmp</filename></term>
 
414
        <term><filename class="directory">/tmp</filename></term>
412
415
        <listitem>
413
416
          <para>
414
417
            Temporary files will be written here if
449
452
    </informalexample>
450
453
    <informalexample>
451
454
      <para>
452
 
        Prompt for a password, encrypt it with the key in
453
 
        <filename>/etc/mandos</filename> and output a section suitable
454
 
        for <filename>clients.conf</filename>.
 
455
        Prompt for a password, encrypt it with the key in <filename
 
456
        class="directory">/etc/mandos</filename> and output a section
 
457
        suitable for <filename>clients.conf</filename>.
455
458
      </para>
456
459
      <para>
457
460
        <userinput>&COMMANDNAME; --password</userinput>
490
493
  <refsect1 id="see_also">
491
494
    <title>SEE ALSO</title>
492
495
    <para>
 
496
      <citerefentry><refentrytitle>intro</refentrytitle>
 
497
      <manvolnum>8mandos</manvolnum></citerefentry>,
493
498
      <citerefentry><refentrytitle>gpg</refentrytitle>
494
499
      <manvolnum>1</manvolnum></citerefentry>,
495
500
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>