/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 plugin-runner.xml

  • Committer: Teddy Hogeborn
  • Date: 2008-08-31 08:47:38 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080831084738-uu70kayyt876982d
* mandos-keygen: Minor help text change.

* mandos-keygen.xml: Changed plural "keys" to singular "key"
                     throughout.
  (NAME): Improved wording.
  (DESCRIPTION): Improved wording.
  (OPTIONS): Split options in <term> tags into separate <term> tags.
             Use <option> tags.  Move long options before short
             options.  Uppercase replaceables.
  (OVERVIEW): Improved wording.
  (EXIT STATUS): Also cover --password option.
  (EXAMPLE): Add two examples using the --password option.
  (SECURITY): Improved wording.

* overview.xml: Improved wording.

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugin-runner.xml
5
5
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
6
6
<!ENTITY VERSION "1.0">
7
7
<!ENTITY COMMANDNAME "plugin-runner">
8
 
<!ENTITY TIMESTAMP "2008-08-31">
 
8
<!ENTITY TIMESTAMP "2008-08-30">
9
9
]>
10
10
 
11
11
<refentry>
172
172
    <title>OPTIONS</title>
173
173
    <variablelist>
174
174
      <varlistentry>
175
 
        <term><option>--global-options
176
 
        <replaceable>OPTIONS</replaceable></option></term>
177
 
        <term><option>-g
178
 
        <replaceable>OPTIONS</replaceable></option></term>
 
175
        <term><literal>-g</literal>,<literal>--global-options
 
176
        <replaceable>OPTIONS</replaceable></literal></term>
179
177
        <listitem>
180
178
          <para>
181
179
            Global options given to all plugins as additional start
186
184
      </varlistentry>
187
185
 
188
186
      <varlistentry>
189
 
        <term><option>--options-for
190
 
        <replaceable>PLUGIN</replaceable><literal>:</literal
191
 
        ><replaceable>OPTION</replaceable></option></term>
192
 
        <term><option>-o
193
 
        <replaceable>PLUGIN</replaceable><literal>:</literal
194
 
        ><replaceable>OPTION</replaceable></option></term>
 
187
        <term><literal>-o</literal>,<literal> --options-for
 
188
        <replaceable>PLUGIN</replaceable>:<replaceable>OPTION</replaceable>
 
189
        </literal></term>
195
190
        <listitem>
196
191
          <para>
197
192
            Plugin specific options given to the plugin as additional
202
197
      </varlistentry>
203
198
 
204
199
      <varlistentry>
205
 
        <term><option> --disable
206
 
        <replaceable>PLUGIN</replaceable></option></term>
207
 
        <term><option>-d
208
 
        <replaceable>PLUGIN</replaceable></option></term>
 
200
        <term><literal>-d</literal>,<literal> --disable
 
201
        <replaceable>PLUGIN</replaceable>
 
202
        </literal></term>
209
203
        <listitem>
210
204
          <para>
211
205
            Disable a specific plugin
214
208
      </varlistentry>
215
209
 
216
210
      <varlistentry>
217
 
        <term><option>--groupid
218
 
        <replaceable>ID</replaceable></option></term>
 
211
        <term><literal>--groupid <replaceable>ID</replaceable>
 
212
        </literal></term>
219
213
        <listitem>
220
214
          <para>
221
215
            Group ID the plugins will run as
224
218
      </varlistentry>
225
219
 
226
220
      <varlistentry>
227
 
        <term><option>--userid
228
 
        <replaceable>ID</replaceable></option></term>
 
221
        <term><literal>--userid <replaceable>ID</replaceable>
 
222
        </literal></term>
229
223
        <listitem>
230
224
          <para>
231
225
            User ID the plugins will run as
234
228
      </varlistentry>
235
229
 
236
230
      <varlistentry>
237
 
        <term><option>--plugin-dir
238
 
        <replaceable>DIRECTORY</replaceable></option></term>
 
231
        <term><literal>--plugin-dir <replaceable>DIRECTORY</replaceable>
 
232
        </literal></term>
239
233
        <listitem>
240
234
          <para>
241
235
            Specify a different plugin directory
244
238
      </varlistentry>
245
239
      
246
240
      <varlistentry>
247
 
        <term><option>--debug</option></term>
 
241
        <term><literal>--debug</literal></term>
248
242
        <listitem>
249
243
          <para>
250
244
            Debug mode
253
247
      </varlistentry>
254
248
      
255
249
      <varlistentry>
256
 
        <term><option>--help</option></term>
257
 
        <term><option>-?</option></term>
 
250
        <term><literal>-?</literal>, <literal>--help</literal></term>
258
251
        <listitem>
259
252
          <para>
260
253
            Gives a help message
263
256
      </varlistentry>
264
257
      
265
258
      <varlistentry>
266
 
        <term><option>--usage</option></term>
 
259
        <term><literal>--usage</literal></term>
267
260
        <listitem>
268
261
          <para>
269
262
            Gives a short usage message
272
265
      </varlistentry>
273
266
 
274
267
      <varlistentry>
275
 
        <term><option>--version</option></term>
276
 
        <term><option>-V</option></term>
 
268
        <term><literal>-V</literal>, <literal>--version</literal></term>
277
269
        <listitem>
278
270
          <para>
279
271
            Prints the program version