/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

merge

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">
 
6
<!ENTITY OVERVIEW SYSTEM "overview.xml">
8
7
]>
9
8
 
10
9
<refentry>
169
168
    </para>
170
169
  </refsect1>
171
170
  
 
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
  
172
183
  <refsect1 id="options">
173
184
    <title>OPTIONS</title>
174
185
 
256
267
    </variablelist>
257
268
  </refsect1>
258
269
 
 
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
 
259
279
  <refsect1 id="exit_status">
260
280
    <title>EXIT STATUS</title>
261
281
    <para>
 
282
      The exit status will be 0 if new keys were successfully created,
 
283
      otherwise not.
262
284
    </para>
263
285
  </refsect1>
264
286
  
 
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
  
265
303
  <refsect1 id="file">
266
304
    <title>FILES</title>
267
305
    <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.
268
309
    </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>
269
339
  </refsect1>
270
340
 
271
341
  <refsect1 id="bugs">
272
342
    <title>BUGS</title>
273
343
    <para>
 
344
      None are known at this time.
274
345
    </para>
275
346
  </refsect1>
276
347
 
277
 
  <refsect1 id="examples">
278
 
    <title>EXAMPLES</title>
279
 
    <para>
280
 
    </para>
 
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>
281
370
  </refsect1>
282
371
 
283
372
  <refsect1 id="security">
284
373
    <title>SECURITY</title>
285
374
    <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>.
286
383
    </para>
287
384
  </refsect1>
288
385