/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

merge

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-keygen.xml
1
 
<?xml version='1.0' encoding='UTF-8'?>
 
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
4
<!ENTITY VERSION "1.0">
5
5
<!ENTITY COMMANDNAME "mandos-keygen">
6
 
<!ENTITY OVERVIEW SYSTEM "overview.xml">
7
6
]>
8
7
 
9
 
<refentry>
 
8
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
10
9
  <refentryinfo>
11
10
    <title>&COMMANDNAME;</title>
12
 
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
 
11
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
13
12
    <productname>&COMMANDNAME;</productname>
14
13
    <productnumber>&VERSION;</productnumber>
15
14
    <authorgroup>
30
29
    </authorgroup>
31
30
    <copyright>
32
31
      <year>2008</year>
33
 
      <holder>Teddy Hogeborn &amp; Björn Påhlsson</holder>
 
32
      <holder>Teddy Hogeborn</holder>
 
33
      <holder>Björn Påhlsson</holder>
34
34
    </copyright>
35
35
    <legalnotice>
36
36
      <para>
86
86
        <replaceable>bits</replaceable></arg>
87
87
      </group>
88
88
      <group choice="opt">
 
89
        <arg choice="plain"><option>--subtype</option>
 
90
        <replaceable>type</replaceable></arg>
 
91
      </group>
 
92
      <group choice="opt">
 
93
        <arg choice="plain"><option>--sublength</option>
 
94
        <replaceable>bits</replaceable></arg>
 
95
      </group>
 
96
      <group choice="opt">
89
97
        <arg choice="plain"><option>--name</option>
90
98
        <replaceable>NAME</replaceable></arg>
91
99
      </group>
120
128
        <replaceable>bits</replaceable></arg>
121
129
      </group>
122
130
      <group choice="opt">
 
131
        <arg choice="plain"><option>-s</option>
 
132
        <replaceable>type</replaceable></arg>
 
133
      </group>
 
134
      <group choice="opt">
 
135
        <arg choice="plain"><option>-L</option>
 
136
        <replaceable>bits</replaceable></arg>
 
137
      </group>
 
138
      <group choice="opt">
123
139
        <arg choice="plain"><option>-n</option>
124
140
        <replaceable>NAME</replaceable></arg>
125
141
      </group>
142
158
    <cmdsynopsis>
143
159
      <command>&COMMANDNAME;</command>
144
160
      <group choice="req">
145
 
        <arg choice='plain'><option>-h</option></arg>
146
 
        <arg choice='plain'><option>--help</option></arg>
 
161
        <arg choice="plain"><option>-h</option></arg>
 
162
        <arg choice="plain"><option>--help</option></arg>
147
163
      </group>
148
164
    </cmdsynopsis>
149
165
    <cmdsynopsis>
150
166
      <command>&COMMANDNAME;</command>
151
167
      <group choice="req">
152
 
        <arg choice='plain'><option>-v</option></arg>
153
 
        <arg choice='plain'><option>--version</option></arg>
 
168
        <arg choice="plain"><option>-v</option></arg>
 
169
        <arg choice="plain"><option>--version</option></arg>
154
170
      </group>
155
171
    </cmdsynopsis>
156
172
  </refsynopsisdiv>
208
224
        <replaceable>type</replaceable></literal></term>
209
225
        <listitem>
210
226
          <para>
211
 
            Key type.  Default is DSA.
 
227
            Key type.  Default is <quote>DSA</quote>.
212
228
          </para>
213
229
        </listitem>
214
230
      </varlistentry>
224
240
      </varlistentry>
225
241
 
226
242
      <varlistentry>
 
243
        <term><literal>-s</literal>, <literal>--subtype
 
244
        <replaceable>type</replaceable></literal></term>
 
245
        <listitem>
 
246
          <para>
 
247
            Subkey type.  Default is <quote>ELG-E</quote> (Elgamal
 
248
            encryption-only).
 
249
          </para>
 
250
        </listitem>
 
251
      </varlistentry>
 
252
 
 
253
      <varlistentry>
 
254
        <term><literal>-L</literal>, <literal>--sublength
 
255
        <replaceable>bits</replaceable></literal></term>
 
256
        <listitem>
 
257
          <para>
 
258
            Subkey length in bits.  Default is 2048.
 
259
          </para>
 
260
        </listitem>
 
261
      </varlistentry>
 
262
 
 
263
      <varlistentry>
227
264
        <term><literal>-e</literal>, <literal>--email</literal>
228
265
        <replaceable>address</replaceable></term>
229
266
        <listitem>
239
276
        <listitem>
240
277
          <para>
241
278
            Comment field for key.  The default value is
242
 
            "<literal>Mandos client key</literal>".
 
279
            <quote><literal>Mandos client key</literal></quote>.
243
280
          </para>
244
281
        </listitem>
245
282
      </varlistentry>
269
306
 
270
307
  <refsect1 id="overview">
271
308
    <title>OVERVIEW</title>
272
 
    &OVERVIEW;
 
309
    <xi:include href="overview.xml"/>
273
310
    <para>
274
 
      This program is a small program to generate new OpenPGP keys for
 
311
      This program is a small utility to generate new OpenPGP keys for
275
312
      new Mandos clients.
276
313
    </para>
277
314
  </refsect1>
372
409
  <refsect1 id="security">
373
410
    <title>SECURITY</title>
374
411
    <para>
375
 
      The <option>--type</option> and <option>--length</option>
 
412
      The <option>--type</option>, <option>--length</option>,
 
413
      <option>--subtype</option>, and <option>--sublength</option>
376
414
      options can be used to create keys of insufficient security.  If
377
415
      in doubt, leave them to the default values.
378
416
    </para>
389
427
      <citerefentry><refentrytitle>password-request</refentrytitle>
390
428
      <manvolnum>8mandos</manvolnum></citerefentry>,
391
429
      <citerefentry><refentrytitle>mandos</refentrytitle>
392
 
      <manvolnum>8</manvolnum></citerefentry>, and
 
430
      <manvolnum>8</manvolnum></citerefentry>,
393
431
      <citerefentry><refentrytitle>gpg</refentrytitle>
394
432
      <manvolnum>1</manvolnum></citerefentry>
395
433
    </para>