/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-22 00:16:20 UTC
  • mfrom: (24.1.57 mandos)
  • Revision ID: teddy@fukt.bsnet.se-20080822001620-vxpn1evy0t0kyvj0
* clients.conf ([DEFAULT]/checker): Update to new default value.

* mandos (Client.start_checker): Bug fix: OSError, not
                                 subprocess.OSError.
  (main): Use "fping -q -- %(host)s" instead of "fping -q --
          %%(host)s" as default value for "checker".  Always redirect
          stdin to be from /dev/null, even if in debug mode.

* mandos-clients.conf.xml (DESCRIPTION): Improved wording and refer to
                                         the EXPANSION section.
  (OPTIONS): Added synopsis and improved wording for "checker",
             "fingerprint", and "secret".  Refer to the RUNTIME
             EXPANSION section for the "checker" option.
  (EXAMPLE): Update to new default value for "checker".

* mandos-keygen (trap): Split lines and add "set +e".

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