/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 at bsnet
  • Date: 2011-12-23 18:59:19 UTC
  • mto: This revision was merged to the branch mainline in revision 529.
  • Revision ID: teddy@fukt.bsnet.se-20111223185919-ix5d1018ozhsdd87
* mandos (main/cleanup): Write new file, then rename.  Use
                         tempfile.mkstemp().

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-keygen.xml
1
1
<?xml version="1.0" encoding="UTF-8"?>
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
 
<!ENTITY VERSION "1.0">
5
4
<!ENTITY COMMANDNAME "mandos-keygen">
6
 
<!ENTITY TIMESTAMP "2008-09-12">
 
5
<!ENTITY TIMESTAMP "2011-10-03">
 
6
<!ENTITY % common SYSTEM "common.ent">
 
7
%common;
7
8
]>
8
9
 
9
10
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
12
    <title>Mandos Manual</title>
12
13
    <!-- NWalsh’s docbook scripts use this to generate the footer: -->
13
14
    <productname>Mandos</productname>
14
 
    <productnumber>&VERSION;</productnumber>
 
15
    <productnumber>&version;</productnumber>
15
16
    <date>&TIMESTAMP;</date>
16
17
    <authorgroup>
17
18
      <author>
18
19
        <firstname>Björn</firstname>
19
20
        <surname>Påhlsson</surname>
20
21
        <address>
21
 
          <email>belorn@fukt.bsnet.se</email>
 
22
          <email>belorn@recompile.se</email>
22
23
        </address>
23
24
      </author>
24
25
      <author>
25
26
        <firstname>Teddy</firstname>
26
27
        <surname>Hogeborn</surname>
27
28
        <address>
28
 
          <email>teddy@fukt.bsnet.se</email>
 
29
          <email>teddy@recompile.se</email>
29
30
        </address>
30
31
      </author>
31
32
    </authorgroup>
32
33
    <copyright>
33
34
      <year>2008</year>
 
35
      <year>2009</year>
 
36
      <year>2011</year>
34
37
      <holder>Teddy Hogeborn</holder>
35
38
      <holder>Björn Påhlsson</holder>
36
39
    </copyright>
122
125
      <group choice="req">
123
126
        <arg choice="plain"><option>--password</option></arg>
124
127
        <arg choice="plain"><option>-p</option></arg>
 
128
        <arg choice="plain"><option>--passfile
 
129
        <replaceable>FILE</replaceable></option></arg>
 
130
        <arg choice="plain"><option>-F</option>
 
131
        <replaceable>FILE</replaceable></arg>
125
132
      </group>
126
133
      <sbr/>
127
134
      <group>
167
174
    </para>
168
175
    <para>
169
176
      This program can also be used with the
170
 
      <option>--password</option> option to generate a ready-made
171
 
      section for <filename>clients.conf</filename> (see
 
177
      <option>--password</option> or <option>--passfile</option>
 
178
      options to generate a ready-made section for
 
179
      <filename>clients.conf</filename> (see
172
180
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
173
181
      <manvolnum>5</manvolnum></citerefentry>).
174
182
    </para>
206
214
        <listitem>
207
215
          <para>
208
216
            Target directory for key files.  Default is
209
 
            <filename>/etc/mandos</filename>.
 
217
            <filename class="directory">/etc/mandos</filename>.
210
218
          </para>
211
219
        </listitem>
212
220
      </varlistentry>
326
334
          </para>
327
335
        </listitem>
328
336
      </varlistentry>
 
337
      <varlistentry>
 
338
        <term><option>--passfile
 
339
        <replaceable>FILE</replaceable></option></term>
 
340
        <term><option>-F
 
341
        <replaceable>FILE</replaceable></option></term>
 
342
        <listitem>
 
343
          <para>
 
344
            The same as <option>--password</option>, but read from
 
345
            <replaceable>FILE</replaceable>, not the terminal.
 
346
          </para>
 
347
        </listitem>
 
348
      </varlistentry>
329
349
    </variablelist>
330
350
  </refsect1>
331
351
  
364
384
    </variablelist>
365
385
  </refsect1>
366
386
  
367
 
  <refsect1 id="file">
 
387
  <refsect1 id="files">
368
388
    <title>FILES</title>
369
389
    <para>
370
390
      Use the <option>--dir</option> option to change where
391
411
        </listitem>
392
412
      </varlistentry>
393
413
      <varlistentry>
394
 
        <term><filename>/tmp</filename></term>
 
414
        <term><filename class="directory">/tmp</filename></term>
395
415
        <listitem>
396
416
          <para>
397
417
            Temporary files will be written here if
432
452
    </informalexample>
433
453
    <informalexample>
434
454
      <para>
435
 
        Prompt for a password, encrypt it with the key in
436
 
        <filename>/etc/mandos</filename> and output a section suitable
437
 
        for <filename>clients.conf</filename>.
 
455
        Prompt for a password, encrypt it with the key in <filename
 
456
        class="directory">/etc/mandos</filename> and output a section
 
457
        suitable for <filename>clients.conf</filename>.
438
458
      </para>
439
459
      <para>
440
460
        <userinput>&COMMANDNAME; --password</userinput>
473
493
  <refsect1 id="see_also">
474
494
    <title>SEE ALSO</title>
475
495
    <para>
 
496
      <citerefentry><refentrytitle>intro</refentrytitle>
 
497
      <manvolnum>8mandos</manvolnum></citerefentry>,
476
498
      <citerefentry><refentrytitle>gpg</refentrytitle>
477
499
      <manvolnum>1</manvolnum></citerefentry>,
478
500
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>