/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

merge

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