/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: 2008-08-30 19:49:24 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080830194924-f4liqq8wxajlbshn
* plugin-runner.xml (NAME): Improved wording.
  (SYNOPSIS): Use <option> and <replaceable> tags.  Unify short and
              long options.  Add "--global-envs" and "--envs-for"
              options.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-keygen.xml
3
3
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
4
<!ENTITY VERSION "1.0">
5
5
<!ENTITY COMMANDNAME "mandos-keygen">
 
6
<!ENTITY TIMESTAMP "2008-08-30">
6
7
]>
7
8
 
8
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
9
10
  <refentryinfo>
10
 
    <title>&COMMANDNAME;</title>
 
11
    <title>Mandos Manual</title>
11
12
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
12
 
    <productname>&COMMANDNAME;</productname>
 
13
    <productname>Mandos</productname>
13
14
    <productnumber>&VERSION;</productnumber>
 
15
    <date>&TIMESTAMP;</date>
14
16
    <authorgroup>
15
17
      <author>
16
18
        <firstname>Björn</firstname>
73
75
  <refsynopsisdiv>
74
76
    <cmdsynopsis>
75
77
      <command>&COMMANDNAME;</command>
76
 
      <group choice="opt">
77
 
        <arg choice="plain"><option>--dir</option>
78
 
        <replaceable>directory</replaceable></arg>
79
 
      </group>
80
 
      <group choice="opt">
81
 
        <arg choice="plain"><option>--type</option>
82
 
        <replaceable>type</replaceable></arg>
83
 
      </group>
84
 
      <group choice="opt">
85
 
        <arg choice="plain"><option>--length</option>
86
 
        <replaceable>bits</replaceable></arg>
87
 
      </group>
88
 
      <group choice="opt">
89
 
        <arg choice="plain"><option>--subtype</option>
90
 
        <replaceable>type</replaceable></arg>
91
 
      </group>
92
 
      <group choice="opt">
93
 
        <arg choice="plain"><option>--sublength</option>
94
 
        <replaceable>bits</replaceable></arg>
95
 
      </group>
96
 
      <group choice="opt">
97
 
        <arg choice="plain"><option>--name</option>
98
 
        <replaceable>NAME</replaceable></arg>
99
 
      </group>
100
 
      <group choice="opt">
101
 
        <arg choice="plain"><option>--email</option>
102
 
        <replaceable>EMAIL</replaceable></arg>
103
 
      </group>
104
 
      <group choice="opt">
105
 
        <arg choice="plain"><option>--comment</option>
106
 
        <replaceable>COMMENT</replaceable></arg>
107
 
      </group>
108
 
      <group choice="opt">
109
 
        <arg choice="plain"><option>--expire</option>
110
 
        <replaceable>TIME</replaceable></arg>
111
 
      </group>
112
 
      <group choice="opt">
113
 
        <arg choice="plain"><option>--force</option></arg>
114
 
      </group>
 
78
      <group>
 
79
        <arg choice="plain"><option>--dir
 
80
        <replaceable>DIRECTORY</replaceable></option></arg>
 
81
        <arg choice="plain"><option>-d
 
82
        <replaceable>DIRECTORY</replaceable></option></arg>
 
83
      </group>
 
84
      <sbr/>
 
85
      <group>
 
86
        <arg choice="plain"><option>--type
 
87
        <replaceable>KEYTYPE</replaceable></option></arg>
 
88
        <arg choice="plain"><option>-t
 
89
        <replaceable>KEYTYPE</replaceable></option></arg>
 
90
      </group>
 
91
      <sbr/>
 
92
      <group>
 
93
        <arg choice="plain"><option>--length
 
94
        <replaceable>BITS</replaceable></option></arg>
 
95
        <arg choice="plain"><option>-l
 
96
        <replaceable>BITS</replaceable></option></arg>
 
97
      </group>
 
98
      <sbr/>
 
99
      <group>
 
100
        <arg choice="plain"><option>--subtype
 
101
        <replaceable>KEYTYPE</replaceable></option></arg>
 
102
        <arg choice="plain"><option>-s
 
103
        <replaceable>KEYTYPE</replaceable></option></arg>
 
104
      </group>
 
105
      <sbr/>
 
106
      <group>
 
107
        <arg choice="plain"><option>--sublength
 
108
        <replaceable>BITS</replaceable></option></arg>
 
109
        <arg choice="plain"><option>-L
 
110
        <replaceable>BITS</replaceable></option></arg>
 
111
      </group>
 
112
      <sbr/>
 
113
      <group>
 
114
        <arg choice="plain"><option>--name
 
115
        <replaceable>NAME</replaceable></option></arg>
 
116
        <arg choice="plain"><option>-n
 
117
        <replaceable>NAME</replaceable></option></arg>
 
118
      </group>
 
119
      <sbr/>
 
120
      <group>
 
121
        <arg choice="plain"><option>--email
 
122
        <replaceable>ADDRESS</replaceable></option></arg>
 
123
        <arg choice="plain"><option>-e
 
124
        <replaceable>ADDRESS</replaceable></option></arg>
 
125
      </group>
 
126
      <sbr/>
 
127
      <group>
 
128
        <arg choice="plain"><option>--comment
 
129
        <replaceable>TEXT</replaceable></option></arg>
 
130
        <arg choice="plain"><option>-c
 
131
        <replaceable>TEXT</replaceable></option></arg>
 
132
      </group>
 
133
      <sbr/>
 
134
      <group>
 
135
        <arg choice="plain"><option>--expire
 
136
        <replaceable>TIME</replaceable></option></arg>
 
137
        <arg choice="plain"><option>-x
 
138
        <replaceable>TIME</replaceable></option></arg>
 
139
      </group>
 
140
      <sbr/>
 
141
      <arg><option>--force</option></arg>
115
142
    </cmdsynopsis>
116
143
    <cmdsynopsis>
117
144
      <command>&COMMANDNAME;</command>
118
 
      <group choice="opt">
119
 
        <arg choice="plain"><option>-d</option>
120
 
        <replaceable>directory</replaceable></arg>
121
 
      </group>
122
 
      <group choice="opt">
123
 
        <arg choice="plain"><option>-t</option>
124
 
        <replaceable>type</replaceable></arg>
125
 
      </group>
126
 
      <group choice="opt">
127
 
        <arg choice="plain"><option>-l</option>
128
 
        <replaceable>bits</replaceable></arg>
129
 
      </group>
130
 
      <group choice="opt">
131
 
        <arg choice="plain"><option>-s</option>
132
 
        <replaceable>type</replaceable></arg>
133
 
      </group>
134
 
      <group choice="opt">
135
 
        <arg choice="plain"><option>-L</option>
136
 
        <replaceable>bits</replaceable></arg>
137
 
      </group>
138
 
      <group choice="opt">
139
 
        <arg choice="plain"><option>-n</option>
140
 
        <replaceable>NAME</replaceable></arg>
141
 
      </group>
142
 
      <group choice="opt">
143
 
        <arg choice="plain"><option>-e</option>
144
 
        <replaceable>EMAIL</replaceable></arg>
145
 
      </group>
146
 
      <group choice="opt">
147
 
        <arg choice="plain"><option>-c</option>
148
 
        <replaceable>COMMENT</replaceable></arg>
149
 
      </group>
150
 
      <group choice="opt">
151
 
        <arg choice="plain"><option>-x</option>
152
 
        <replaceable>TIME</replaceable></arg>
153
 
      </group>
154
 
      <group choice="opt">
155
 
        <arg choice="plain"><option>-f</option></arg>
 
145
      <group choice="req">
 
146
        <arg choice="plain"><option>-p</option></arg>
 
147
        <arg choice="plain"><option>--password</option></arg>
 
148
      </group>
 
149
      <sbr/>
 
150
      <group>
 
151
        <arg choice="plain"><option>--dir
 
152
        <replaceable>DIRECTORY</replaceable></option></arg>
 
153
        <arg choice="plain"><option>-d
 
154
        <replaceable>DIRECTORY</replaceable></option></arg>
 
155
      </group>
 
156
      <sbr/>
 
157
      <group>
 
158
        <arg choice="plain"><option>--name
 
159
        <replaceable>NAME</replaceable></option></arg>
 
160
        <arg choice="plain"><option>-n
 
161
        <replaceable>NAME</replaceable></option></arg>
156
162
      </group>
157
163
    </cmdsynopsis>
158
164
    <cmdsynopsis>
182
188
      initrd image, but this, like most things, can be changed with
183
189
      command line options.
184
190
    </para>
 
191
    <para>
 
192
      It can also be used to generate ready-made sections for
 
193
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
194
      <manvolnum>5</manvolnum></citerefentry> using the
 
195
      <option>--password</option> option.
 
196
    </para>
185
197
  </refsect1>
186
198
  
187
199
  <refsect1 id="purpose">
214
226
        <replaceable>directory</replaceable></literal></term>
215
227
        <listitem>
216
228
          <para>
217
 
            Target directory for key files.
 
229
            Target directory for key files.  Default is
 
230
            <filename>/etc/mandos</filename>.
218
231
          </para>
219
232
        </listitem>
220
233
      </varlistentry>
234
247
        <replaceable>bits</replaceable></literal></term>
235
248
        <listitem>
236
249
          <para>
237
 
            Key length in bits.  Default is 1024.
 
250
            Key length in bits.  Default is 2048.
238
251
          </para>
239
252
        </listitem>
240
253
      </varlistentry>
301
314
          </para>
302
315
        </listitem>
303
316
      </varlistentry>
 
317
      <varlistentry>
 
318
        <term><literal>-p</literal>, <literal>--password</literal
 
319
        ></term>
 
320
        <listitem>
 
321
          <para>
 
322
            Prompt for a password and encrypt it with the key already
 
323
            present in either <filename>/etc/mandos</filename> or the
 
324
            directory specified with the <option>--dir</option>
 
325
            option.  Outputs, on standard output, a section suitable
 
326
            for inclusion in <citerefentry><refentrytitle
 
327
            >mandos-clients.conf</refentrytitle><manvolnum
 
328
            >8</manvolnum></citerefentry>.  The host name or the name
 
329
            specified with the <option>--name</option> option is used
 
330
            for the section header.  All other options are ignored,
 
331
            and no keys are created.
 
332
          </para>
 
333
        </listitem>
 
334
      </varlistentry>
304
335
    </variablelist>
305
336
  </refsect1>
306
337
 
325
356
    <title>ENVIRONMENT</title>
326
357
    <variablelist>
327
358
      <varlistentry>
328
 
        <term><varname>TMPDIR</varname></term>
 
359
        <term><envar>TMPDIR</envar></term>
329
360
        <listitem>
330
361
          <para>
331
362
            If set, temporary files will be created here. See
389
420
        Normal invocation needs no options:
390
421
      </para>
391
422
      <para>
392
 
        <userinput>mandos-keygen</userinput>
 
423
        <userinput>&COMMANDNAME;</userinput>
393
424
      </para>
394
425
    </informalexample>
395
426
    <informalexample>
400
431
      <para>
401
432
 
402
433
<!-- do not wrap this line -->
403
 
<userinput>mandos-keygen --dir ~/keydir --type RSA --force</userinput>
 
434
<userinput>&COMMANDNAME; --dir ~/keydir --type RSA --force</userinput>
404
435
 
405
436
      </para>
406
437
    </informalexample>
424
455
  <refsect1 id="see_also">
425
456
    <title>SEE ALSO</title>
426
457
    <para>
427
 
      <citerefentry><refentrytitle>password-request</refentrytitle>
428
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
458
      <citerefentry><refentrytitle>gpg</refentrytitle>
 
459
      <manvolnum>1</manvolnum></citerefentry>,
429
460
      <citerefentry><refentrytitle>mandos</refentrytitle>
430
461
      <manvolnum>8</manvolnum></citerefentry>,
431
 
      <citerefentry><refentrytitle>gpg</refentrytitle>
432
 
      <manvolnum>1</manvolnum></citerefentry>
 
462
      <citerefentry><refentrytitle>password-request</refentrytitle>
 
463
      <manvolnum>8mandos</manvolnum></citerefentry>
433
464
    </para>
434
465
  </refsect1>
435
466
  
436
467
</refentry>
 
468
<!-- Local Variables: -->
 
469
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
470
<!-- time-stamp-end: "[\"']>" -->
 
471
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
472
<!-- End: -->