/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-09-04 07:44:49 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080904074449-pk6vtwo9fp3lq62i
* README: Improved spelling.

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
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
3
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
 
4
<!ENTITY VERSION "1.0">
4
5
<!ENTITY COMMANDNAME "mandos-keygen">
5
 
<!ENTITY TIMESTAMP "2009-01-04">
6
 
<!ENTITY % common SYSTEM "common.ent">
7
 
%common;
 
6
<!ENTITY TIMESTAMP "2008-09-03">
8
7
]>
9
8
 
10
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
12
11
    <title>Mandos Manual</title>
13
12
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
14
13
    <productname>Mandos</productname>
15
 
    <productnumber>&version;</productnumber>
 
14
    <productnumber>&VERSION;</productnumber>
16
15
    <date>&TIMESTAMP;</date>
17
16
    <authorgroup>
18
17
      <author>
32
31
    </authorgroup>
33
32
    <copyright>
34
33
      <year>2008</year>
35
 
      <year>2009</year>
36
34
      <holder>Teddy Hogeborn</holder>
37
35
      <holder>Björn Påhlsson</holder>
38
36
    </copyright>
39
37
    <xi:include href="legalnotice.xml"/>
40
38
  </refentryinfo>
41
 
  
 
39
 
42
40
  <refmeta>
43
41
    <refentrytitle>&COMMANDNAME;</refentrytitle>
44
42
    <manvolnum>8</manvolnum>
50
48
      Generate key and password for Mandos client and server.
51
49
    </refpurpose>
52
50
  </refnamediv>
53
 
  
 
51
 
54
52
  <refsynopsisdiv>
55
53
    <cmdsynopsis>
56
54
      <command>&COMMANDNAME;</command>
124
122
      <group choice="req">
125
123
        <arg choice="plain"><option>--password</option></arg>
126
124
        <arg choice="plain"><option>-p</option></arg>
127
 
        <arg choice="plain"><option>--passfile
128
 
        <replaceable>FILE</replaceable></option></arg>
129
 
        <arg choice="plain"><option>-F</option>
130
 
        <replaceable>FILE</replaceable></arg>
131
125
      </group>
132
126
      <sbr/>
133
127
      <group>
165
159
    <para>
166
160
      <command>&COMMANDNAME;</command> is a program to generate the
167
161
      OpenPGP key used by
168
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
162
      <citerefentry><refentrytitle>password-request</refentrytitle>
169
163
      <manvolnum>8mandos</manvolnum></citerefentry>.  The key is
170
164
      normally written to /etc/mandos for later installation into the
171
165
      initrd image, but this, and most other things, can be changed
173
167
    </para>
174
168
    <para>
175
169
      This program can also be used with the
176
 
      <option>--password</option> or <option>--passfile</option>
177
 
      options to generate a ready-made section for
178
 
      <filename>clients.conf</filename> (see
 
170
      <option>--password</option> option to generate a ready-made
 
171
      section for <filename>clients.conf</filename> (see
179
172
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
180
173
      <manvolnum>5</manvolnum></citerefentry>).
181
174
    </para>
204
197
          </para>
205
198
        </listitem>
206
199
      </varlistentry>
207
 
      
 
200
 
208
201
      <varlistentry>
209
202
        <term><option>--dir
210
203
        <replaceable>DIRECTORY</replaceable></option></term>
217
210
          </para>
218
211
        </listitem>
219
212
      </varlistentry>
220
 
      
 
213
 
221
214
      <varlistentry>
222
215
        <term><option>--type
223
216
        <replaceable>TYPE</replaceable></option></term>
229
222
          </para>
230
223
        </listitem>
231
224
      </varlistentry>
232
 
      
 
225
 
233
226
      <varlistentry>
234
227
        <term><option>--length
235
228
        <replaceable>BITS</replaceable></option></term>
241
234
          </para>
242
235
        </listitem>
243
236
      </varlistentry>
244
 
      
 
237
 
245
238
      <varlistentry>
246
239
        <term><option>--subtype
247
240
        <replaceable>KEYTYPE</replaceable></option></term>
254
247
          </para>
255
248
        </listitem>
256
249
      </varlistentry>
257
 
      
 
250
 
258
251
      <varlistentry>
259
252
        <term><option>--sublength
260
253
        <replaceable>BITS</replaceable></option></term>
266
259
          </para>
267
260
        </listitem>
268
261
      </varlistentry>
269
 
      
 
262
 
270
263
      <varlistentry>
271
264
        <term><option>--email
272
265
        <replaceable>ADDRESS</replaceable></option></term>
278
271
          </para>
279
272
        </listitem>
280
273
      </varlistentry>
281
 
      
 
274
 
282
275
      <varlistentry>
283
276
        <term><option>--comment
284
277
        <replaceable>TEXT</replaceable></option></term>
291
284
          </para>
292
285
        </listitem>
293
286
      </varlistentry>
294
 
      
 
287
 
295
288
      <varlistentry>
296
289
        <term><option>--expire
297
290
        <replaceable>TIME</replaceable></option></term>
305
298
          </para>
306
299
        </listitem>
307
300
      </varlistentry>
308
 
      
 
301
 
309
302
      <varlistentry>
310
303
        <term><option>--force</option></term>
311
304
        <term><option>-f</option></term>
333
326
          </para>
334
327
        </listitem>
335
328
      </varlistentry>
336
 
      <varlistentry>
337
 
        <term><option>--passfile
338
 
        <replaceable>FILE</replaceable></option></term>
339
 
        <term><option>-F
340
 
        <replaceable>FILE</replaceable></option></term>
341
 
        <listitem>
342
 
          <para>
343
 
            The same as <option>--password</option>, but read from
344
 
            <replaceable>FILE</replaceable>, not the terminal.
345
 
          </para>
346
 
        </listitem>
347
 
      </varlistentry>
348
329
    </variablelist>
349
330
  </refsect1>
350
 
  
 
331
 
351
332
  <refsect1 id="overview">
352
333
    <title>OVERVIEW</title>
353
334
    <xi:include href="overview.xml"/>
357
338
      <filename>clients.conf</filename> on the server.
358
339
    </para>
359
340
  </refsect1>
360
 
  
 
341
 
361
342
  <refsect1 id="exit_status">
362
343
    <title>EXIT STATUS</title>
363
344
    <para>
383
364
    </variablelist>
384
365
  </refsect1>
385
366
  
386
 
  <refsect1 id="files">
 
367
  <refsect1 id="file">
387
368
    <title>FILES</title>
388
369
    <para>
389
370
      Use the <option>--dir</option> option to change where
420
401
      </varlistentry>
421
402
    </variablelist>
422
403
  </refsect1>
423
 
  
 
404
 
424
405
<!--   <refsect1 id="bugs"> -->
425
406
<!--     <title>BUGS</title> -->
426
407
<!--     <para> -->
427
408
<!--     </para> -->
428
409
<!--   </refsect1> -->
429
 
  
 
410
 
430
411
  <refsect1 id="example">
431
412
    <title>EXAMPLE</title>
432
413
    <informalexample>
473
454
      </para>
474
455
    </informalexample>
475
456
  </refsect1>
476
 
  
 
457
 
477
458
  <refsect1 id="security">
478
459
    <title>SECURITY</title>
479
460
    <para>
488
469
      <manvolnum>8</manvolnum></citerefentry>.
489
470
    </para>
490
471
  </refsect1>
491
 
  
 
472
 
492
473
  <refsect1 id="see_also">
493
474
    <title>SEE ALSO</title>
494
475
    <para>
498
479
      <manvolnum>5</manvolnum></citerefentry>,
499
480
      <citerefentry><refentrytitle>mandos</refentrytitle>
500
481
      <manvolnum>8</manvolnum></citerefentry>,
501
 
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
 
482
      <citerefentry><refentrytitle>password-request</refentrytitle>
502
483
      <manvolnum>8mandos</manvolnum></citerefentry>
503
484
    </para>
504
485
  </refsect1>