/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

  • Committer: Teddy Hogeborn
  • Date: 2008-08-29 07:09:04 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080829070904-i6u8xb0aueytvfii
* mandos-clients.conf.xml (/refentry/refentryinfo/title): Changed to
                                                          "Mandos
                                                          Manual".

  (/refentry/refentryinfo/productname): Changed to "Mandos".
* mandos-keygen.xml: - '' -
* mandos.conf.xml: - '' -
* mandos.xml: - '' -
* plugin-runner.xml: - '' -
* plugins.d/password-request.xml: - '' -

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
<!ENTITY TIMESTAMP "2008-08-29">
7
7
]>
8
8
 
9
 
<refentry>
 
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
10
10
  <refentryinfo>
11
 
    <title>&COMMANDNAME;</title>
12
 
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
13
 
    <productname>&COMMANDNAME;</productname>
 
11
    <title>Mandos Manual</title>
 
12
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
 
13
    <productname>Mandos</productname>
14
14
    <productnumber>&VERSION;</productnumber>
 
15
    <date>&TIMESTAMP;</date>
15
16
    <authorgroup>
16
17
      <author>
17
18
        <firstname>Björn</firstname>
30
31
    </authorgroup>
31
32
    <copyright>
32
33
      <year>2008</year>
33
 
      <holder>Teddy Hogeborn &amp; Björn Påhlsson</holder>
 
34
      <holder>Teddy Hogeborn</holder>
 
35
      <holder>Björn Påhlsson</holder>
34
36
    </copyright>
35
37
    <legalnotice>
36
38
      <para>
86
88
        <replaceable>bits</replaceable></arg>
87
89
      </group>
88
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">
89
99
        <arg choice="plain"><option>--name</option>
90
100
        <replaceable>NAME</replaceable></arg>
91
101
      </group>
120
130
        <replaceable>bits</replaceable></arg>
121
131
      </group>
122
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">
123
141
        <arg choice="plain"><option>-n</option>
124
142
        <replaceable>NAME</replaceable></arg>
125
143
      </group>
142
160
    <cmdsynopsis>
143
161
      <command>&COMMANDNAME;</command>
144
162
      <group choice="req">
145
 
        <arg choice='plain'><option>-h</option></arg>
146
 
        <arg choice='plain'><option>--help</option></arg>
147
 
      </group>
148
 
    </cmdsynopsis>
149
 
    <cmdsynopsis>
150
 
      <command>&COMMANDNAME;</command>
151
 
      <group choice="req">
152
 
        <arg choice='plain'><option>-v</option></arg>
153
 
        <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>
154
187
      </group>
155
188
    </cmdsynopsis>
156
189
  </refsynopsisdiv>
166
199
      initrd image, but this, like most things, can be changed with
167
200
      command line options.
168
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>
169
208
  </refsect1>
170
209
  
171
210
  <refsect1 id="purpose">
198
237
        <replaceable>directory</replaceable></literal></term>
199
238
        <listitem>
200
239
          <para>
201
 
            Target directory for key files.
 
240
            Target directory for key files.  Default is
 
241
            <filename>/etc/mandos</filename>.
202
242
          </para>
203
243
        </listitem>
204
244
      </varlistentry>
208
248
        <replaceable>type</replaceable></literal></term>
209
249
        <listitem>
210
250
          <para>
211
 
            Key type.  Default is DSA.
 
251
            Key type.  Default is <quote>DSA</quote>.
212
252
          </para>
213
253
        </listitem>
214
254
      </varlistentry>
218
258
        <replaceable>bits</replaceable></literal></term>
219
259
        <listitem>
220
260
          <para>
221
 
            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.
222
283
          </para>
223
284
        </listitem>
224
285
      </varlistentry>
239
300
        <listitem>
240
301
          <para>
241
302
            Comment field for key.  The default value is
242
 
            "<literal>Mandos client key</literal>".
 
303
            <quote><literal>Mandos client key</literal></quote>.
243
304
          </para>
244
305
        </listitem>
245
306
      </varlistentry>
264
325
          </para>
265
326
        </listitem>
266
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>
267
346
    </variablelist>
268
347
  </refsect1>
269
348
 
270
349
  <refsect1 id="overview">
271
350
    <title>OVERVIEW</title>
272
 
    &OVERVIEW;
 
351
    <xi:include href="overview.xml"/>
273
352
    <para>
274
 
      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
275
354
      new Mandos clients.
276
355
    </para>
277
356
  </refsect1>
372
451
  <refsect1 id="security">
373
452
    <title>SECURITY</title>
374
453
    <para>
375
 
      The <option>--type</option> and <option>--length</option>
 
454
      The <option>--type</option>, <option>--length</option>,
 
455
      <option>--subtype</option>, and <option>--sublength</option>
376
456
      options can be used to create keys of insufficient security.  If
377
457
      in doubt, leave them to the default values.
378
458
    </para>
389
469
      <citerefentry><refentrytitle>password-request</refentrytitle>
390
470
      <manvolnum>8mandos</manvolnum></citerefentry>,
391
471
      <citerefentry><refentrytitle>mandos</refentrytitle>
392
 
      <manvolnum>8</manvolnum></citerefentry>, and
 
472
      <manvolnum>8</manvolnum></citerefentry>,
393
473
      <citerefentry><refentrytitle>gpg</refentrytitle>
394
474
      <manvolnum>1</manvolnum></citerefentry>
395
475
    </para>
396
476
  </refsect1>
397
477
  
398
478
</refentry>
 
479
<!-- Local Variables: -->
 
480
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
481
<!-- time-stamp-end: "[\"']>" -->
 
482
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
483
<!-- End: -->