/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
	"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY VERSION "1.0">
<!ENTITY COMMANDNAME "mandos-keygen">
<!ENTITY OVERVIEW SYSTEM "overview.xml">
]>

<refentry>
  <refentryinfo>
    <title>&COMMANDNAME;</title>
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
    <productname>&COMMANDNAME;</productname>
    <productnumber>&VERSION;</productnumber>
    <authorgroup>
      <author>
	<firstname>Björn</firstname>
	<surname>Påhlsson</surname>
	<address>
	  <email>belorn@fukt.bsnet.se</email>
	</address>
      </author>
      <author>
	<firstname>Teddy</firstname>
	<surname>Hogeborn</surname>
	<address>
	  <email>teddy@fukt.bsnet.se</email>
	</address>
      </author>
    </authorgroup>
    <copyright>
      <year>2008</year>
      <holder>Teddy Hogeborn &amp; Björn Påhlsson</holder>
    </copyright>
    <legalnotice>
      <para>
	This manual page is free software: you can redistribute it
	and/or modify it under the terms of the GNU General Public
	License as published by the Free Software Foundation,
	either version 3 of the License, or (at your option) any
	later version.
      </para>

      <para>
	This manual page is distributed in the hope that it will
	be useful, but WITHOUT ANY WARRANTY; without even the
	implied warranty of MERCHANTABILITY or FITNESS FOR A
	PARTICULAR PURPOSE.  See the GNU General Public License
	for more details.
      </para>

      <para>
	You should have received a copy of the GNU General Public
	License along with this program; If not, see
	<ulink url="http://www.gnu.org/licenses/"/>.
      </para>
    </legalnotice>
  </refentryinfo>

  <refmeta>
    <refentrytitle>&COMMANDNAME;</refentrytitle>
    <manvolnum>8</manvolnum>
  </refmeta>
  
  <refnamediv>
    <refname><command>&COMMANDNAME;</command></refname>
    <refpurpose>
      Generate keys for <citerefentry><refentrytitle>password-request
      </refentrytitle><manvolnum>8mandos</manvolnum></citerefentry>
    </refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis>
      <command>&COMMANDNAME;</command>
      <group choice="opt">
	<arg choice="plain"><option>--dir</option>
	<replaceable>directory</replaceable></arg>
      </group>
      <group choice="opt">
	<arg choice="plain"><option>--type</option>
	<replaceable>type</replaceable></arg>
      </group>
      <group choice="opt">
	<arg choice="plain"><option>--length</option>
	<replaceable>bits</replaceable></arg>
      </group>
      <group choice="opt">
	<arg choice="plain"><option>--name</option>
	<replaceable>NAME</replaceable></arg>
      </group>
      <group choice="opt">
	<arg choice="plain"><option>--email</option>
	<replaceable>EMAIL</replaceable></arg>
      </group>
      <group choice="opt">
	<arg choice="plain"><option>--comment</option>
	<replaceable>COMMENT</replaceable></arg>
      </group>
      <group choice="opt">
	<arg choice="plain"><option>--expire</option>
	<replaceable>TIME</replaceable></arg>
      </group>
      <group choice="opt">
	<arg choice="plain"><option>--force</option></arg>
      </group>
    </cmdsynopsis>
    <cmdsynopsis>
      <command>&COMMANDNAME;</command>
      <group choice="opt">
	<arg choice="plain"><option>-d</option>
	<replaceable>directory</replaceable></arg>
      </group>
      <group choice="opt">
	<arg choice="plain"><option>-t</option>
	<replaceable>type</replaceable></arg>
      </group>
      <group choice="opt">
	<arg choice="plain"><option>-l</option>
	<replaceable>bits</replaceable></arg>
      </group>
      <group choice="opt">
	<arg choice="plain"><option>-n</option>
	<replaceable>NAME</replaceable></arg>
      </group>
      <group choice="opt">
	<arg choice="plain"><option>-e</option>
	<replaceable>EMAIL</replaceable></arg>
      </group>
      <group choice="opt">
	<arg choice="plain"><option>-c</option>
	<replaceable>COMMENT</replaceable></arg>
      </group>
      <group choice="opt">
	<arg choice="plain"><option>-x</option>
	<replaceable>TIME</replaceable></arg>
      </group>
      <group choice="opt">
	<arg choice="plain"><option>-f</option></arg>
      </group>
    </cmdsynopsis>
    <cmdsynopsis>
      <command>&COMMANDNAME;</command>
      <group choice="req">
	<arg choice='plain'><option>-h</option></arg>
	<arg choice='plain'><option>--help</option></arg>
      </group>
    </cmdsynopsis>
    <cmdsynopsis>
      <command>&COMMANDNAME;</command>
      <group choice="req">
	<arg choice='plain'><option>-v</option></arg>
	<arg choice='plain'><option>--version</option></arg>
      </group>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1 id="description">
    <title>DESCRIPTION</title>
    <para>
      <command>&COMMANDNAME;</command> is a program to generate the
      OpenPGP keys used by
      <citerefentry><refentrytitle>password-request</refentrytitle>
      <manvolnum>8mandos</manvolnum></citerefentry>.  The keys are
      normally written to /etc/mandos for later installation into the
      initrd image, but this, like most things, can be changed with
      command line options.
    </para>
  </refsect1>
  
  <refsect1 id="purpose">
    <title>PURPOSE</title>

    <para>
      The purpose of this is to enable <emphasis>remote and unattended
      rebooting</emphasis> of client host computer with an
      <emphasis>encrypted root file system</emphasis>.  See <xref
      linkend="overview"/> for details.
    </para>

  </refsect1>
  
  <refsect1 id="options">
    <title>OPTIONS</title>

    <variablelist>
      <varlistentry>
	<term><literal>-h</literal>, <literal>--help</literal></term>
	<listitem>
	  <para>
	    Show a help message and exit
	  </para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term><literal>-d</literal>, <literal>--dir
	<replaceable>directory</replaceable></literal></term>
	<listitem>
	  <para>
	    Target directory for key files.
	  </para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term><literal>-t</literal>, <literal>--type
	<replaceable>type</replaceable></literal></term>
	<listitem>
	  <para>
	    Key type.  Default is DSA.
	  </para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term><literal>-l</literal>, <literal>--length
	<replaceable>bits</replaceable></literal></term>
	<listitem>
	  <para>
	    Key length in bits.  Default is 1024.
	  </para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term><literal>-e</literal>, <literal>--email</literal>
	<replaceable>address</replaceable></term>
	<listitem>
	  <para>
	    Email address of key.  Default is empty.
	  </para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term><literal>-c</literal>, <literal>--comment</literal>
	<replaceable>comment</replaceable></term>
	<listitem>
	  <para>
	    Comment field for key.  The default value is
	    "<literal>Mandos client key</literal>".
	  </para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term><literal>-x</literal>, <literal>--expire</literal>
	<replaceable>time</replaceable></term>
	<listitem>
	  <para>
	    Key expire time.  Default is no expiration.  See
	    <citerefentry><refentrytitle>gpg</refentrytitle>
	    <manvolnum>1</manvolnum></citerefentry> for syntax.
	  </para>
	</listitem>
      </varlistentry>

      <varlistentry>
	<term><literal>-f</literal>, <literal>--force</literal></term>
	<listitem>
	  <para>
	    Force overwriting old keys.
	  </para>
	</listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

  <refsect1 id="overview">
    <title>OVERVIEW</title>
    &OVERVIEW;
    <para>
      This program is a small program to generate new OpenPGP keys for
      new Mandos clients.
    </para>
  </refsect1>

  <refsect1 id="exit_status">
    <title>EXIT STATUS</title>
    <para>
    </para>
  </refsect1>
  
  <refsect1 id="file">
    <title>FILES</title>
    <para>
    </para>
  </refsect1>

  <refsect1 id="bugs">
    <title>BUGS</title>
    <para>
    </para>
  </refsect1>

  <refsect1 id="example">
    <title>EXAMPLE</title>
    <para>
    </para>
  </refsect1>

  <refsect1 id="security">
    <title>SECURITY</title>
    <para>
    </para>
  </refsect1>

  <refsect1 id="see_also">
    <title>SEE ALSO</title>
    <para>
      <citerefentry><refentrytitle>password-request</refentrytitle>
      <manvolnum>8mandos</manvolnum></citerefentry>,
      <citerefentry><refentrytitle>mandos</refentrytitle>
      <manvolnum>8</manvolnum></citerefentry>, and
      <citerefentry><refentrytitle>gpg</refentrytitle>
      <manvolnum>1</manvolnum></citerefentry>
    </para>
  </refsect1>
  
</refentry>