/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: 2016-03-17 21:18:37 UTC
  • Revision ID: teddy@recompile.se-20160317211837-f2tz0c9284rsv3k8
Client: Document default directories more clearly

Document default plugin directory and default plugin helper directory
also in the FILES section of the manual.

* plugin-runner.xml (FILES): Add "/lib/mandos/plugins.d" and
                             "/lib/mandos/plugin-helpers".

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-09-20">
 
5
<!ENTITY TIMESTAMP "2016-03-05">
 
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>
18
19
        <firstname>Björn</firstname>
19
20
        <surname>Påhlsson</surname>
20
21
        <address>
21
 
          <email>belorn@fukt.bsnet.se</email>
 
22
          <email>belorn@recompile.se</email>
22
23
        </address>
23
24
      </author>
24
25
      <author>
25
26
        <firstname>Teddy</firstname>
26
27
        <surname>Hogeborn</surname>
27
28
        <address>
28
 
          <email>teddy@fukt.bsnet.se</email>
 
29
          <email>teddy@recompile.se</email>
29
30
        </address>
30
31
      </author>
31
32
    </authorgroup>
32
33
    <copyright>
33
34
      <year>2008</year>
 
35
      <year>2009</year>
 
36
      <year>2010</year>
 
37
      <year>2011</year>
 
38
      <year>2012</year>
 
39
      <year>2013</year>
 
40
      <year>2014</year>
 
41
      <year>2015</year>
 
42
      <year>2016</year>
34
43
      <holder>Teddy Hogeborn</holder>
35
44
      <holder>Björn Påhlsson</holder>
36
45
    </copyright>
115
124
        <replaceable>TIME</replaceable></option></arg>
116
125
      </group>
117
126
      <sbr/>
118
 
      <arg><option>--force</option></arg>
 
127
      <group>
 
128
        <arg choice="plain"><option>--force</option></arg>
 
129
        <arg choice="plain"><option>-f</option></arg>
 
130
      </group>
119
131
    </cmdsynopsis>
120
132
    <cmdsynopsis>
121
133
      <command>&COMMANDNAME;</command>
141
153
        <arg choice="plain"><option>-n
142
154
        <replaceable>NAME</replaceable></option></arg>
143
155
      </group>
 
156
      <group>
 
157
        <arg choice="plain"><option>--no-ssh</option></arg>
 
158
        <arg choice="plain"><option>-S</option></arg>
 
159
      </group>
144
160
    </cmdsynopsis>
145
161
    <cmdsynopsis>
146
162
      <command>&COMMANDNAME;</command>
211
227
        <listitem>
212
228
          <para>
213
229
            Target directory for key files.  Default is
214
 
            <filename>/etc/mandos</filename>.
 
230
            <filename class="directory">/etc/mandos</filename>.
215
231
          </para>
216
232
        </listitem>
217
233
      </varlistentry>
223
239
        <replaceable>TYPE</replaceable></option></term>
224
240
        <listitem>
225
241
          <para>
226
 
            Key type.  Default is <quote>DSA</quote>.
 
242
            Key type.  Default is <quote>RSA</quote>.
227
243
          </para>
228
244
        </listitem>
229
245
      </varlistentry>
235
251
        <replaceable>BITS</replaceable></option></term>
236
252
        <listitem>
237
253
          <para>
238
 
            Key length in bits.  Default is 2048.
 
254
            Key length in bits.  Default is 4096.
239
255
          </para>
240
256
        </listitem>
241
257
      </varlistentry>
247
263
        <replaceable>KEYTYPE</replaceable></option></term>
248
264
        <listitem>
249
265
          <para>
250
 
            Subkey type.  Default is <quote>ELG-E</quote> (Elgamal
 
266
            Subkey type.  Default is <quote>RSA</quote> (Elgamal
251
267
            encryption-only).
252
268
          </para>
253
269
        </listitem>
260
276
        <replaceable>BITS</replaceable></option></term>
261
277
        <listitem>
262
278
          <para>
263
 
            Subkey length in bits.  Default is 2048.
 
279
            Subkey length in bits.  Default is 4096.
264
280
          </para>
265
281
        </listitem>
266
282
      </varlistentry>
284
300
        <replaceable>TEXT</replaceable></option></term>
285
301
        <listitem>
286
302
          <para>
287
 
            Comment field for key.  The default value is
288
 
            <quote><literal>Mandos client key</literal></quote>.
 
303
            Comment field for key.  Default is empty.
289
304
          </para>
290
305
        </listitem>
291
306
      </varlistentry>
343
358
          </para>
344
359
        </listitem>
345
360
      </varlistentry>
 
361
      <varlistentry>
 
362
        <term><option>--no-ssh</option></term>
 
363
        <term><option>-S</option></term>
 
364
        <listitem>
 
365
          <para>
 
366
            When <option>--password</option> or
 
367
            <option>--passfile</option> is given, this option will
 
368
            prevent <command>&COMMANDNAME;</command> from calling
 
369
            <command>ssh-keyscan</command> to get an SSH fingerprint
 
370
            for this host and, if successful, output suitable config
 
371
            options to use this fingerprint as a
 
372
            <option>checker</option> option in the output.  This is
 
373
            otherwise the default behavior.
 
374
          </para>
 
375
        </listitem>
 
376
      </varlistentry>
346
377
    </variablelist>
347
378
  </refsect1>
348
379
  
381
412
    </variablelist>
382
413
  </refsect1>
383
414
  
384
 
  <refsect1 id="file">
 
415
  <refsect1 id="files">
385
416
    <title>FILES</title>
386
417
    <para>
387
418
      Use the <option>--dir</option> option to change where
408
439
        </listitem>
409
440
      </varlistentry>
410
441
      <varlistentry>
411
 
        <term><filename>/tmp</filename></term>
 
442
        <term><filename class="directory">/tmp</filename></term>
412
443
        <listitem>
413
444
          <para>
414
445
            Temporary files will be written here if
419
450
    </variablelist>
420
451
  </refsect1>
421
452
  
422
 
<!--   <refsect1 id="bugs"> -->
423
 
<!--     <title>BUGS</title> -->
424
 
<!--     <para> -->
425
 
<!--     </para> -->
426
 
<!--   </refsect1> -->
 
453
  <refsect1 id="bugs">
 
454
    <title>BUGS</title>
 
455
    <xi:include href="bugs.xml"/>
 
456
  </refsect1>
427
457
  
428
458
  <refsect1 id="example">
429
459
    <title>EXAMPLE</title>
449
479
    </informalexample>
450
480
    <informalexample>
451
481
      <para>
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>.
 
482
        Prompt for a password, encrypt it with the key in <filename
 
483
        class="directory">/etc/mandos</filename> and output a section
 
484
        suitable for <filename>clients.conf</filename>.
455
485
      </para>
456
486
      <para>
457
487
        <userinput>&COMMANDNAME; --password</userinput>
490
520
  <refsect1 id="see_also">
491
521
    <title>SEE ALSO</title>
492
522
    <para>
 
523
      <citerefentry><refentrytitle>intro</refentrytitle>
 
524
      <manvolnum>8mandos</manvolnum></citerefentry>,
493
525
      <citerefentry><refentrytitle>gpg</refentrytitle>
494
526
      <manvolnum>1</manvolnum></citerefentry>,
495
527
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
497
529
      <citerefentry><refentrytitle>mandos</refentrytitle>
498
530
      <manvolnum>8</manvolnum></citerefentry>,
499
531
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
500
 
      <manvolnum>8mandos</manvolnum></citerefentry>
 
532
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
533
      <citerefentry><refentrytitle>ssh-keyscan</refentrytitle>
 
534
      <manvolnum>1</manvolnum></citerefentry>
501
535
    </para>
502
536
  </refsect1>
503
537