/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to mandos-keygen.xml

  • Committer: Teddy Hogeborn
  • Date: 2017-08-20 14:08:59 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 360.
  • Revision ID: teddy@recompile.se-20170820140859-6niaa0ebf6bdovfn
Use || instead of -o in shell scripts.

* mandos-keygen: Use || instead of -o.
* network-hooks.d/bridge: - '' -

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