/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-24 23:12:49 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080924231249-0xhjl5ydrbcjvce7
* debian/mandos-client.lintian-overrides: Ignore setuid
                                          "plugins.d/usplash".

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-keygen.xml
3
3
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
4
<!ENTITY VERSION "1.0">
5
5
<!ENTITY COMMANDNAME "mandos-keygen">
6
 
<!ENTITY TIMESTAMP "2008-09-03">
 
6
<!ENTITY TIMESTAMP "2008-09-20">
7
7
]>
8
8
 
9
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
36
36
    </copyright>
37
37
    <xi:include href="legalnotice.xml"/>
38
38
  </refentryinfo>
39
 
 
 
39
  
40
40
  <refmeta>
41
41
    <refentrytitle>&COMMANDNAME;</refentrytitle>
42
42
    <manvolnum>8</manvolnum>
48
48
      Generate key and password for Mandos client and server.
49
49
    </refpurpose>
50
50
  </refnamediv>
51
 
 
 
51
  
52
52
  <refsynopsisdiv>
53
53
    <cmdsynopsis>
54
54
      <command>&COMMANDNAME;</command>
122
122
      <group choice="req">
123
123
        <arg choice="plain"><option>--password</option></arg>
124
124
        <arg choice="plain"><option>-p</option></arg>
 
125
        <arg choice="plain"><option>--passfile
 
126
        <replaceable>FILE</replaceable></option></arg>
 
127
        <arg choice="plain"><option>-F</option>
 
128
        <replaceable>FILE</replaceable></arg>
125
129
      </group>
126
130
      <sbr/>
127
131
      <group>
159
163
    <para>
160
164
      <command>&COMMANDNAME;</command> is a program to generate the
161
165
      OpenPGP key used by
162
 
      <citerefentry><refentrytitle>password-request</refentrytitle>
 
166
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
163
167
      <manvolnum>8mandos</manvolnum></citerefentry>.  The key is
164
168
      normally written to /etc/mandos for later installation into the
165
169
      initrd image, but this, and most other things, can be changed
167
171
    </para>
168
172
    <para>
169
173
      This program can also be used with the
170
 
      <option>--password</option> option to generate a ready-made
171
 
      section for <filename>clients.conf</filename> (see
 
174
      <option>--password</option> or <option>--passfile</option>
 
175
      options to generate a ready-made section for
 
176
      <filename>clients.conf</filename> (see
172
177
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
173
178
      <manvolnum>5</manvolnum></citerefentry>).
174
179
    </para>
197
202
          </para>
198
203
        </listitem>
199
204
      </varlistentry>
200
 
 
 
205
      
201
206
      <varlistentry>
202
207
        <term><option>--dir
203
208
        <replaceable>DIRECTORY</replaceable></option></term>
210
215
          </para>
211
216
        </listitem>
212
217
      </varlistentry>
213
 
 
 
218
      
214
219
      <varlistentry>
215
220
        <term><option>--type
216
221
        <replaceable>TYPE</replaceable></option></term>
222
227
          </para>
223
228
        </listitem>
224
229
      </varlistentry>
225
 
 
 
230
      
226
231
      <varlistentry>
227
232
        <term><option>--length
228
233
        <replaceable>BITS</replaceable></option></term>
234
239
          </para>
235
240
        </listitem>
236
241
      </varlistentry>
237
 
 
 
242
      
238
243
      <varlistentry>
239
244
        <term><option>--subtype
240
245
        <replaceable>KEYTYPE</replaceable></option></term>
247
252
          </para>
248
253
        </listitem>
249
254
      </varlistentry>
250
 
 
 
255
      
251
256
      <varlistentry>
252
257
        <term><option>--sublength
253
258
        <replaceable>BITS</replaceable></option></term>
259
264
          </para>
260
265
        </listitem>
261
266
      </varlistentry>
262
 
 
 
267
      
263
268
      <varlistentry>
264
269
        <term><option>--email
265
270
        <replaceable>ADDRESS</replaceable></option></term>
271
276
          </para>
272
277
        </listitem>
273
278
      </varlistentry>
274
 
 
 
279
      
275
280
      <varlistentry>
276
281
        <term><option>--comment
277
282
        <replaceable>TEXT</replaceable></option></term>
284
289
          </para>
285
290
        </listitem>
286
291
      </varlistentry>
287
 
 
 
292
      
288
293
      <varlistentry>
289
294
        <term><option>--expire
290
295
        <replaceable>TIME</replaceable></option></term>
298
303
          </para>
299
304
        </listitem>
300
305
      </varlistentry>
301
 
 
 
306
      
302
307
      <varlistentry>
303
308
        <term><option>--force</option></term>
304
309
        <term><option>-f</option></term>
326
331
          </para>
327
332
        </listitem>
328
333
      </varlistentry>
 
334
      <varlistentry>
 
335
        <term><option>--passfile
 
336
        <replaceable>FILE</replaceable></option></term>
 
337
        <term><option>-F
 
338
        <replaceable>FILE</replaceable></option></term>
 
339
        <listitem>
 
340
          <para>
 
341
            The same as <option>--password</option>, but read from
 
342
            <replaceable>FILE</replaceable>, not the terminal.
 
343
          </para>
 
344
        </listitem>
 
345
      </varlistentry>
329
346
    </variablelist>
330
347
  </refsect1>
331
 
 
 
348
  
332
349
  <refsect1 id="overview">
333
350
    <title>OVERVIEW</title>
334
351
    <xi:include href="overview.xml"/>
338
355
      <filename>clients.conf</filename> on the server.
339
356
    </para>
340
357
  </refsect1>
341
 
 
 
358
  
342
359
  <refsect1 id="exit_status">
343
360
    <title>EXIT STATUS</title>
344
361
    <para>
401
418
      </varlistentry>
402
419
    </variablelist>
403
420
  </refsect1>
404
 
 
 
421
  
405
422
<!--   <refsect1 id="bugs"> -->
406
423
<!--     <title>BUGS</title> -->
407
424
<!--     <para> -->
408
425
<!--     </para> -->
409
426
<!--   </refsect1> -->
410
 
 
 
427
  
411
428
  <refsect1 id="example">
412
429
    <title>EXAMPLE</title>
413
430
    <informalexample>
454
471
      </para>
455
472
    </informalexample>
456
473
  </refsect1>
457
 
 
 
474
  
458
475
  <refsect1 id="security">
459
476
    <title>SECURITY</title>
460
477
    <para>
469
486
      <manvolnum>8</manvolnum></citerefentry>.
470
487
    </para>
471
488
  </refsect1>
472
 
 
 
489
  
473
490
  <refsect1 id="see_also">
474
491
    <title>SEE ALSO</title>
475
492
    <para>
479
496
      <manvolnum>5</manvolnum></citerefentry>,
480
497
      <citerefentry><refentrytitle>mandos</refentrytitle>
481
498
      <manvolnum>8</manvolnum></citerefentry>,
482
 
      <citerefentry><refentrytitle>password-request</refentrytitle>
 
499
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
483
500
      <manvolnum>8mandos</manvolnum></citerefentry>
484
501
    </para>
485
502
  </refsect1>