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
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
12
10
<title>&COMMANDNAME;</title>
13
11
<!-- NWalsh's docbook scripts use this to generate the footer: -->
170
<refsect1 id="purpose">
171
<title>PURPOSE</title>
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.
172
182
<refsect1 id="options">
173
183
<title>OPTIONS</title>
269
<refsect1 id="overview">
270
<title>OVERVIEW</title>
271
<xi:include href="overview.xml"/>
273
This program is a small program to generate new OpenPGP keys for
259
278
<refsect1 id="exit_status">
260
279
<title>EXIT STATUS</title>
281
The exit status will be 0 if new keys were successfully created,
286
<refsect1 id="environment">
287
<title>ENVIRONMENT</title>
290
<term><varname>TMPDIR</varname></term>
293
If set, temporary files will be created here. See
294
<citerefentry><refentrytitle>mktemp</refentrytitle>
295
<manvolnum>1</manvolnum></citerefentry>.
265
302
<refsect1 id="file">
266
303
<title>FILES</title>
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.
311
<term><filename>/etc/mandos/seckey.txt</filename></term>
314
OpenPGP secret key file which will be created or
320
<term><filename>/etc/mandos/pubkey.txt</filename></term>
323
OpenPGP public key file which will be created or
329
<term><filename>/tmp</filename></term>
332
Temporary files will be written here if
333
<varname>TMPDIR</varname> is not set.
271
<refsect1 id="notes">
277
340
<refsect1 id="bugs">
278
341
<title>BUGS</title>
343
None are known at this time.
283
<refsect1 id="examples">
284
<title>EXAMPLES</title>
347
<refsect1 id="example">
348
<title>EXAMPLE</title>
351
Normal invocation needs no options:
354
<userinput>mandos-keygen</userinput>
359
Create keys in another directory and of another type. Force
360
overwriting old key files:
364
<!-- do not wrap this line -->
365
<userinput>mandos-keygen --dir ~/keydir --type RSA --force</userinput>
289
371
<refsect1 id="security">
290
372
<title>SECURITY</title>
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.
379
The key expire time is not guaranteed to be honored by
380
<citerefentry><refentrytitle>mandos</refentrytitle>
381
<manvolnum>8</manvolnum></citerefentry>.
298
388
<citerefentry><refentrytitle>password-request</refentrytitle>
299
389
<manvolnum>8mandos</manvolnum></citerefentry>,
300
390
<citerefentry><refentrytitle>mandos</refentrytitle>
301
<manvolnum>8</manvolnum></citerefentry>, and
391
<manvolnum>8</manvolnum></citerefentry>,
302
392
<citerefentry><refentrytitle>gpg</refentrytitle>
303
393
<manvolnum>1</manvolnum></citerefentry>