/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-23 07:17:28 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080823071728-wo1k2mtbje5910np
* Makefile (MANPOST): Bug fix: corrected patterns.

* mandos-options.xml: Bug fix: also change root node tag name in
                      DOCTYPE declaration.
  (interface, address): Improved wording.

* overview.xml: Changed "host computer" to "computer".

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-keygen.xml
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
11
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
269
268
 
270
269
  <refsect1 id="overview">
271
270
    <title>OVERVIEW</title>
272
 
    &OVERVIEW;
 
271
    <xi:include href="overview.xml"/>
273
272
    <para>
274
273
      This program is a small program to generate new OpenPGP keys for
275
274
      new Mandos clients.
279
278
  <refsect1 id="exit_status">
280
279
    <title>EXIT STATUS</title>
281
280
    <para>
 
281
      The exit status will be 0 if new keys were successfully created,
 
282
      otherwise not.
282
283
    </para>
283
284
  </refsect1>
284
285
  
 
286
  <refsect1 id="environment">
 
287
    <title>ENVIRONMENT</title>
 
288
    <variablelist>
 
289
      <varlistentry>
 
290
        <term><varname>TMPDIR</varname></term>
 
291
        <listitem>
 
292
          <para>
 
293
            If set, temporary files will be created here. See
 
294
            <citerefentry><refentrytitle>mktemp</refentrytitle>
 
295
            <manvolnum>1</manvolnum></citerefentry>.
 
296
          </para>
 
297
        </listitem>
 
298
      </varlistentry>
 
299
    </variablelist>
 
300
  </refsect1>
 
301
  
285
302
  <refsect1 id="file">
286
303
    <title>FILES</title>
287
304
    <para>
 
305
      Use the <option>--dir</option> option to change where
 
306
      <command>&COMMANDNAME;</command> will write the key files.  The
 
307
      default file names are shown here.
288
308
    </para>
 
309
    <variablelist>
 
310
      <varlistentry>
 
311
        <term><filename>/etc/mandos/seckey.txt</filename></term>
 
312
        <listitem>
 
313
          <para>
 
314
            OpenPGP secret key file which will be created or
 
315
            overwritten.
 
316
          </para>
 
317
        </listitem>
 
318
      </varlistentry>
 
319
      <varlistentry>
 
320
        <term><filename>/etc/mandos/pubkey.txt</filename></term>
 
321
        <listitem>
 
322
          <para>
 
323
            OpenPGP public key file which will be created or
 
324
            overwritten.
 
325
          </para>
 
326
        </listitem>
 
327
      </varlistentry>
 
328
      <varlistentry>
 
329
        <term><filename>/tmp</filename></term>
 
330
        <listitem>
 
331
          <para>
 
332
            Temporary files will be written here if
 
333
            <varname>TMPDIR</varname> is not set.
 
334
          </para>
 
335
        </listitem>
 
336
      </varlistentry>
 
337
    </variablelist>
289
338
  </refsect1>
290
339
 
291
340
  <refsect1 id="bugs">
292
341
    <title>BUGS</title>
293
342
    <para>
 
343
      None are known at this time.
294
344
    </para>
295
345
  </refsect1>
296
346
 
297
347
  <refsect1 id="example">
298
348
    <title>EXAMPLE</title>
299
 
    <para>
300
 
    </para>
 
349
    <informalexample>
 
350
      <para>
 
351
        Normal invocation needs no options:
 
352
      </para>
 
353
      <para>
 
354
        <userinput>mandos-keygen</userinput>
 
355
      </para>
 
356
    </informalexample>
 
357
    <informalexample>
 
358
      <para>
 
359
        Create keys in another directory and of another type.  Force
 
360
        overwriting old key files:
 
361
      </para>
 
362
      <para>
 
363
 
 
364
<!-- do not wrap this line -->
 
365
<userinput>mandos-keygen --dir ~/keydir --type RSA --force</userinput>
 
366
 
 
367
      </para>
 
368
    </informalexample>
301
369
  </refsect1>
302
370
 
303
371
  <refsect1 id="security">
304
372
    <title>SECURITY</title>
305
373
    <para>
 
374
      The <option>--type</option> and <option>--length</option>
 
375
      options can be used to create keys of insufficient security.  If
 
376
      in doubt, leave them to the default values.
 
377
    </para>
 
378
    <para>
 
379
      The key expire time is not guaranteed to be honored by
 
380
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
381
      <manvolnum>8</manvolnum></citerefentry>.
306
382
    </para>
307
383
  </refsect1>
308
384
 
312
388
      <citerefentry><refentrytitle>password-request</refentrytitle>
313
389
      <manvolnum>8mandos</manvolnum></citerefentry>,
314
390
      <citerefentry><refentrytitle>mandos</refentrytitle>
315
 
      <manvolnum>8</manvolnum></citerefentry>, and
 
391
      <manvolnum>8</manvolnum></citerefentry>,
316
392
      <citerefentry><refentrytitle>gpg</refentrytitle>
317
393
      <manvolnum>1</manvolnum></citerefentry>
318
394
    </para>