/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: 2008-09-30 03:19:39 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080930031939-t72se4dhr632o9ct
* Makefile: Add HTML rules for manual pages.
  (DOCBOOKTOHTML, HTMLPOST): New commands.
  (htmldocs): New file list.
  (html, install-html): New targets.
  (.PHONY, clean): Added "html".

* README (The Plugin System): New section; describe plugin system.

* debian/control (Uploaders): New field.

* mandos-options.xml (servicename): Improve wording.

* plugins.d/mandos-client.xml (SECURITY): Improve wording.

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-31">
 
6
<!ENTITY TIMESTAMP "2008-09-20">
7
7
]>
8
8
 
9
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
34
34
      <holder>Teddy Hogeborn</holder>
35
35
      <holder>Björn Påhlsson</holder>
36
36
    </copyright>
37
 
    <legalnotice>
38
 
      <para>
39
 
        This manual page is free software: you can redistribute it
40
 
        and/or modify it under the terms of the GNU General Public
41
 
        License as published by the Free Software Foundation,
42
 
        either version 3 of the License, or (at your option) any
43
 
        later version.
44
 
      </para>
45
 
 
46
 
      <para>
47
 
        This manual page is distributed in the hope that it will
48
 
        be useful, but WITHOUT ANY WARRANTY; without even the
49
 
        implied warranty of MERCHANTABILITY or FITNESS FOR A
50
 
        PARTICULAR PURPOSE.  See the GNU General Public License
51
 
        for more details.
52
 
      </para>
53
 
 
54
 
      <para>
55
 
        You should have received a copy of the GNU General Public
56
 
        License along with this program; If not, see
57
 
        <ulink url="http://www.gnu.org/licenses/"/>.
58
 
      </para>
59
 
    </legalnotice>
 
37
    <xi:include href="legalnotice.xml"/>
60
38
  </refentryinfo>
61
 
 
 
39
  
62
40
  <refmeta>
63
41
    <refentrytitle>&COMMANDNAME;</refentrytitle>
64
42
    <manvolnum>8</manvolnum>
70
48
      Generate key and password for Mandos client and server.
71
49
    </refpurpose>
72
50
  </refnamediv>
73
 
 
 
51
  
74
52
  <refsynopsisdiv>
75
53
    <cmdsynopsis>
76
54
      <command>&COMMANDNAME;</command>
144
122
      <group choice="req">
145
123
        <arg choice="plain"><option>--password</option></arg>
146
124
        <arg choice="plain"><option>-p</option></arg>
 
125
        <arg choice="plain"><option>--passfile
 
126
        <replaceable>FILE</replaceable></option></arg>
 
127
        <arg choice="plain"><option>-F</option>
 
128
        <replaceable>FILE</replaceable></arg>
147
129
      </group>
148
130
      <sbr/>
149
131
      <group>
181
163
    <para>
182
164
      <command>&COMMANDNAME;</command> is a program to generate the
183
165
      OpenPGP key used by
184
 
      <citerefentry><refentrytitle>password-request</refentrytitle>
 
166
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
185
167
      <manvolnum>8mandos</manvolnum></citerefentry>.  The key is
186
168
      normally written to /etc/mandos for later installation into the
187
169
      initrd image, but this, and most other things, can be changed
189
171
    </para>
190
172
    <para>
191
173
      This program can also be used with the
192
 
      <option>--password</option> option to generate a ready-made
193
 
      section for <filename>clients.conf</filename> (see
 
174
      <option>--password</option> or <option>--passfile</option>
 
175
      options to generate a ready-made section for
 
176
      <filename>clients.conf</filename> (see
194
177
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
195
178
      <manvolnum>5</manvolnum></citerefentry>).
196
179
    </para>
219
202
          </para>
220
203
        </listitem>
221
204
      </varlistentry>
222
 
 
 
205
      
223
206
      <varlistentry>
224
207
        <term><option>--dir
225
208
        <replaceable>DIRECTORY</replaceable></option></term>
232
215
          </para>
233
216
        </listitem>
234
217
      </varlistentry>
235
 
 
 
218
      
236
219
      <varlistentry>
237
220
        <term><option>--type
238
221
        <replaceable>TYPE</replaceable></option></term>
244
227
          </para>
245
228
        </listitem>
246
229
      </varlistentry>
247
 
 
 
230
      
248
231
      <varlistentry>
249
232
        <term><option>--length
250
233
        <replaceable>BITS</replaceable></option></term>
256
239
          </para>
257
240
        </listitem>
258
241
      </varlistentry>
259
 
 
 
242
      
260
243
      <varlistentry>
261
244
        <term><option>--subtype
262
245
        <replaceable>KEYTYPE</replaceable></option></term>
269
252
          </para>
270
253
        </listitem>
271
254
      </varlistentry>
272
 
 
 
255
      
273
256
      <varlistentry>
274
257
        <term><option>--sublength
275
258
        <replaceable>BITS</replaceable></option></term>
281
264
          </para>
282
265
        </listitem>
283
266
      </varlistentry>
284
 
 
 
267
      
285
268
      <varlistentry>
286
269
        <term><option>--email
287
270
        <replaceable>ADDRESS</replaceable></option></term>
293
276
          </para>
294
277
        </listitem>
295
278
      </varlistentry>
296
 
 
 
279
      
297
280
      <varlistentry>
298
281
        <term><option>--comment
299
282
        <replaceable>TEXT</replaceable></option></term>
306
289
          </para>
307
290
        </listitem>
308
291
      </varlistentry>
309
 
 
 
292
      
310
293
      <varlistentry>
311
294
        <term><option>--expire
312
295
        <replaceable>TIME</replaceable></option></term>
320
303
          </para>
321
304
        </listitem>
322
305
      </varlistentry>
323
 
 
 
306
      
324
307
      <varlistentry>
325
308
        <term><option>--force</option></term>
326
309
        <term><option>-f</option></term>
348
331
          </para>
349
332
        </listitem>
350
333
      </varlistentry>
 
334
      <varlistentry>
 
335
        <term><option>--passfile
 
336
        <replaceable>FILE</replaceable></option></term>
 
337
        <term><option>-F
 
338
        <replaceable>FILE</replaceable></option></term>
 
339
        <listitem>
 
340
          <para>
 
341
            The same as <option>--password</option>, but read from
 
342
            <replaceable>FILE</replaceable>, not the terminal.
 
343
          </para>
 
344
        </listitem>
 
345
      </varlistentry>
351
346
    </variablelist>
352
347
  </refsect1>
353
 
 
 
348
  
354
349
  <refsect1 id="overview">
355
350
    <title>OVERVIEW</title>
356
351
    <xi:include href="overview.xml"/>
360
355
      <filename>clients.conf</filename> on the server.
361
356
    </para>
362
357
  </refsect1>
363
 
 
 
358
  
364
359
  <refsect1 id="exit_status">
365
360
    <title>EXIT STATUS</title>
366
361
    <para>
423
418
      </varlistentry>
424
419
    </variablelist>
425
420
  </refsect1>
426
 
 
427
 
  <refsect1 id="bugs">
428
 
    <title>BUGS</title>
429
 
    <para>
430
 
      None are known at this time.
431
 
    </para>
432
 
  </refsect1>
433
 
 
 
421
  
 
422
<!--   <refsect1 id="bugs"> -->
 
423
<!--     <title>BUGS</title> -->
 
424
<!--     <para> -->
 
425
<!--     </para> -->
 
426
<!--   </refsect1> -->
 
427
  
434
428
  <refsect1 id="example">
435
429
    <title>EXAMPLE</title>
436
430
    <informalexample>
477
471
      </para>
478
472
    </informalexample>
479
473
  </refsect1>
480
 
 
 
474
  
481
475
  <refsect1 id="security">
482
476
    <title>SECURITY</title>
483
477
    <para>
492
486
      <manvolnum>8</manvolnum></citerefentry>.
493
487
    </para>
494
488
  </refsect1>
495
 
 
 
489
  
496
490
  <refsect1 id="see_also">
497
491
    <title>SEE ALSO</title>
498
492
    <para>
502
496
      <manvolnum>5</manvolnum></citerefentry>,
503
497
      <citerefentry><refentrytitle>mandos</refentrytitle>
504
498
      <manvolnum>8</manvolnum></citerefentry>,
505
 
      <citerefentry><refentrytitle>password-request</refentrytitle>
 
499
      <citerefentry><refentrytitle>mandos-client</refentrytitle>
506
500
      <manvolnum>8mandos</manvolnum></citerefentry>
507
501
    </para>
508
502
  </refsect1>