/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-18 03:25:01 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080818032501-2cl874fi3uvsqn1b
* mandos.xml (SYNOPSIS): Removed unnecessary 'choice="opt"' from <arg>
                         tags.  Also show the "-h" option.
  (OPTIONS): Note that failure to obey the "--interface" option is not
             considered critical.
  (ENVIRONMENT): New section to document the use of PATH by /bin/sh.
  (FILES): Added "/bin/sh".
  (BUGS): Add five bugs from the TODO file.
  (EXAMPLES): Renamed to "EXAMPLE", as per man-pages(7).
  (SERVER, CLIENTS): Added "id" attribute.
  (CLIENT): Document the security implications of one of the five
            bugs added to the BUGS section.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-keygen.xml
1
1
<?xml version='1.0' encoding='UTF-8'?>
 
2
<?xml-stylesheet type="text/xsl"
 
3
        href="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"?>
2
4
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
5
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
6
<!ENTITY VERSION "1.0">
5
7
<!ENTITY COMMANDNAME "mandos-keygen">
6
8
]>
7
9
 
8
 
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
 
10
<refentry>
9
11
  <refentryinfo>
10
12
    <title>&COMMANDNAME;</title>
11
13
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
167
169
    </para>
168
170
  </refsect1>
169
171
  
170
 
  <refsect1 id="purpose">
171
 
    <title>PURPOSE</title>
172
 
 
173
 
    <para>
174
 
      The purpose of this is to enable <emphasis>remote and unattended
175
 
      rebooting</emphasis> of client host computer with an
176
 
      <emphasis>encrypted root file system</emphasis>.  See <xref
177
 
      linkend="overview"/> for details.
178
 
    </para>
179
 
 
180
 
  </refsect1>
181
 
  
182
172
  <refsect1 id="options">
183
173
    <title>OPTIONS</title>
184
174
 
266
256
    </variablelist>
267
257
  </refsect1>
268
258
 
269
 
  <refsect1 id="overview">
270
 
    <title>OVERVIEW</title>
271
 
    <xi:include href="overview.xml"/>
272
 
    <para>
273
 
      This program is a small program to generate new OpenPGP keys for
274
 
      new Mandos clients.
275
 
    </para>
276
 
  </refsect1>
277
 
 
278
259
  <refsect1 id="exit_status">
279
260
    <title>EXIT STATUS</title>
280
261
    <para>
281
 
      The exit status will be 0 if new keys were successfully created,
282
 
      otherwise not.
283
262
    </para>
284
263
  </refsect1>
285
264
  
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
 
  
302
265
  <refsect1 id="file">
303
266
    <title>FILES</title>
304
267
    <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.
308
268
    </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>
338
269
  </refsect1>
339
270
 
340
271
  <refsect1 id="bugs">
341
272
    <title>BUGS</title>
342
273
    <para>
343
 
      None are known at this time.
344
274
    </para>
345
275
  </refsect1>
346
276
 
347
 
  <refsect1 id="example">
348
 
    <title>EXAMPLE</title>
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>
 
277
  <refsect1 id="examples">
 
278
    <title>EXAMPLES</title>
 
279
    <para>
 
280
    </para>
369
281
  </refsect1>
370
282
 
371
283
  <refsect1 id="security">
372
284
    <title>SECURITY</title>
373
285
    <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>.
382
286
    </para>
383
287
  </refsect1>
384
288
 
388
292
      <citerefentry><refentrytitle>password-request</refentrytitle>
389
293
      <manvolnum>8mandos</manvolnum></citerefentry>,
390
294
      <citerefentry><refentrytitle>mandos</refentrytitle>
391
 
      <manvolnum>8</manvolnum></citerefentry>,
 
295
      <manvolnum>8</manvolnum></citerefentry>, and
392
296
      <citerefentry><refentrytitle>gpg</refentrytitle>
393
297
      <manvolnum>1</manvolnum></citerefentry>
394
298
    </para>