/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-29 07:14:39 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080829071439-feg1el14hx1abvqg
* mandos-keygen.xml (EXAMPLE): Replaced all occurrences of command
                               name with "&COMMANDNAME;".
* plugin-runner.xml (EXAMPLES): Renamed to "EXAMPLE".  - '' -

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 TIMESTAMP "2008-08-29">
6
7
]>
7
8
 
8
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
9
10
  <refentryinfo>
10
 
    <title>&COMMANDNAME;</title>
11
 
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
12
 
    <productname>&COMMANDNAME;</productname>
 
11
    <title>Mandos Manual</title>
 
12
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
 
13
    <productname>Mandos</productname>
13
14
    <productnumber>&VERSION;</productnumber>
 
15
    <date>&TIMESTAMP;</date>
14
16
    <authorgroup>
15
17
      <author>
16
18
        <firstname>Björn</firstname>
29
31
    </authorgroup>
30
32
    <copyright>
31
33
      <year>2008</year>
32
 
      <holder>Teddy Hogeborn &amp; Björn Påhlsson</holder>
 
34
      <holder>Teddy Hogeborn</holder>
 
35
      <holder>Björn Påhlsson</holder>
33
36
    </copyright>
34
37
    <legalnotice>
35
38
      <para>
85
88
        <replaceable>bits</replaceable></arg>
86
89
      </group>
87
90
      <group choice="opt">
 
91
        <arg choice="plain"><option>--subtype</option>
 
92
        <replaceable>type</replaceable></arg>
 
93
      </group>
 
94
      <group choice="opt">
 
95
        <arg choice="plain"><option>--sublength</option>
 
96
        <replaceable>bits</replaceable></arg>
 
97
      </group>
 
98
      <group choice="opt">
88
99
        <arg choice="plain"><option>--name</option>
89
100
        <replaceable>NAME</replaceable></arg>
90
101
      </group>
119
130
        <replaceable>bits</replaceable></arg>
120
131
      </group>
121
132
      <group choice="opt">
 
133
        <arg choice="plain"><option>-s</option>
 
134
        <replaceable>type</replaceable></arg>
 
135
      </group>
 
136
      <group choice="opt">
 
137
        <arg choice="plain"><option>-L</option>
 
138
        <replaceable>bits</replaceable></arg>
 
139
      </group>
 
140
      <group choice="opt">
122
141
        <arg choice="plain"><option>-n</option>
123
142
        <replaceable>NAME</replaceable></arg>
124
143
      </group>
141
160
    <cmdsynopsis>
142
161
      <command>&COMMANDNAME;</command>
143
162
      <group choice="req">
144
 
        <arg choice='plain'><option>-h</option></arg>
145
 
        <arg choice='plain'><option>--help</option></arg>
146
 
      </group>
147
 
    </cmdsynopsis>
148
 
    <cmdsynopsis>
149
 
      <command>&COMMANDNAME;</command>
150
 
      <group choice="req">
151
 
        <arg choice='plain'><option>-v</option></arg>
152
 
        <arg choice='plain'><option>--version</option></arg>
 
163
        <arg choice="plain"><option>-p</option></arg>
 
164
        <arg choice="plain"><option>--password</option></arg>
 
165
      </group>
 
166
      <group choice="opt">
 
167
        <arg choice="plain"><option>--dir</option>
 
168
        <replaceable>directory</replaceable></arg>
 
169
      </group>
 
170
      <group choice="opt">
 
171
        <arg choice="plain"><option>--name</option>
 
172
        <replaceable>NAME</replaceable></arg>
 
173
      </group>
 
174
    </cmdsynopsis>
 
175
    <cmdsynopsis>
 
176
      <command>&COMMANDNAME;</command>
 
177
      <group choice="req">
 
178
        <arg choice="plain"><option>-h</option></arg>
 
179
        <arg choice="plain"><option>--help</option></arg>
 
180
      </group>
 
181
    </cmdsynopsis>
 
182
    <cmdsynopsis>
 
183
      <command>&COMMANDNAME;</command>
 
184
      <group choice="req">
 
185
        <arg choice="plain"><option>-v</option></arg>
 
186
        <arg choice="plain"><option>--version</option></arg>
153
187
      </group>
154
188
    </cmdsynopsis>
155
189
  </refsynopsisdiv>
165
199
      initrd image, but this, like most things, can be changed with
166
200
      command line options.
167
201
    </para>
 
202
    <para>
 
203
      It can also be used to generate ready-made sections for
 
204
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
205
      <manvolnum>5</manvolnum></citerefentry> using the
 
206
      <option>--password</option> option.
 
207
    </para>
168
208
  </refsect1>
169
209
  
170
210
  <refsect1 id="purpose">
197
237
        <replaceable>directory</replaceable></literal></term>
198
238
        <listitem>
199
239
          <para>
200
 
            Target directory for key files.
 
240
            Target directory for key files.  Default is
 
241
            <filename>/etc/mandos</filename>.
201
242
          </para>
202
243
        </listitem>
203
244
      </varlistentry>
207
248
        <replaceable>type</replaceable></literal></term>
208
249
        <listitem>
209
250
          <para>
210
 
            Key type.  Default is DSA.
 
251
            Key type.  Default is <quote>DSA</quote>.
211
252
          </para>
212
253
        </listitem>
213
254
      </varlistentry>
217
258
        <replaceable>bits</replaceable></literal></term>
218
259
        <listitem>
219
260
          <para>
220
 
            Key length in bits.  Default is 1024.
 
261
            Key length in bits.  Default is 2048.
 
262
          </para>
 
263
        </listitem>
 
264
      </varlistentry>
 
265
 
 
266
      <varlistentry>
 
267
        <term><literal>-s</literal>, <literal>--subtype
 
268
        <replaceable>type</replaceable></literal></term>
 
269
        <listitem>
 
270
          <para>
 
271
            Subkey type.  Default is <quote>ELG-E</quote> (Elgamal
 
272
            encryption-only).
 
273
          </para>
 
274
        </listitem>
 
275
      </varlistentry>
 
276
 
 
277
      <varlistentry>
 
278
        <term><literal>-L</literal>, <literal>--sublength
 
279
        <replaceable>bits</replaceable></literal></term>
 
280
        <listitem>
 
281
          <para>
 
282
            Subkey length in bits.  Default is 2048.
221
283
          </para>
222
284
        </listitem>
223
285
      </varlistentry>
238
300
        <listitem>
239
301
          <para>
240
302
            Comment field for key.  The default value is
241
 
            "<literal>Mandos client key</literal>".
 
303
            <quote><literal>Mandos client key</literal></quote>.
242
304
          </para>
243
305
        </listitem>
244
306
      </varlistentry>
263
325
          </para>
264
326
        </listitem>
265
327
      </varlistentry>
 
328
      <varlistentry>
 
329
        <term><literal>-p</literal>, <literal>--password</literal
 
330
        ></term>
 
331
        <listitem>
 
332
          <para>
 
333
            Prompt for a password and encrypt it with the key already
 
334
            present in either <filename>/etc/mandos</filename> or the
 
335
            directory specified with the <option>--dir</option>
 
336
            option.  Outputs, on standard output, a section suitable
 
337
            for inclusion in <citerefentry><refentrytitle
 
338
            >mandos-clients.conf</refentrytitle><manvolnum
 
339
            >8</manvolnum></citerefentry>.  The host name or the name
 
340
            specified with the <option>--name</option> option is used
 
341
            for the section header.  All other options are ignored,
 
342
            and no keys are created.
 
343
          </para>
 
344
        </listitem>
 
345
      </varlistentry>
266
346
    </variablelist>
267
347
  </refsect1>
268
348
 
270
350
    <title>OVERVIEW</title>
271
351
    <xi:include href="overview.xml"/>
272
352
    <para>
273
 
      This program is a small program to generate new OpenPGP keys for
 
353
      This program is a small utility to generate new OpenPGP keys for
274
354
      new Mandos clients.
275
355
    </para>
276
356
  </refsect1>
351
431
        Normal invocation needs no options:
352
432
      </para>
353
433
      <para>
354
 
        <userinput>mandos-keygen</userinput>
 
434
        <userinput>&COMMANDNAME;</userinput>
355
435
      </para>
356
436
    </informalexample>
357
437
    <informalexample>
362
442
      <para>
363
443
 
364
444
<!-- do not wrap this line -->
365
 
<userinput>mandos-keygen --dir ~/keydir --type RSA --force</userinput>
 
445
<userinput>&COMMANDNAME; --dir ~/keydir --type RSA --force</userinput>
366
446
 
367
447
      </para>
368
448
    </informalexample>
371
451
  <refsect1 id="security">
372
452
    <title>SECURITY</title>
373
453
    <para>
374
 
      The <option>--type</option> and <option>--length</option>
 
454
      The <option>--type</option>, <option>--length</option>,
 
455
      <option>--subtype</option>, and <option>--sublength</option>
375
456
      options can be used to create keys of insufficient security.  If
376
457
      in doubt, leave them to the default values.
377
458
    </para>
388
469
      <citerefentry><refentrytitle>password-request</refentrytitle>
389
470
      <manvolnum>8mandos</manvolnum></citerefentry>,
390
471
      <citerefentry><refentrytitle>mandos</refentrytitle>
391
 
      <manvolnum>8</manvolnum></citerefentry>, and
 
472
      <manvolnum>8</manvolnum></citerefentry>,
392
473
      <citerefentry><refentrytitle>gpg</refentrytitle>
393
474
      <manvolnum>1</manvolnum></citerefentry>
394
475
    </para>
395
476
  </refsect1>
396
477
  
397
478
</refentry>
 
479
<!-- Local Variables: -->
 
480
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
481
<!-- time-stamp-end: "[\"']>" -->
 
482
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
483
<!-- End: -->