/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
<?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
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
 
5
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
 
6
<!ENTITY VERSION "1.0">
 
7
<!ENTITY COMMANDNAME "mandos-keygen">
 
8
]>
 
9
 
 
10
<refentry>
 
11
  <refentryinfo>
 
12
    <title>&COMMANDNAME;</title>
 
13
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
 
14
    <productname>&COMMANDNAME;</productname>
 
15
    <productnumber>&VERSION;</productnumber>
 
16
    <authorgroup>
 
17
      <author>
 
18
        <firstname>Björn</firstname>
 
19
        <surname>Påhlsson</surname>
 
20
        <address>
 
21
          <email>belorn@fukt.bsnet.se</email>
 
22
        </address>
 
23
      </author>
 
24
      <author>
 
25
        <firstname>Teddy</firstname>
 
26
        <surname>Hogeborn</surname>
 
27
        <address>
 
28
          <email>teddy@fukt.bsnet.se</email>
 
29
        </address>
 
30
      </author>
 
31
    </authorgroup>
 
32
    <copyright>
 
33
      <year>2008</year>
 
34
      <holder>Teddy Hogeborn &amp; Björn Påhlsson</holder>
 
35
    </copyright>
 
36
    <legalnotice>
 
37
      <para>
 
38
        This manual page is free software: you can redistribute it
 
39
        and/or modify it under the terms of the GNU General Public
 
40
        License as published by the Free Software Foundation,
 
41
        either version 3 of the License, or (at your option) any
 
42
        later version.
 
43
      </para>
 
44
 
 
45
      <para>
 
46
        This manual page is distributed in the hope that it will
 
47
        be useful, but WITHOUT ANY WARRANTY; without even the
 
48
        implied warranty of MERCHANTABILITY or FITNESS FOR A
 
49
        PARTICULAR PURPOSE.  See the GNU General Public License
 
50
        for more details.
 
51
      </para>
 
52
 
 
53
      <para>
 
54
        You should have received a copy of the GNU General Public
 
55
        License along with this program; If not, see
 
56
        <ulink url="http://www.gnu.org/licenses/"/>.
 
57
      </para>
 
58
    </legalnotice>
 
59
  </refentryinfo>
 
60
 
 
61
  <refmeta>
 
62
    <refentrytitle>&COMMANDNAME;</refentrytitle>
 
63
    <manvolnum>8</manvolnum>
 
64
  </refmeta>
 
65
  
 
66
  <refnamediv>
 
67
    <refname><command>&COMMANDNAME;</command></refname>
 
68
    <refpurpose>
 
69
      Generate keys for <citerefentry><refentrytitle>password-request
 
70
      </refentrytitle><manvolnum>8mandos</manvolnum></citerefentry>
 
71
    </refpurpose>
 
72
  </refnamediv>
 
73
 
 
74
  <refsynopsisdiv>
 
75
    <cmdsynopsis>
 
76
      <command>&COMMANDNAME;</command>
 
77
      <group choice="opt">
 
78
        <arg choice="plain"><option>--dir</option>
 
79
        <replaceable>directory</replaceable></arg>
 
80
      </group>
 
81
      <group choice="opt">
 
82
        <arg choice="plain"><option>--type</option>
 
83
        <replaceable>type</replaceable></arg>
 
84
      </group>
 
85
      <group choice="opt">
 
86
        <arg choice="plain"><option>--length</option>
 
87
        <replaceable>bits</replaceable></arg>
 
88
      </group>
 
89
      <group choice="opt">
 
90
        <arg choice="plain"><option>--name</option>
 
91
        <replaceable>NAME</replaceable></arg>
 
92
      </group>
 
93
      <group choice="opt">
 
94
        <arg choice="plain"><option>--email</option>
 
95
        <replaceable>EMAIL</replaceable></arg>
 
96
      </group>
 
97
      <group choice="opt">
 
98
        <arg choice="plain"><option>--comment</option>
 
99
        <replaceable>COMMENT</replaceable></arg>
 
100
      </group>
 
101
      <group choice="opt">
 
102
        <arg choice="plain"><option>--expire</option>
 
103
        <replaceable>TIME</replaceable></arg>
 
104
      </group>
 
105
      <group choice="opt">
 
106
        <arg choice="plain"><option>--force</option></arg>
 
107
      </group>
 
108
    </cmdsynopsis>
 
109
    <cmdsynopsis>
 
110
      <command>&COMMANDNAME;</command>
 
111
      <group choice="opt">
 
112
        <arg choice="plain"><option>-d</option>
 
113
        <replaceable>directory</replaceable></arg>
 
114
      </group>
 
115
      <group choice="opt">
 
116
        <arg choice="plain"><option>-t</option>
 
117
        <replaceable>type</replaceable></arg>
 
118
      </group>
 
119
      <group choice="opt">
 
120
        <arg choice="plain"><option>-l</option>
 
121
        <replaceable>bits</replaceable></arg>
 
122
      </group>
 
123
      <group choice="opt">
 
124
        <arg choice="plain"><option>-n</option>
 
125
        <replaceable>NAME</replaceable></arg>
 
126
      </group>
 
127
      <group choice="opt">
 
128
        <arg choice="plain"><option>-e</option>
 
129
        <replaceable>EMAIL</replaceable></arg>
 
130
      </group>
 
131
      <group choice="opt">
 
132
        <arg choice="plain"><option>-c</option>
 
133
        <replaceable>COMMENT</replaceable></arg>
 
134
      </group>
 
135
      <group choice="opt">
 
136
        <arg choice="plain"><option>-x</option>
 
137
        <replaceable>TIME</replaceable></arg>
 
138
      </group>
 
139
      <group choice="opt">
 
140
        <arg choice="plain"><option>-f</option></arg>
 
141
      </group>
 
142
    </cmdsynopsis>
 
143
    <cmdsynopsis>
 
144
      <command>&COMMANDNAME;</command>
 
145
      <group choice="req">
 
146
        <arg choice='plain'><option>-h</option></arg>
 
147
        <arg choice='plain'><option>--help</option></arg>
 
148
      </group>
 
149
    </cmdsynopsis>
 
150
    <cmdsynopsis>
 
151
      <command>&COMMANDNAME;</command>
 
152
      <group choice="req">
 
153
        <arg choice='plain'><option>-v</option></arg>
 
154
        <arg choice='plain'><option>--version</option></arg>
 
155
      </group>
 
156
    </cmdsynopsis>
 
157
  </refsynopsisdiv>
 
158
 
 
159
  <refsect1 id="description">
 
160
    <title>DESCRIPTION</title>
 
161
    <para>
 
162
      <command>&COMMANDNAME;</command> is a program to generate the
 
163
      OpenPGP keys used by
 
164
      <citerefentry><refentrytitle>password-request</refentrytitle>
 
165
      <manvolnum>8mandos</manvolnum></citerefentry>.  The keys are
 
166
      normally written to /etc/mandos for later installation into the
 
167
      initrd image, but this, like most things, can be changed with
 
168
      command line options.
 
169
    </para>
 
170
  </refsect1>
 
171
  
 
172
  <refsect1 id="options">
 
173
    <title>OPTIONS</title>
 
174
 
 
175
    <variablelist>
 
176
      <varlistentry>
 
177
        <term><literal>-h</literal>, <literal>--help</literal></term>
 
178
        <listitem>
 
179
          <para>
 
180
            Show a help message and exit
 
181
          </para>
 
182
        </listitem>
 
183
      </varlistentry>
 
184
 
 
185
      <varlistentry>
 
186
        <term><literal>-d</literal>, <literal>--dir
 
187
        <replaceable>directory</replaceable></literal></term>
 
188
        <listitem>
 
189
          <para>
 
190
            Target directory for key files.
 
191
          </para>
 
192
        </listitem>
 
193
      </varlistentry>
 
194
 
 
195
      <varlistentry>
 
196
        <term><literal>-t</literal>, <literal>--type
 
197
        <replaceable>type</replaceable></literal></term>
 
198
        <listitem>
 
199
          <para>
 
200
            Key type.  Default is DSA.
 
201
          </para>
 
202
        </listitem>
 
203
      </varlistentry>
 
204
 
 
205
      <varlistentry>
 
206
        <term><literal>-l</literal>, <literal>--length
 
207
        <replaceable>bits</replaceable></literal></term>
 
208
        <listitem>
 
209
          <para>
 
210
            Key length in bits.  Default is 1024.
 
211
          </para>
 
212
        </listitem>
 
213
      </varlistentry>
 
214
 
 
215
      <varlistentry>
 
216
        <term><literal>-e</literal>, <literal>--email</literal>
 
217
        <replaceable>address</replaceable></term>
 
218
        <listitem>
 
219
          <para>
 
220
            Email address of key.  Default is empty.
 
221
          </para>
 
222
        </listitem>
 
223
      </varlistentry>
 
224
 
 
225
      <varlistentry>
 
226
        <term><literal>-c</literal>, <literal>--comment</literal>
 
227
        <replaceable>comment</replaceable></term>
 
228
        <listitem>
 
229
          <para>
 
230
            Comment field for key.  The default value is
 
231
            "<literal>Mandos client key</literal>".
 
232
          </para>
 
233
        </listitem>
 
234
      </varlistentry>
 
235
 
 
236
      <varlistentry>
 
237
        <term><literal>-x</literal>, <literal>--expire</literal>
 
238
        <replaceable>time</replaceable></term>
 
239
        <listitem>
 
240
          <para>
 
241
            Key expire time.  Default is no expiration.  See
 
242
            <citerefentry><refentrytitle>gpg</refentrytitle>
 
243
            <manvolnum>1</manvolnum></citerefentry> for syntax.
 
244
          </para>
 
245
        </listitem>
 
246
      </varlistentry>
 
247
 
 
248
      <varlistentry>
 
249
        <term><literal>-f</literal>, <literal>--force</literal></term>
 
250
        <listitem>
 
251
          <para>
 
252
            Force overwriting old keys.
 
253
          </para>
 
254
        </listitem>
 
255
      </varlistentry>
 
256
    </variablelist>
 
257
  </refsect1>
 
258
 
 
259
  <refsect1 id="exit_status">
 
260
    <title>EXIT STATUS</title>
 
261
    <para>
 
262
    </para>
 
263
  </refsect1>
 
264
  
 
265
  <refsect1 id="file">
 
266
    <title>FILES</title>
 
267
    <para>
 
268
    </para>
 
269
  </refsect1>
 
270
 
 
271
  <refsect1 id="notes">
 
272
    <title>NOTES</title>
 
273
    <para>
 
274
    </para>
 
275
  </refsect1>
 
276
  
 
277
  <refsect1 id="bugs">
 
278
    <title>BUGS</title>
 
279
    <para>
 
280
    </para>
 
281
  </refsect1>
 
282
 
 
283
  <refsect1 id="examples">
 
284
    <title>EXAMPLES</title>
 
285
    <para>
 
286
    </para>
 
287
  </refsect1>
 
288
 
 
289
  <refsect1 id="security">
 
290
    <title>SECURITY</title>
 
291
    <para>
 
292
    </para>
 
293
  </refsect1>
 
294
 
 
295
  <refsect1 id="see_also">
 
296
    <title>SEE ALSO</title>
 
297
    <para>
 
298
      <citerefentry><refentrytitle>password-request</refentrytitle>
 
299
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
300
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
301
      <manvolnum>8</manvolnum></citerefentry>, and
 
302
      <citerefentry><refentrytitle>gpg</refentrytitle>
 
303
      <manvolnum>1</manvolnum></citerefentry>
 
304
    </para>
 
305
  </refsect1>
 
306
  
 
307
</refentry>