/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: 2009-02-15 09:28:06 UTC
  • Revision ID: teddy@fukt.bsnet.se-20090215092806-l0uq42v3j1rq3gmi
* INSTALL: Changed "Python 2.4" to "Python 2.5".
* mandos.lsm: - '' -

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">
5
4
<!ENTITY COMMANDNAME "mandos-keygen">
6
 
<!ENTITY TIMESTAMP "2008-08-31">
 
5
<!ENTITY TIMESTAMP "2009-01-04">
 
6
<!ENTITY % common SYSTEM "common.ent">
 
7
%common;
7
8
]>
8
9
 
9
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
12
    <title>Mandos Manual</title>
12
13
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
13
14
    <productname>Mandos</productname>
14
 
    <productnumber>&VERSION;</productnumber>
 
15
    <productnumber>&version;</productnumber>
15
16
    <date>&TIMESTAMP;</date>
16
17
    <authorgroup>
17
18
      <author>
31
32
    </authorgroup>
32
33
    <copyright>
33
34
      <year>2008</year>
 
35
      <year>2009</year>
34
36
      <holder>Teddy Hogeborn</holder>
35
37
      <holder>Björn Påhlsson</holder>
36
38
    </copyright>
37
 
    <legalnotice>
38
 
      <para>
39
 
        This manual page is free software: you can redistribute it
40
 
        and/or modify it under the terms of the GNU General Public
41
 
        License as published by the Free Software Foundation,
42
 
        either version 3 of the License, or (at your option) any
43
 
        later version.
44
 
      </para>
45
 
 
46
 
      <para>
47
 
        This manual page is distributed in the hope that it will
48
 
        be useful, but WITHOUT ANY WARRANTY; without even the
49
 
        implied warranty of MERCHANTABILITY or FITNESS FOR A
50
 
        PARTICULAR PURPOSE.  See the GNU General Public License
51
 
        for more details.
52
 
      </para>
53
 
 
54
 
      <para>
55
 
        You should have received a copy of the GNU General Public
56
 
        License along with this program; If not, see
57
 
        <ulink url="http://www.gnu.org/licenses/"/>.
58
 
      </para>
59
 
    </legalnotice>
 
39
    <xi:include href="legalnotice.xml"/>
60
40
  </refentryinfo>
61
 
 
 
41
  
62
42
  <refmeta>
63
43
    <refentrytitle>&COMMANDNAME;</refentrytitle>
64
44
    <manvolnum>8</manvolnum>
70
50
      Generate key and password for Mandos client and server.
71
51
    </refpurpose>
72
52
  </refnamediv>
73
 
 
 
53
  
74
54
  <refsynopsisdiv>
75
55
    <cmdsynopsis>
76
56
      <command>&COMMANDNAME;</command>
144
124
      <group choice="req">
145
125
        <arg choice="plain"><option>--password</option></arg>
146
126
        <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>
147
131
      </group>
148
132
      <sbr/>
149
133
      <group>
181
165
    <para>
182
166
      <command>&COMMANDNAME;</command> is a program to generate the
183
167
      OpenPGP key used by
184
 
      <citerefentry><refentrytitle>password-request</refentrytitle>
 
168
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
185
169
      <manvolnum>8mandos</manvolnum></citerefentry>.  The key is
186
170
      normally written to /etc/mandos for later installation into the
187
171
      initrd image, but this, and most other things, can be changed
189
173
    </para>
190
174
    <para>
191
175
      This program can also be used with the
192
 
      <option>--password</option> option to generate a ready-made
193
 
      section for <filename>clients.conf</filename> (see
 
176
      <option>--password</option> or <option>--passfile</option>
 
177
      options to generate a ready-made section for
 
178
      <filename>clients.conf</filename> (see
194
179
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
195
180
      <manvolnum>5</manvolnum></citerefentry>).
196
181
    </para>
219
204
          </para>
220
205
        </listitem>
221
206
      </varlistentry>
222
 
 
 
207
      
223
208
      <varlistentry>
224
209
        <term><option>--dir
225
210
        <replaceable>DIRECTORY</replaceable></option></term>
232
217
          </para>
233
218
        </listitem>
234
219
      </varlistentry>
235
 
 
 
220
      
236
221
      <varlistentry>
237
222
        <term><option>--type
238
223
        <replaceable>TYPE</replaceable></option></term>
244
229
          </para>
245
230
        </listitem>
246
231
      </varlistentry>
247
 
 
 
232
      
248
233
      <varlistentry>
249
234
        <term><option>--length
250
235
        <replaceable>BITS</replaceable></option></term>
256
241
          </para>
257
242
        </listitem>
258
243
      </varlistentry>
259
 
 
 
244
      
260
245
      <varlistentry>
261
246
        <term><option>--subtype
262
247
        <replaceable>KEYTYPE</replaceable></option></term>
269
254
          </para>
270
255
        </listitem>
271
256
      </varlistentry>
272
 
 
 
257
      
273
258
      <varlistentry>
274
259
        <term><option>--sublength
275
260
        <replaceable>BITS</replaceable></option></term>
281
266
          </para>
282
267
        </listitem>
283
268
      </varlistentry>
284
 
 
 
269
      
285
270
      <varlistentry>
286
271
        <term><option>--email
287
272
        <replaceable>ADDRESS</replaceable></option></term>
293
278
          </para>
294
279
        </listitem>
295
280
      </varlistentry>
296
 
 
 
281
      
297
282
      <varlistentry>
298
283
        <term><option>--comment
299
284
        <replaceable>TEXT</replaceable></option></term>
306
291
          </para>
307
292
        </listitem>
308
293
      </varlistentry>
309
 
 
 
294
      
310
295
      <varlistentry>
311
296
        <term><option>--expire
312
297
        <replaceable>TIME</replaceable></option></term>
320
305
          </para>
321
306
        </listitem>
322
307
      </varlistentry>
323
 
 
 
308
      
324
309
      <varlistentry>
325
310
        <term><option>--force</option></term>
326
311
        <term><option>-f</option></term>
348
333
          </para>
349
334
        </listitem>
350
335
      </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>
351
348
    </variablelist>
352
349
  </refsect1>
353
 
 
 
350
  
354
351
  <refsect1 id="overview">
355
352
    <title>OVERVIEW</title>
356
353
    <xi:include href="overview.xml"/>
360
357
      <filename>clients.conf</filename> on the server.
361
358
    </para>
362
359
  </refsect1>
363
 
 
 
360
  
364
361
  <refsect1 id="exit_status">
365
362
    <title>EXIT STATUS</title>
366
363
    <para>
386
383
    </variablelist>
387
384
  </refsect1>
388
385
  
389
 
  <refsect1 id="file">
 
386
  <refsect1 id="files">
390
387
    <title>FILES</title>
391
388
    <para>
392
389
      Use the <option>--dir</option> option to change where
423
420
      </varlistentry>
424
421
    </variablelist>
425
422
  </refsect1>
426
 
 
427
 
  <refsect1 id="bugs">
428
 
    <title>BUGS</title>
429
 
    <para>
430
 
      None are known at this time.
431
 
    </para>
432
 
  </refsect1>
433
 
 
 
423
  
 
424
<!--   <refsect1 id="bugs"> -->
 
425
<!--     <title>BUGS</title> -->
 
426
<!--     <para> -->
 
427
<!--     </para> -->
 
428
<!--   </refsect1> -->
 
429
  
434
430
  <refsect1 id="example">
435
431
    <title>EXAMPLE</title>
436
432
    <informalexample>
477
473
      </para>
478
474
    </informalexample>
479
475
  </refsect1>
480
 
 
 
476
  
481
477
  <refsect1 id="security">
482
478
    <title>SECURITY</title>
483
479
    <para>
492
488
      <manvolnum>8</manvolnum></citerefentry>.
493
489
    </para>
494
490
  </refsect1>
495
 
 
 
491
  
496
492
  <refsect1 id="see_also">
497
493
    <title>SEE ALSO</title>
498
494
    <para>
502
498
      <manvolnum>5</manvolnum></citerefentry>,
503
499
      <citerefentry><refentrytitle>mandos</refentrytitle>
504
500
      <manvolnum>8</manvolnum></citerefentry>,
505
 
      <citerefentry><refentrytitle>password-request</refentrytitle>
 
501
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
506
502
      <manvolnum>8mandos</manvolnum></citerefentry>
507
503
    </para>
508
504
  </refsect1>