/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

merge

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">
6
7
]>
7
8
 
8
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
9
10
  <refentryinfo>
10
 
    <title>&COMMANDNAME;</title>
 
11
    <title>Mandos Manual</title>
11
12
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
12
 
    <productname>&COMMANDNAME;</productname>
 
13
    <productname>Mandos</productname>
13
14
    <productnumber>&VERSION;</productnumber>
 
15
    <date>&TIMESTAMP;</date>
14
16
    <authorgroup>
15
17
      <author>
16
18
        <firstname>Björn</firstname>
158
160
    <cmdsynopsis>
159
161
      <command>&COMMANDNAME;</command>
160
162
      <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">
161
178
        <arg choice="plain"><option>-h</option></arg>
162
179
        <arg choice="plain"><option>--help</option></arg>
163
180
      </group>
182
199
      initrd image, but this, like most things, can be changed with
183
200
      command line options.
184
201
    </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>
185
208
  </refsect1>
186
209
  
187
210
  <refsect1 id="purpose">
214
237
        <replaceable>directory</replaceable></literal></term>
215
238
        <listitem>
216
239
          <para>
217
 
            Target directory for key files.
 
240
            Target directory for key files.  Default is
 
241
            <filename>/etc/mandos</filename>.
218
242
          </para>
219
243
        </listitem>
220
244
      </varlistentry>
234
258
        <replaceable>bits</replaceable></literal></term>
235
259
        <listitem>
236
260
          <para>
237
 
            Key length in bits.  Default is 1024.
 
261
            Key length in bits.  Default is 2048.
238
262
          </para>
239
263
        </listitem>
240
264
      </varlistentry>
301
325
          </para>
302
326
        </listitem>
303
327
      </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>
304
346
    </variablelist>
305
347
  </refsect1>
306
348
 
389
431
        Normal invocation needs no options:
390
432
      </para>
391
433
      <para>
392
 
        <userinput>mandos-keygen</userinput>
 
434
        <userinput>&COMMANDNAME;</userinput>
393
435
      </para>
394
436
    </informalexample>
395
437
    <informalexample>
400
442
      <para>
401
443
 
402
444
<!-- do not wrap this line -->
403
 
<userinput>mandos-keygen --dir ~/keydir --type RSA --force</userinput>
 
445
<userinput>&COMMANDNAME; --dir ~/keydir --type RSA --force</userinput>
404
446
 
405
447
      </para>
406
448
    </informalexample>
424
466
  <refsect1 id="see_also">
425
467
    <title>SEE ALSO</title>
426
468
    <para>
427
 
      <citerefentry><refentrytitle>password-request</refentrytitle>
428
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
469
      <citerefentry><refentrytitle>gpg</refentrytitle>
 
470
      <manvolnum>1</manvolnum></citerefentry>,
429
471
      <citerefentry><refentrytitle>mandos</refentrytitle>
430
472
      <manvolnum>8</manvolnum></citerefentry>,
431
 
      <citerefentry><refentrytitle>gpg</refentrytitle>
432
 
      <manvolnum>1</manvolnum></citerefentry>
 
473
      <citerefentry><refentrytitle>password-request</refentrytitle>
 
474
      <manvolnum>8mandos</manvolnum></citerefentry>
433
475
    </para>
434
476
  </refsect1>
435
477
  
436
478
</refentry>
 
479
<!-- Local Variables: -->
 
480
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
481
<!-- time-stamp-end: "[\"']>" -->
 
482
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
483
<!-- End: -->