/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: 2017-08-20 16:20:54 UTC
  • Revision ID: teddy@recompile.se-20170820162054-jwig602syxx2k4l0
Alter copyright notices slightly.  Actual license is unchanged!

This alters all copyright notices to use the Free Software
Foundation's recommendations for license notices; from
<https://www.gnu.org/licenses/gpl-howto.html>:

  For programs that are more than one file, it is better to replace
  “this program” with the name of the program, and begin the statement
  with a line saying “This file is part of NAME”.

* DBUS-API: Use program name "Mandos" explicitly in license notice.
* debian/copyright: - '' -
* initramfs-unpack: - '' -
* legalnotice.xml: - '' -
* mandos: - '' -
* mandos-ctl: - '' -
* mandos-keygen: - '' -
* mandos-monitor: - '' -
* plugin-helpers/mandos-client-iprouteadddel.c: - '' -
* plugin-runner.c: - '' -
* plugins.d/askpass-fifo.c: - '' -
* plugins.d/mandos-client.c: - '' -
* plugins.d/password-prompt.c: - '' -
* plugins.d/plymouth.c: - '' -
* plugins.d/splashy.c: - '' -
* plugins.d/usplash.c: - '' -

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-keygen.xml
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
4
<!ENTITY COMMANDNAME "mandos-keygen">
5
 
<!ENTITY TIMESTAMP "2009-01-04">
 
5
<!ENTITY TIMESTAMP "2017-02-23">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
19
19
        <firstname>Björn</firstname>
20
20
        <surname>Påhlsson</surname>
21
21
        <address>
22
 
          <email>belorn@fukt.bsnet.se</email>
 
22
          <email>belorn@recompile.se</email>
23
23
        </address>
24
24
      </author>
25
25
      <author>
26
26
        <firstname>Teddy</firstname>
27
27
        <surname>Hogeborn</surname>
28
28
        <address>
29
 
          <email>teddy@fukt.bsnet.se</email>
 
29
          <email>teddy@recompile.se</email>
30
30
        </address>
31
31
      </author>
32
32
    </authorgroup>
33
33
    <copyright>
34
34
      <year>2008</year>
35
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>
36
44
      <holder>Teddy Hogeborn</holder>
37
45
      <holder>Björn Påhlsson</holder>
38
46
    </copyright>
117
125
        <replaceable>TIME</replaceable></option></arg>
118
126
      </group>
119
127
      <sbr/>
120
 
      <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>
121
132
    </cmdsynopsis>
122
133
    <cmdsynopsis>
123
134
      <command>&COMMANDNAME;</command>
143
154
        <arg choice="plain"><option>-n
144
155
        <replaceable>NAME</replaceable></option></arg>
145
156
      </group>
 
157
      <group>
 
158
        <arg choice="plain"><option>--no-ssh</option></arg>
 
159
        <arg choice="plain"><option>-S</option></arg>
 
160
      </group>
146
161
    </cmdsynopsis>
147
162
    <cmdsynopsis>
148
163
      <command>&COMMANDNAME;</command>
213
228
        <listitem>
214
229
          <para>
215
230
            Target directory for key files.  Default is
216
 
            <filename>/etc/mandos</filename>.
 
231
            <filename class="directory">/etc/mandos</filename>.
217
232
          </para>
218
233
        </listitem>
219
234
      </varlistentry>
225
240
        <replaceable>TYPE</replaceable></option></term>
226
241
        <listitem>
227
242
          <para>
228
 
            Key type.  Default is <quote>DSA</quote>.
 
243
            Key type.  Default is <quote>RSA</quote>.
229
244
          </para>
230
245
        </listitem>
231
246
      </varlistentry>
237
252
        <replaceable>BITS</replaceable></option></term>
238
253
        <listitem>
239
254
          <para>
240
 
            Key length in bits.  Default is 2048.
 
255
            Key length in bits.  Default is 4096.
241
256
          </para>
242
257
        </listitem>
243
258
      </varlistentry>
249
264
        <replaceable>KEYTYPE</replaceable></option></term>
250
265
        <listitem>
251
266
          <para>
252
 
            Subkey type.  Default is <quote>ELG-E</quote> (Elgamal
 
267
            Subkey type.  Default is <quote>RSA</quote> (Elgamal
253
268
            encryption-only).
254
269
          </para>
255
270
        </listitem>
262
277
        <replaceable>BITS</replaceable></option></term>
263
278
        <listitem>
264
279
          <para>
265
 
            Subkey length in bits.  Default is 2048.
 
280
            Subkey length in bits.  Default is 4096.
266
281
          </para>
267
282
        </listitem>
268
283
      </varlistentry>
286
301
        <replaceable>TEXT</replaceable></option></term>
287
302
        <listitem>
288
303
          <para>
289
 
            Comment field for key.  The default value is
290
 
            <quote><literal>Mandos client key</literal></quote>.
 
304
            Comment field for key.  Default is empty.
291
305
          </para>
292
306
        </listitem>
293
307
      </varlistentry>
345
359
          </para>
346
360
        </listitem>
347
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>
348
378
    </variablelist>
349
379
  </refsect1>
350
380
  
410
440
        </listitem>
411
441
      </varlistentry>
412
442
      <varlistentry>
413
 
        <term><filename>/tmp</filename></term>
 
443
        <term><filename class="directory">/tmp</filename></term>
414
444
        <listitem>
415
445
          <para>
416
446
            Temporary files will be written here if
421
451
    </variablelist>
422
452
  </refsect1>
423
453
  
424
 
<!--   <refsect1 id="bugs"> -->
425
 
<!--     <title>BUGS</title> -->
426
 
<!--     <para> -->
427
 
<!--     </para> -->
428
 
<!--   </refsect1> -->
 
454
  <refsect1 id="bugs">
 
455
    <title>BUGS</title>
 
456
    <xi:include href="bugs.xml"/>
 
457
  </refsect1>
429
458
  
430
459
  <refsect1 id="example">
431
460
    <title>EXAMPLE</title>
451
480
    </informalexample>
452
481
    <informalexample>
453
482
      <para>
454
 
        Prompt for a password, encrypt it with the key in
455
 
        <filename>/etc/mandos</filename> and output a section suitable
456
 
        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>.
457
486
      </para>
458
487
      <para>
459
488
        <userinput>&COMMANDNAME; --password</userinput>
492
521
  <refsect1 id="see_also">
493
522
    <title>SEE ALSO</title>
494
523
    <para>
 
524
      <citerefentry><refentrytitle>intro</refentrytitle>
 
525
      <manvolnum>8mandos</manvolnum></citerefentry>,
495
526
      <citerefentry><refentrytitle>gpg</refentrytitle>
496
527
      <manvolnum>1</manvolnum></citerefentry>,
497
528
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
499
530
      <citerefentry><refentrytitle>mandos</refentrytitle>
500
531
      <manvolnum>8</manvolnum></citerefentry>,
501
532
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
502
 
      <manvolnum>8mandos</manvolnum></citerefentry>
 
533
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
534
      <citerefentry><refentrytitle>ssh-keyscan</refentrytitle>
 
535
      <manvolnum>1</manvolnum></citerefentry>
503
536
    </para>
504
537
  </refsect1>
505
538