/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: 2008-08-18 23:55:28 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080818235528-dn628nlbrtzl7z4f
* Makefile: Bug fix: fixed creation of man pages for section 5 pages.

* mandos (main): Changed from requiring "[server]" in mandos.conf(5)
                 to requiring "[DEFAULT]".

* mandos.conf ([server]): Renamed to "[DEFAULT]".

* mandos.conf.xml: Removed <?xml-stylesheet>.  New entity "&OVERVIEW;"
                   referring to "overview.xml".
  (DESCRIPTION): Updated to specify the syntax more precisely.  Use
                 <varname> around the option names.

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