/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

merge

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-keygen.xml
158
158
    <cmdsynopsis>
159
159
      <command>&COMMANDNAME;</command>
160
160
      <group choice="req">
 
161
        <arg choice="plain"><option>-p</option></arg>
 
162
        <arg choice="plain"><option>--password</option></arg>
 
163
      </group>
 
164
      <group choice="opt">
 
165
        <arg choice="plain"><option>--dir</option>
 
166
        <replaceable>directory</replaceable></arg>
 
167
      </group>
 
168
      <group choice="opt">
 
169
        <arg choice="plain"><option>--name</option>
 
170
        <replaceable>NAME</replaceable></arg>
 
171
      </group>
 
172
    </cmdsynopsis>
 
173
    <cmdsynopsis>
 
174
      <command>&COMMANDNAME;</command>
 
175
      <group choice="req">
161
176
        <arg choice="plain"><option>-h</option></arg>
162
177
        <arg choice="plain"><option>--help</option></arg>
163
178
      </group>
182
197
      initrd image, but this, like most things, can be changed with
183
198
      command line options.
184
199
    </para>
 
200
    <para>
 
201
      It can also be used to generate ready-made sections for
 
202
      <citerefentry><refentrytitle>mandos-clients.conf</refentrytitle>
 
203
      <manvolnum>5</manvolnum></citerefentry> using the
 
204
      <option>--password</option> option.
 
205
    </para>
185
206
  </refsect1>
186
207
  
187
208
  <refsect1 id="purpose">
214
235
        <replaceable>directory</replaceable></literal></term>
215
236
        <listitem>
216
237
          <para>
217
 
            Target directory for key files.
 
238
            Target directory for key files.  Default is
 
239
            <filename>/etc/mandos</filename>.
218
240
          </para>
219
241
        </listitem>
220
242
      </varlistentry>
234
256
        <replaceable>bits</replaceable></literal></term>
235
257
        <listitem>
236
258
          <para>
237
 
            Key length in bits.  Default is 1024.
 
259
            Key length in bits.  Default is 2048.
238
260
          </para>
239
261
        </listitem>
240
262
      </varlistentry>
301
323
          </para>
302
324
        </listitem>
303
325
      </varlistentry>
 
326
      <varlistentry>
 
327
        <term><literal>-p</literal>, <literal>--password</literal
 
328
        ></term>
 
329
        <listitem>
 
330
          <para>
 
331
            Prompt for a password and encrypt it with the key already
 
332
            present in either <filename>/etc/mandos</filename> or the
 
333
            directory specified with the <option>--dir</option>
 
334
            option.  Outputs, on standard output, a section suitable
 
335
            for inclusion in <citerefentry><refentrytitle
 
336
            >mandos-clients.conf</refentrytitle><manvolnum
 
337
            >8</manvolnum></citerefentry>.  The host name or the name
 
338
            specified with the <option>--name</option> option is used
 
339
            for the section header.  All other options are ignored,
 
340
            and no keys are created.
 
341
          </para>
 
342
        </listitem>
 
343
      </varlistentry>
304
344
    </variablelist>
305
345
  </refsect1>
306
346