/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: 2012-05-26 22:56:38 UTC
  • mfrom: (589.1.1 socket-option)
  • Revision ID: teddy@recompile.se-20120526225638-4hvqyrvmj0036lfn
Merge "--socket" option for server.

This is suggested by the GNU Coding Standards' Table of Long Options,
and will probably also allow socket activation (e.g. by systemd(8)).

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 "2017-02-23">
 
5
<!ENTITY TIMESTAMP "2012-01-01">
6
6
<!ENTITY % common SYSTEM "common.ent">
7
7
%common;
8
8
]>
33
33
    <copyright>
34
34
      <year>2008</year>
35
35
      <year>2009</year>
36
 
      <year>2010</year>
37
36
      <year>2011</year>
38
37
      <year>2012</year>
39
 
      <year>2013</year>
40
 
      <year>2014</year>
41
 
      <year>2015</year>
42
 
      <year>2016</year>
43
 
      <year>2017</year>
44
38
      <holder>Teddy Hogeborn</holder>
45
39
      <holder>Björn Påhlsson</holder>
46
40
    </copyright>
125
119
        <replaceable>TIME</replaceable></option></arg>
126
120
      </group>
127
121
      <sbr/>
128
 
      <group>
129
 
        <arg choice="plain"><option>--force</option></arg>
130
 
        <arg choice="plain"><option>-f</option></arg>
131
 
      </group>
 
122
      <arg><option>--force</option></arg>
132
123
    </cmdsynopsis>
133
124
    <cmdsynopsis>
134
125
      <command>&COMMANDNAME;</command>
154
145
        <arg choice="plain"><option>-n
155
146
        <replaceable>NAME</replaceable></option></arg>
156
147
      </group>
157
 
      <group>
158
 
        <arg choice="plain"><option>--no-ssh</option></arg>
159
 
        <arg choice="plain"><option>-S</option></arg>
160
 
      </group>
161
148
    </cmdsynopsis>
162
149
    <cmdsynopsis>
163
150
      <command>&COMMANDNAME;</command>
240
227
        <replaceable>TYPE</replaceable></option></term>
241
228
        <listitem>
242
229
          <para>
243
 
            Key type.  Default is <quote>RSA</quote>.
 
230
            Key type.  Default is <quote>DSA</quote>.
244
231
          </para>
245
232
        </listitem>
246
233
      </varlistentry>
252
239
        <replaceable>BITS</replaceable></option></term>
253
240
        <listitem>
254
241
          <para>
255
 
            Key length in bits.  Default is 4096.
 
242
            Key length in bits.  Default is 2048.
256
243
          </para>
257
244
        </listitem>
258
245
      </varlistentry>
264
251
        <replaceable>KEYTYPE</replaceable></option></term>
265
252
        <listitem>
266
253
          <para>
267
 
            Subkey type.  Default is <quote>RSA</quote> (Elgamal
 
254
            Subkey type.  Default is <quote>ELG-E</quote> (Elgamal
268
255
            encryption-only).
269
256
          </para>
270
257
        </listitem>
277
264
        <replaceable>BITS</replaceable></option></term>
278
265
        <listitem>
279
266
          <para>
280
 
            Subkey length in bits.  Default is 4096.
 
267
            Subkey length in bits.  Default is 2048.
281
268
          </para>
282
269
        </listitem>
283
270
      </varlistentry>
301
288
        <replaceable>TEXT</replaceable></option></term>
302
289
        <listitem>
303
290
          <para>
304
 
            Comment field for key.  Default is empty.
 
291
            Comment field for key.  The default value is
 
292
            <quote><literal>Mandos client key</literal></quote>.
305
293
          </para>
306
294
        </listitem>
307
295
      </varlistentry>
359
347
          </para>
360
348
        </listitem>
361
349
      </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>
378
350
    </variablelist>
379
351
  </refsect1>
380
352
  
451
423
    </variablelist>
452
424
  </refsect1>
453
425
  
454
 
  <refsect1 id="bugs">
455
 
    <title>BUGS</title>
456
 
    <xi:include href="bugs.xml"/>
457
 
  </refsect1>
 
426
<!--   <refsect1 id="bugs"> -->
 
427
<!--     <title>BUGS</title> -->
 
428
<!--     <para> -->
 
429
<!--     </para> -->
 
430
<!--   </refsect1> -->
458
431
  
459
432
  <refsect1 id="example">
460
433
    <title>EXAMPLE</title>
530
503
      <citerefentry><refentrytitle>mandos</refentrytitle>
531
504
      <manvolnum>8</manvolnum></citerefentry>,
532
505
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
533
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
534
 
      <citerefentry><refentrytitle>ssh-keyscan</refentrytitle>
535
 
      <manvolnum>1</manvolnum></citerefentry>
 
506
      <manvolnum>8mandos</manvolnum></citerefentry>
536
507
    </para>
537
508
  </refsect1>
538
509