/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 plugins.d/password-request.xml

  • Committer: Teddy Hogeborn
  • Date: 2008-09-03 05:04:40 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080903050440-7cwzxestx6pvdy1i
* Makefile (mandos.8): Add dependency on "overview.xml" and
                       "legalnotice.xml".
  (mandos-keygen.8): New target.
  (mandos-conf.5): Added dependency on "legalnotice.xml".
  (plugin-runner.8mandos): New target
  (plugins.d/password-request.8mandos): - '' -

* mandos-options.xml (priority): Make wording server/client neutral.

* plugins.d/password-request.c (main): Changed .arg fields of the argp
                                       options struct to be more
                                       consistent with the manual.

* plugins.d/password-request.xml (OVERVIEW): Moved to after "OPTIONS".
  (OPTIONS): Improved wording and names of replaceables.

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugins.d/password-request.xml
3
3
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
4
<!ENTITY VERSION "1.0">
5
5
<!ENTITY COMMANDNAME "password-request">
6
 
<!ENTITY TIMESTAMP "2008-09-02">
 
6
<!ENTITY TIMESTAMP "2008-09-03">
7
7
]>
8
8
 
9
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
137
137
      This program is not meant to be run directly; it is really meant
138
138
      to run as a plugin of the <application>Mandos</application>
139
139
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
140
 
      <manvolnum>8mandos</manvolnum></citerefentry>, which in turn
141
 
      runs as a <quote>keyscript</quote> specified in the
142
 
      <citerefentry><refentrytitle>crypttab</refentrytitle>
143
 
      <manvolnum>5</manvolnum></citerefentry> file.
 
140
      <manvolnum>8mandos</manvolnum></citerefentry>, which runs in the
 
141
      initial <acronym>RAM</acronym> disk environment because it is
 
142
      specified as a <quote>keyscript</quote> in the <citerefentry>
 
143
      <refentrytitle>crypttab</refentrytitle><manvolnum>5</manvolnum>
 
144
      </citerefentry> file.
144
145
    </para>
145
146
  </refsect1>
146
147
  
154
155
    </para>
155
156
  </refsect1>
156
157
  
157
 
  <refsect1 id="overview">
158
 
    <title>OVERVIEW</title>
159
 
    <xi:include href="overview.xml"/>
160
 
    <para>
161
 
      This program is the client part.  It is a plugin started by
162
 
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
163
 
      <manvolnum>8mandos</manvolnum></citerefentry> which will run in
164
 
      an initial <acronym>RAM</acronym> disk environment.
165
 
    </para>
166
 
    <para>
167
 
      This program could, theoretically, be used as a keyscript in
168
 
      <filename>/etc/crypttab</filename>, but it would then be
169
 
      impossible to enter the encrypted root disk password at the
170
 
      console, since this program does not read from the console at
171
 
      all.  This is why a separate plugin does that, which will be run
172
 
      in parallell to this one.
173
 
    </para>
174
 
  </refsect1>
175
 
  
176
158
  <refsect1 id="options">
177
159
    <title>OPTIONS</title>
178
160
    <para>
188
170
    <variablelist>
189
171
      <varlistentry>
190
172
        <term><option>--connect=<replaceable
191
 
        >IPADDR</replaceable><literal>:</literal><replaceable
 
173
        >ADDRESS</replaceable><literal>:</literal><replaceable
192
174
        >PORT</replaceable></option></term>
193
175
        <term><option>-c
194
 
        <replaceable>IPADDR</replaceable><literal>:</literal
 
176
        <replaceable>ADDRESS</replaceable><literal>:</literal
195
177
        ><replaceable>PORT</replaceable></option></term>
196
178
        <listitem>
197
179
          <para>
202
184
            assumed to separate the address from the port number.
203
185
          </para>
204
186
          <para>
205
 
            This option is normally only useful for debugging.
 
187
            This option is normally only useful for testing and
 
188
            debugging.
206
189
          </para>
207
190
        </listitem>
208
191
      </varlistentry>
244
227
        <replaceable>FILE</replaceable></option></term>
245
228
        <listitem>
246
229
          <para>
247
 
            OpenPGP public key file name.  This will be combined with
248
 
            the directory from the <option>--keydir</option> option to
249
 
            form an absolute file name.  The default name is
 
230
            OpenPGP public key file base name.  This will be combined
 
231
            with the directory from the <option>--keydir</option>
 
232
            option to form an absolute file name.  The default name is
250
233
            <quote><literal>pubkey.txt</literal></quote>.
251
234
          </para>
252
235
        </listitem>
259
242
        <replaceable>FILE</replaceable></option></term>
260
243
        <listitem>
261
244
          <para>
262
 
            OpenPGP secret key file name.  This will be combined with
263
 
            the directory from the <option>--keydir</option> option to
264
 
            form an absolute file name.  The default name is
 
245
            OpenPGP secret key file base name.  This will be combined
 
246
            with the directory from the <option>--keydir</option>
 
247
            option to form an absolute file name.  The default name is
265
248
            <quote><literal>seckey.txt</literal></quote>.
266
249
          </para>
267
250
        </listitem>
271
254
        <term><option>--priority=<replaceable
272
255
        >STRING</replaceable></option></term>
273
256
        <listitem>
274
 
          <xi:include href="mandos-options.xml" xpointer="priority"/>
 
257
          <xi:include href="../mandos-options.xml"
 
258
                      xpointer="priority"/>
275
259
        </listitem>
276
260
      </varlistentry>
277
261
 
333
317
    </variablelist>
334
318
  </refsect1>
335
319
 
 
320
  <refsect1 id="overview">
 
321
    <title>OVERVIEW</title>
 
322
    <xi:include href="../overview.xml"/>
 
323
    <para>
 
324
      This program is the client part.  It is a plugin started by
 
325
      <citerefentry><refentrytitle>plugin-runner</refentrytitle>
 
326
      <manvolnum>8mandos</manvolnum></citerefentry> which will run in
 
327
      an initial <acronym>RAM</acronym> disk environment.
 
328
    </para>
 
329
    <para>
 
330
      This program could, theoretically, be used as a keyscript in
 
331
      <filename>/etc/crypttab</filename>, but it would then be
 
332
      impossible to enter the encrypted root disk password at the
 
333
      console, since this program does not read from the console at
 
334
      all.  This is why a separate plugin does that, which will be run
 
335
      in parallell to this one.
 
336
    </para>
 
337
  </refsect1>
 
338
  
336
339
  <refsect1 id="exit_status">
337
340
    <title>EXIT STATUS</title>
338
341
    <para>
346
349
    </para>
347
350
  </refsect1>
348
351
  
349
 
<!--   <refsect1 id="environment"> -->
350
 
<!--     <title>ENVIRONMENT</title> -->
351
 
<!--     <para> -->
352
 
<!--       This program does not use any environment variables. -->
353
 
<!--     </para> -->
354
 
<!--   </refsect1> -->
 
352
  <refsect1 id="environment">
 
353
    <title>ENVIRONMENT</title>
 
354
    <para>
 
355
      This program does not use any environment variables, not even
 
356
      the ones provided by <citerefentry><refentrytitle
 
357
      >cryptsetup</refentrytitle><manvolnum>8</manvolnum>
 
358
    </citerefentry>.
 
359
    </para>
 
360
  </refsect1>
355
361
  
356
362
  <refsect1 id="file">
357
363
    <title>FILES</title>
403
409
      
404
410
      <listitem><para>
405
411
        <ulink
406
 
        url="http://www.gnupg.org/related_software/gpgme/">
407
 
        GPGME</ulink>
 
412
        url="http://www.gnupg.org/related_software/gpgme/"
 
413
        >GPGME</ulink>
408
414
      </para></listitem>
409
415
      
410
416
      <listitem><para>