/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-19 23:44:17 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080819234417-8dz5prw19ihrklx6
* Makefile (DOCBOOKTOMAN): Include all DocBook-to-manpage-related
                           commands here, and use it everywhere.
  (mandos.8, mandos.conf.5): New; also depend on "mandos-options.xml".

* mandos-keygen.xml: Removed OVERVIEW entity.  Add XInclude namespace.
  (OVERVIEW): Changed to do <xi:include/>.

* mandos-options.xml (<simplesect>): Changed to a <section>.
  ([@id="address"]): Reordered sentences.

* mandos.conf.xml (OPTIONS): Removed illegal <arg> tags.
  (EXAMPLE): Added empty example.

* mandos.xml (NETWORK PROTOCOL): Bug fix: Changed "1\r\en" back to
                                 "1\r\n".
  (CHECKING): Do not refer to the non-relevant mandos.conf(5) manual.

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"?>
4
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
5
3
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
6
4
<!ENTITY VERSION "1.0">
7
5
<!ENTITY COMMANDNAME "mandos-keygen">
8
6
]>
9
7
 
10
 
<refentry>
 
8
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
9
  <refentryinfo>
12
10
    <title>&COMMANDNAME;</title>
13
11
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
169
167
    </para>
170
168
  </refsect1>
171
169
  
 
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
  
172
182
  <refsect1 id="options">
173
183
    <title>OPTIONS</title>
174
184
 
256
266
    </variablelist>
257
267
  </refsect1>
258
268
 
 
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
 
259
278
  <refsect1 id="exit_status">
260
279
    <title>EXIT STATUS</title>
261
280
    <para>
 
281
      The exit status will be 0 if new keys were successfully created,
 
282
      otherwise not.
262
283
    </para>
263
284
  </refsect1>
264
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
  
265
302
  <refsect1 id="file">
266
303
    <title>FILES</title>
267
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.
268
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>
269
338
  </refsect1>
270
339
 
271
340
  <refsect1 id="bugs">
272
341
    <title>BUGS</title>
273
342
    <para>
 
343
      None are known at this time.
274
344
    </para>
275
345
  </refsect1>
276
346
 
277
 
  <refsect1 id="examples">
278
 
    <title>EXAMPLES</title>
279
 
    <para>
280
 
    </para>
 
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>
281
369
  </refsect1>
282
370
 
283
371
  <refsect1 id="security">
284
372
    <title>SECURITY</title>
285
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>.
286
382
    </para>
287
383
  </refsect1>
288
384