/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 "2011-08-08">
 
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>
36
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>
37
44
      <holder>Teddy Hogeborn</holder>
38
45
      <holder>Björn Påhlsson</holder>
39
46
    </copyright>
118
125
        <replaceable>TIME</replaceable></option></arg>
119
126
      </group>
120
127
      <sbr/>
121
 
      <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>
122
132
    </cmdsynopsis>
123
133
    <cmdsynopsis>
124
134
      <command>&COMMANDNAME;</command>
144
154
        <arg choice="plain"><option>-n
145
155
        <replaceable>NAME</replaceable></option></arg>
146
156
      </group>
 
157
      <group>
 
158
        <arg choice="plain"><option>--no-ssh</option></arg>
 
159
        <arg choice="plain"><option>-S</option></arg>
 
160
      </group>
147
161
    </cmdsynopsis>
148
162
    <cmdsynopsis>
149
163
      <command>&COMMANDNAME;</command>
214
228
        <listitem>
215
229
          <para>
216
230
            Target directory for key files.  Default is
217
 
            <filename>/etc/mandos</filename>.
 
231
            <filename class="directory">/etc/mandos</filename>.
218
232
          </para>
219
233
        </listitem>
220
234
      </varlistentry>
226
240
        <replaceable>TYPE</replaceable></option></term>
227
241
        <listitem>
228
242
          <para>
229
 
            Key type.  Default is <quote>DSA</quote>.
 
243
            Key type.  Default is <quote>RSA</quote>.
230
244
          </para>
231
245
        </listitem>
232
246
      </varlistentry>
238
252
        <replaceable>BITS</replaceable></option></term>
239
253
        <listitem>
240
254
          <para>
241
 
            Key length in bits.  Default is 2048.
 
255
            Key length in bits.  Default is 4096.
242
256
          </para>
243
257
        </listitem>
244
258
      </varlistentry>
250
264
        <replaceable>KEYTYPE</replaceable></option></term>
251
265
        <listitem>
252
266
          <para>
253
 
            Subkey type.  Default is <quote>ELG-E</quote> (Elgamal
 
267
            Subkey type.  Default is <quote>RSA</quote> (Elgamal
254
268
            encryption-only).
255
269
          </para>
256
270
        </listitem>
263
277
        <replaceable>BITS</replaceable></option></term>
264
278
        <listitem>
265
279
          <para>
266
 
            Subkey length in bits.  Default is 2048.
 
280
            Subkey length in bits.  Default is 4096.
267
281
          </para>
268
282
        </listitem>
269
283
      </varlistentry>
287
301
        <replaceable>TEXT</replaceable></option></term>
288
302
        <listitem>
289
303
          <para>
290
 
            Comment field for key.  The default value is
291
 
            <quote><literal>Mandos client key</literal></quote>.
 
304
            Comment field for key.  Default is empty.
292
305
          </para>
293
306
        </listitem>
294
307
      </varlistentry>
346
359
          </para>
347
360
        </listitem>
348
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>
349
378
    </variablelist>
350
379
  </refsect1>
351
380
  
411
440
        </listitem>
412
441
      </varlistentry>
413
442
      <varlistentry>
414
 
        <term><filename>/tmp</filename></term>
 
443
        <term><filename class="directory">/tmp</filename></term>
415
444
        <listitem>
416
445
          <para>
417
446
            Temporary files will be written here if
422
451
    </variablelist>
423
452
  </refsect1>
424
453
  
425
 
<!--   <refsect1 id="bugs"> -->
426
 
<!--     <title>BUGS</title> -->
427
 
<!--     <para> -->
428
 
<!--     </para> -->
429
 
<!--   </refsect1> -->
 
454
  <refsect1 id="bugs">
 
455
    <title>BUGS</title>
 
456
    <xi:include href="bugs.xml"/>
 
457
  </refsect1>
430
458
  
431
459
  <refsect1 id="example">
432
460
    <title>EXAMPLE</title>
452
480
    </informalexample>
453
481
    <informalexample>
454
482
      <para>
455
 
        Prompt for a password, encrypt it with the key in
456
 
        <filename>/etc/mandos</filename> and output a section suitable
457
 
        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>.
458
486
      </para>
459
487
      <para>
460
488
        <userinput>&COMMANDNAME; --password</userinput>
502
530
      <citerefentry><refentrytitle>mandos</refentrytitle>
503
531
      <manvolnum>8</manvolnum></citerefentry>,
504
532
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
505
 
      <manvolnum>8mandos</manvolnum></citerefentry>
 
533
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
534
      <citerefentry><refentrytitle>ssh-keyscan</refentrytitle>
 
535
      <manvolnum>1</manvolnum></citerefentry>
506
536
    </para>
507
537
  </refsect1>
508
538