/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-30 03:19:39 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080930031939-t72se4dhr632o9ct
* Makefile: Add HTML rules for manual pages.
  (DOCBOOKTOHTML, HTMLPOST): New commands.
  (htmldocs): New file list.
  (html, install-html): New targets.
  (.PHONY, clean): Added "html".

* README (The Plugin System): New section; describe plugin system.

* debian/control (Uploaders): New field.

* mandos-options.xml (servicename): Improve wording.

* plugins.d/mandos-client.xml (SECURITY): Improve wording.

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 "2013-10-22">
6
 
<!ENTITY % common SYSTEM "common.ent">
7
 
%common;
 
6
<!ENTITY TIMESTAMP "2008-09-20">
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>
19
18
        <firstname>Björn</firstname>
20
19
        <surname>Påhlsson</surname>
21
20
        <address>
22
 
          <email>belorn@recompile.se</email>
 
21
          <email>belorn@fukt.bsnet.se</email>
23
22
        </address>
24
23
      </author>
25
24
      <author>
26
25
        <firstname>Teddy</firstname>
27
26
        <surname>Hogeborn</surname>
28
27
        <address>
29
 
          <email>teddy@recompile.se</email>
 
28
          <email>teddy@fukt.bsnet.se</email>
30
29
        </address>
31
30
      </author>
32
31
    </authorgroup>
33
32
    <copyright>
34
33
      <year>2008</year>
35
 
      <year>2009</year>
36
 
      <year>2011</year>
37
 
      <year>2012</year>
38
34
      <holder>Teddy Hogeborn</holder>
39
35
      <holder>Björn Påhlsson</holder>
40
36
    </copyright>
215
211
        <listitem>
216
212
          <para>
217
213
            Target directory for key files.  Default is
218
 
            <filename class="directory">/etc/mandos</filename>.
 
214
            <filename>/etc/mandos</filename>.
219
215
          </para>
220
216
        </listitem>
221
217
      </varlistentry>
227
223
        <replaceable>TYPE</replaceable></option></term>
228
224
        <listitem>
229
225
          <para>
230
 
            Key type.  Default is <quote>RSA</quote>.
 
226
            Key type.  Default is <quote>DSA</quote>.
231
227
          </para>
232
228
        </listitem>
233
229
      </varlistentry>
239
235
        <replaceable>BITS</replaceable></option></term>
240
236
        <listitem>
241
237
          <para>
242
 
            Key length in bits.  Default is 4096.
 
238
            Key length in bits.  Default is 2048.
243
239
          </para>
244
240
        </listitem>
245
241
      </varlistentry>
251
247
        <replaceable>KEYTYPE</replaceable></option></term>
252
248
        <listitem>
253
249
          <para>
254
 
            Subkey type.  Default is <quote>RSA</quote> (Elgamal
 
250
            Subkey type.  Default is <quote>ELG-E</quote> (Elgamal
255
251
            encryption-only).
256
252
          </para>
257
253
        </listitem>
264
260
        <replaceable>BITS</replaceable></option></term>
265
261
        <listitem>
266
262
          <para>
267
 
            Subkey length in bits.  Default is 4096.
 
263
            Subkey length in bits.  Default is 2048.
268
264
          </para>
269
265
        </listitem>
270
266
      </varlistentry>
288
284
        <replaceable>TEXT</replaceable></option></term>
289
285
        <listitem>
290
286
          <para>
291
 
            Comment field for key.  Default is empty.
 
287
            Comment field for key.  The default value is
 
288
            <quote><literal>Mandos client key</literal></quote>.
292
289
          </para>
293
290
        </listitem>
294
291
      </varlistentry>
384
381
    </variablelist>
385
382
  </refsect1>
386
383
  
387
 
  <refsect1 id="files">
 
384
  <refsect1 id="file">
388
385
    <title>FILES</title>
389
386
    <para>
390
387
      Use the <option>--dir</option> option to change where
411
408
        </listitem>
412
409
      </varlistentry>
413
410
      <varlistentry>
414
 
        <term><filename class="directory">/tmp</filename></term>
 
411
        <term><filename>/tmp</filename></term>
415
412
        <listitem>
416
413
          <para>
417
414
            Temporary files will be written here if
452
449
    </informalexample>
453
450
    <informalexample>
454
451
      <para>
455
 
        Prompt for a password, encrypt it with the key in <filename
456
 
        class="directory">/etc/mandos</filename> and output a section
457
 
        suitable for <filename>clients.conf</filename>.
 
452
        Prompt for a password, encrypt it with the key in
 
453
        <filename>/etc/mandos</filename> and output a section suitable
 
454
        for <filename>clients.conf</filename>.
458
455
      </para>
459
456
      <para>
460
457
        <userinput>&COMMANDNAME; --password</userinput>
493
490
  <refsect1 id="see_also">
494
491
    <title>SEE ALSO</title>
495
492
    <para>
496
 
      <citerefentry><refentrytitle>intro</refentrytitle>
497
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
498
493
      <citerefentry><refentrytitle>gpg</refentrytitle>
499
494
      <manvolnum>1</manvolnum></citerefentry>,
500
495
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>