/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-13 15:36:18 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080913153618-atp386q2bqj0ku99
* Makefile (install-client-nokey): Do "&&" instead of ";" to catch
                                   errors.

* README: Kill the straight quotes.  Add copyright notice.

* overview.xml: Improved wording.

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-08-31">
 
6
<!ENTITY TIMESTAMP "2008-09-12">
7
7
]>
8
8
 
9
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
34
34
      <holder>Teddy Hogeborn</holder>
35
35
      <holder>Björn Påhlsson</holder>
36
36
    </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>
 
37
    <xi:include href="legalnotice.xml"/>
60
38
  </refentryinfo>
61
 
 
 
39
  
62
40
  <refmeta>
63
41
    <refentrytitle>&COMMANDNAME;</refentrytitle>
64
42
    <manvolnum>8</manvolnum>
70
48
      Generate key and password for Mandos client and server.
71
49
    </refpurpose>
72
50
  </refnamediv>
73
 
 
 
51
  
74
52
  <refsynopsisdiv>
75
53
    <cmdsynopsis>
76
54
      <command>&COMMANDNAME;</command>
181
159
    <para>
182
160
      <command>&COMMANDNAME;</command> is a program to generate the
183
161
      OpenPGP key used by
184
 
      <citerefentry><refentrytitle>password-request</refentrytitle>
 
162
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
185
163
      <manvolnum>8mandos</manvolnum></citerefentry>.  The key is
186
164
      normally written to /etc/mandos for later installation into the
187
165
      initrd image, but this, and most other things, can be changed
219
197
          </para>
220
198
        </listitem>
221
199
      </varlistentry>
222
 
 
 
200
      
223
201
      <varlistentry>
224
202
        <term><option>--dir
225
203
        <replaceable>DIRECTORY</replaceable></option></term>
232
210
          </para>
233
211
        </listitem>
234
212
      </varlistentry>
235
 
 
 
213
      
236
214
      <varlistentry>
237
215
        <term><option>--type
238
216
        <replaceable>TYPE</replaceable></option></term>
244
222
          </para>
245
223
        </listitem>
246
224
      </varlistentry>
247
 
 
 
225
      
248
226
      <varlistentry>
249
227
        <term><option>--length
250
228
        <replaceable>BITS</replaceable></option></term>
256
234
          </para>
257
235
        </listitem>
258
236
      </varlistentry>
259
 
 
 
237
      
260
238
      <varlistentry>
261
239
        <term><option>--subtype
262
240
        <replaceable>KEYTYPE</replaceable></option></term>
269
247
          </para>
270
248
        </listitem>
271
249
      </varlistentry>
272
 
 
 
250
      
273
251
      <varlistentry>
274
252
        <term><option>--sublength
275
253
        <replaceable>BITS</replaceable></option></term>
281
259
          </para>
282
260
        </listitem>
283
261
      </varlistentry>
284
 
 
 
262
      
285
263
      <varlistentry>
286
264
        <term><option>--email
287
265
        <replaceable>ADDRESS</replaceable></option></term>
293
271
          </para>
294
272
        </listitem>
295
273
      </varlistentry>
296
 
 
 
274
      
297
275
      <varlistentry>
298
276
        <term><option>--comment
299
277
        <replaceable>TEXT</replaceable></option></term>
306
284
          </para>
307
285
        </listitem>
308
286
      </varlistentry>
309
 
 
 
287
      
310
288
      <varlistentry>
311
289
        <term><option>--expire
312
290
        <replaceable>TIME</replaceable></option></term>
320
298
          </para>
321
299
        </listitem>
322
300
      </varlistentry>
323
 
 
 
301
      
324
302
      <varlistentry>
325
303
        <term><option>--force</option></term>
326
304
        <term><option>-f</option></term>
350
328
      </varlistentry>
351
329
    </variablelist>
352
330
  </refsect1>
353
 
 
 
331
  
354
332
  <refsect1 id="overview">
355
333
    <title>OVERVIEW</title>
356
334
    <xi:include href="overview.xml"/>
360
338
      <filename>clients.conf</filename> on the server.
361
339
    </para>
362
340
  </refsect1>
363
 
 
 
341
  
364
342
  <refsect1 id="exit_status">
365
343
    <title>EXIT STATUS</title>
366
344
    <para>
423
401
      </varlistentry>
424
402
    </variablelist>
425
403
  </refsect1>
426
 
 
427
 
  <refsect1 id="bugs">
428
 
    <title>BUGS</title>
429
 
    <para>
430
 
      None are known at this time.
431
 
    </para>
432
 
  </refsect1>
433
 
 
 
404
  
 
405
<!--   <refsect1 id="bugs"> -->
 
406
<!--     <title>BUGS</title> -->
 
407
<!--     <para> -->
 
408
<!--     </para> -->
 
409
<!--   </refsect1> -->
 
410
  
434
411
  <refsect1 id="example">
435
412
    <title>EXAMPLE</title>
436
413
    <informalexample>
477
454
      </para>
478
455
    </informalexample>
479
456
  </refsect1>
480
 
 
 
457
  
481
458
  <refsect1 id="security">
482
459
    <title>SECURITY</title>
483
460
    <para>
492
469
      <manvolnum>8</manvolnum></citerefentry>.
493
470
    </para>
494
471
  </refsect1>
495
 
 
 
472
  
496
473
  <refsect1 id="see_also">
497
474
    <title>SEE ALSO</title>
498
475
    <para>
502
479
      <manvolnum>5</manvolnum></citerefentry>,
503
480
      <citerefentry><refentrytitle>mandos</refentrytitle>
504
481
      <manvolnum>8</manvolnum></citerefentry>,
505
 
      <citerefentry><refentrytitle>password-request</refentrytitle>
 
482
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
506
483
      <manvolnum>8mandos</manvolnum></citerefentry>
507
484
    </para>
508
485
  </refsect1>