/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-16 20:32:58 UTC
  • mfrom: (24.1.55 mandos)
  • Revision ID: teddy@fukt.bsnet.se-20080816203258-eq4by31vdgxkhs9g
* mandos-keygen.xml: New man page for mandos-keygen(8).

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
 
<!ENTITY OVERVIEW SYSTEM "overview.xml">
7
8
]>
8
9
 
9
10
<refentry>
168
169
    </para>
169
170
  </refsect1>
170
171
  
171
 
  <refsect1 id="purpose">
172
 
    <title>PURPOSE</title>
173
 
 
174
 
    <para>
175
 
      The purpose of this is to enable <emphasis>remote and unattended
176
 
      rebooting</emphasis> of client host computer with an
177
 
      <emphasis>encrypted root file system</emphasis>.  See <xref
178
 
      linkend="overview"/> for details.
179
 
    </para>
180
 
 
181
 
  </refsect1>
182
 
  
183
172
  <refsect1 id="options">
184
173
    <title>OPTIONS</title>
185
174
 
267
256
    </variablelist>
268
257
  </refsect1>
269
258
 
270
 
  <refsect1 id="overview">
271
 
    <title>OVERVIEW</title>
272
 
    &OVERVIEW;
273
 
    <para>
274
 
      This program is a small program to generate new OpenPGP keys for
275
 
      new Mandos clients.
276
 
    </para>
277
 
  </refsect1>
278
 
 
279
259
  <refsect1 id="exit_status">
280
260
    <title>EXIT STATUS</title>
281
261
    <para>
282
 
      The exit status will be 0 if new keys were successfully created,
283
 
      otherwise not.
284
262
    </para>
285
263
  </refsect1>
286
264
  
287
 
  <refsect1 id="environment">
288
 
    <title>ENVIRONMENT</title>
289
 
    <variablelist>
290
 
      <varlistentry>
291
 
        <term><varname>TMPDIR</varname></term>
292
 
        <listitem>
293
 
          <para>
294
 
            If set, temporary files will be created here. See
295
 
            <citerefentry><refentrytitle>mktemp</refentrytitle>
296
 
            <manvolnum>1</manvolnum></citerefentry>.
297
 
          </para>
298
 
        </listitem>
299
 
      </varlistentry>
300
 
    </variablelist>
301
 
  </refsect1>
302
 
  
303
265
  <refsect1 id="file">
304
266
    <title>FILES</title>
305
267
    <para>
306
 
      Use the <option>--dir</option> option to change where
307
 
      <command>&COMMANDNAME;</command> will write the key files.  The
308
 
      default file names are shown here.
309
268
    </para>
310
 
    <variablelist>
311
 
      <varlistentry>
312
 
        <term><filename>/etc/mandos/seckey.txt</filename></term>
313
 
        <listitem>
314
 
          <para>
315
 
            OpenPGP secret key file which will be created or
316
 
            overwritten.
317
 
          </para>
318
 
        </listitem>
319
 
      </varlistentry>
320
 
      <varlistentry>
321
 
        <term><filename>/etc/mandos/pubkey.txt</filename></term>
322
 
        <listitem>
323
 
          <para>
324
 
            OpenPGP public key file which will be created or
325
 
            overwritten.
326
 
          </para>
327
 
        </listitem>
328
 
      </varlistentry>
329
 
      <varlistentry>
330
 
        <term><filename>/tmp</filename></term>
331
 
        <listitem>
332
 
          <para>
333
 
            Temporary files will be written here if
334
 
            <varname>TMPDIR</varname> is not set.
335
 
          </para>
336
 
        </listitem>
337
 
      </varlistentry>
338
 
    </variablelist>
339
269
  </refsect1>
340
270
 
 
271
  <refsect1 id="notes">
 
272
    <title>NOTES</title>
 
273
    <para>
 
274
    </para>
 
275
  </refsect1>
 
276
  
341
277
  <refsect1 id="bugs">
342
278
    <title>BUGS</title>
343
279
    <para>
344
 
      None are known at this time.
345
280
    </para>
346
281
  </refsect1>
347
282
 
348
 
  <refsect1 id="example">
349
 
    <title>EXAMPLE</title>
350
 
    <informalexample>
351
 
      <para>
352
 
        Normal invocation needs no options:
353
 
      </para>
354
 
      <para>
355
 
        <userinput>mandos-keygen</userinput>
356
 
      </para>
357
 
    </informalexample>
358
 
    <informalexample>
359
 
      <para>
360
 
        Create keys in another directory and of another type.  Force
361
 
        overwriting old key files:
362
 
      </para>
363
 
      <para>
364
 
 
365
 
<!-- do not wrap this line -->
366
 
<userinput>mandos-keygen --dir ~/keydir --type RSA --force</userinput>
367
 
 
368
 
      </para>
369
 
    </informalexample>
 
283
  <refsect1 id="examples">
 
284
    <title>EXAMPLES</title>
 
285
    <para>
 
286
    </para>
370
287
  </refsect1>
371
288
 
372
289
  <refsect1 id="security">
373
290
    <title>SECURITY</title>
374
291
    <para>
375
 
      The <option>--type</option> and <option>--length</option>
376
 
      options can be used to create keys of insufficient security.  If
377
 
      in doubt, leave them to the default values.
378
 
    </para>
379
 
    <para>
380
 
      The key expire time is not guaranteed to be honored by
381
 
      <citerefentry><refentrytitle>mandos</refentrytitle>
382
 
      <manvolnum>8</manvolnum></citerefentry>.
383
292
    </para>
384
293
  </refsect1>
385
294