/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-08-24 06:17:02 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080824061702-zxrru4r1vxmx4tuq
* Makefile (PREFIX, CONFDIR, MANDIR): Use $(DESTDIR).
  (install-server, install-client): Use "install --directory" instead
                                    of mkdir.

* mandos-keygen: New options --subtype and --sublength.
  (trap): Added semicolons and backslashes.
  (gpg): Added "--enable-dsa2" to all invocations.

* mandos-keygen.xml: Changed single quotes to double quotes for
                     consistency.
  (/refentry/refentryinfo/copyright) Split copyright holders.
  (SYNOPSIS): Added "--subtype", "--sublength", "-s", and "-L".
  (OPTIONS): Document the subtype and sublength options.
  (SECURITY): Also note the "--subtype" and "--sublength" options.

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-29">
7
6
]>
8
7
 
9
8
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
10
9
  <refentryinfo>
11
 
    <title>Mandos Manual</title>
 
10
    <title>&COMMANDNAME;</title>
12
11
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
13
 
    <productname>Mandos</productname>
 
12
    <productname>&COMMANDNAME;</productname>
14
13
    <productnumber>&VERSION;</productnumber>
15
 
    <date>&TIMESTAMP;</date>
16
14
    <authorgroup>
17
15
      <author>
18
16
        <firstname>Björn</firstname>
160
158
    <cmdsynopsis>
161
159
      <command>&COMMANDNAME;</command>
162
160
      <group choice="req">
163
 
        <arg choice="plain"><option>-p</option></arg>
164
 
        <arg choice="plain"><option>--password</option></arg>
165
 
      </group>
166
 
      <group choice="opt">
167
 
        <arg choice="plain"><option>--dir</option>
168
 
        <replaceable>directory</replaceable></arg>
169
 
      </group>
170
 
      <group choice="opt">
171
 
        <arg choice="plain"><option>--name</option>
172
 
        <replaceable>NAME</replaceable></arg>
173
 
      </group>
174
 
    </cmdsynopsis>
175
 
    <cmdsynopsis>
176
 
      <command>&COMMANDNAME;</command>
177
 
      <group choice="req">
178
161
        <arg choice="plain"><option>-h</option></arg>
179
162
        <arg choice="plain"><option>--help</option></arg>
180
163
      </group>
199
182
      initrd image, but this, like most things, can be changed with
200
183
      command line options.
201
184
    </para>
202
 
    <para>
203
 
      It can also be used to generate ready-made sections for
204
 
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
205
 
      <manvolnum>5</manvolnum></citerefentry> using the
206
 
      <option>--password</option> option.
207
 
    </para>
208
185
  </refsect1>
209
186
  
210
187
  <refsect1 id="purpose">
237
214
        <replaceable>directory</replaceable></literal></term>
238
215
        <listitem>
239
216
          <para>
240
 
            Target directory for key files.  Default is
241
 
            <filename>/etc/mandos</filename>.
 
217
            Target directory for key files.
242
218
          </para>
243
219
        </listitem>
244
220
      </varlistentry>
258
234
        <replaceable>bits</replaceable></literal></term>
259
235
        <listitem>
260
236
          <para>
261
 
            Key length in bits.  Default is 2048.
 
237
            Key length in bits.  Default is 1024.
262
238
          </para>
263
239
        </listitem>
264
240
      </varlistentry>
325
301
          </para>
326
302
        </listitem>
327
303
      </varlistentry>
328
 
      <varlistentry>
329
 
        <term><literal>-p</literal>, <literal>--password</literal
330
 
        ></term>
331
 
        <listitem>
332
 
          <para>
333
 
            Prompt for a password and encrypt it with the key already
334
 
            present in either <filename>/etc/mandos</filename> or the
335
 
            directory specified with the <option>--dir</option>
336
 
            option.  Outputs, on standard output, a section suitable
337
 
            for inclusion in <citerefentry><refentrytitle
338
 
            >mandos-clients.conf</refentrytitle><manvolnum
339
 
            >8</manvolnum></citerefentry>.  The host name or the name
340
 
            specified with the <option>--name</option> option is used
341
 
            for the section header.  All other options are ignored,
342
 
            and no keys are created.
343
 
          </para>
344
 
        </listitem>
345
 
      </varlistentry>
346
304
    </variablelist>
347
305
  </refsect1>
348
306
 
431
389
        Normal invocation needs no options:
432
390
      </para>
433
391
      <para>
434
 
        <userinput>&COMMANDNAME;</userinput>
 
392
        <userinput>mandos-keygen</userinput>
435
393
      </para>
436
394
    </informalexample>
437
395
    <informalexample>
442
400
      <para>
443
401
 
444
402
<!-- do not wrap this line -->
445
 
<userinput>&COMMANDNAME; --dir ~/keydir --type RSA --force</userinput>
 
403
<userinput>mandos-keygen --dir ~/keydir --type RSA --force</userinput>
446
404
 
447
405
      </para>
448
406
    </informalexample>
466
424
  <refsect1 id="see_also">
467
425
    <title>SEE ALSO</title>
468
426
    <para>
 
427
      <citerefentry><refentrytitle>password-request</refentrytitle>
 
428
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
429
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
430
      <manvolnum>8</manvolnum></citerefentry>,
469
431
      <citerefentry><refentrytitle>gpg</refentrytitle>
470
 
      <manvolnum>1</manvolnum></citerefentry>,
471
 
      <citerefentry><refentrytitle>mandos</refentrytitle>
472
 
      <manvolnum>8</manvolnum></citerefentry>,
473
 
      <citerefentry><refentrytitle>password-request</refentrytitle>
474
 
      <manvolnum>8mandos</manvolnum></citerefentry>
 
432
      <manvolnum>1</manvolnum></citerefentry>
475
433
    </para>
476
434
  </refsect1>
477
435
  
478
436
</refentry>
479
 
<!-- Local Variables: -->
480
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
481
 
<!-- time-stamp-end: "[\"']>" -->
482
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
483
 
<!-- End: -->