/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 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
1
 
<?xml version="1.0" encoding="UTF-8"?>
 
1
<?xml version='1.0' encoding='UTF-8'?>
 
2
<?xml-stylesheet type="text/xsl"
 
3
        href="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"?>
2
4
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
5
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
6
<!ENTITY VERSION "1.0">
5
7
<!ENTITY COMMANDNAME "plugin-runner">
6
 
<!ENTITY TIMESTAMP "2008-08-31">
 
8
<!ENTITY TIMESTAMP "2008-08-30">
7
9
]>
8
10
 
9
 
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
 
11
<refentry>
10
12
  <refentryinfo>
11
13
    <title>Mandos Manual</title>
12
 
    <!-- Nwalsh’s docbook scripts use this to generate the footer: -->
 
14
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
13
15
    <productname>Mandos</productname>
14
16
    <productnumber>&VERSION;</productnumber>
15
17
    <date>&TIMESTAMP;</date>
31
33
    </authorgroup>
32
34
    <copyright>
33
35
      <year>2008</year>
34
 
      <holder>Teddy Hogeborn</holder>
35
 
      <holder>Björn Påhlsson</holder>
 
36
      <holder>Teddy Hogeborn &amp; Björn Påhlsson</holder>
36
37
    </copyright>
37
 
    <xi:include href="legalnotice.xml"/>
 
38
    <legalnotice>
 
39
      <para>
 
40
        This manual page is free software: you can redistribute it
 
41
        and/or modify it under the terms of the GNU General Public
 
42
        License as published by the Free Software Foundation,
 
43
        either version 3 of the License, or (at your option) any
 
44
        later version.
 
45
      </para>
 
46
 
 
47
      <para>
 
48
        This manual page is distributed in the hope that it will
 
49
        be useful, but WITHOUT ANY WARRANTY; without even the
 
50
        implied warranty of MERCHANTABILITY or FITNESS FOR A
 
51
        PARTICULAR PURPOSE.  See the GNU General Public License
 
52
        for more details.
 
53
      </para>
 
54
 
 
55
      <para>
 
56
        You should have received a copy of the GNU General Public
 
57
        License along with this program; If not, see
 
58
        <ulink url="http://www.gnu.org/licenses/"/>.
 
59
      </para>
 
60
    </legalnotice>
38
61
  </refentryinfo>
39
62
 
40
63
  <refmeta>
109
132
    <cmdsynopsis>
110
133
      <command>&COMMANDNAME;</command>
111
134
      <group choice="req">
112
 
        <arg choice="plain"><option>--help</option></arg>
113
 
        <arg choice="plain"><option>-?</option></arg>
 
135
        <arg choice='plain'><option>--help</option></arg>
 
136
        <arg choice='plain'><option>-?</option></arg>
114
137
      </group>
115
138
    </cmdsynopsis>
116
139
    <cmdsynopsis>
117
140
      <command>&COMMANDNAME;</command>
118
 
      <arg choice="plain"><option>--usage</option></arg>
 
141
      <arg choice='plain'><option>--usage</option></arg>
119
142
    </cmdsynopsis>
120
143
    <cmdsynopsis>
121
144
      <command>&COMMANDNAME;</command>
122
145
      <group choice="req">
123
 
        <arg choice="plain"><option>--version</option></arg>
124
 
        <arg choice="plain"><option>-V</option></arg>
 
146
        <arg choice='plain'><option>--version</option></arg>
 
147
        <arg choice='plain'><option>-V</option></arg>
125
148
      </group>
126
149
    </cmdsynopsis>
127
150
  </refsynopsisdiv>
149
172
    <title>OPTIONS</title>
150
173
    <variablelist>
151
174
      <varlistentry>
152
 
        <term><option>--global-options
153
 
        <replaceable>OPTIONS</replaceable></option></term>
154
 
        <term><option>-g
155
 
        <replaceable>OPTIONS</replaceable></option></term>
 
175
        <term><literal>-g</literal>,<literal>--global-options
 
176
        <replaceable>OPTIONS</replaceable></literal></term>
156
177
        <listitem>
157
178
          <para>
158
179
            Global options given to all plugins as additional start
163
184
      </varlistentry>
164
185
 
165
186
      <varlistentry>
166
 
        <term><option>--options-for
167
 
        <replaceable>PLUGIN</replaceable><literal>:</literal
168
 
        ><replaceable>OPTION</replaceable></option></term>
169
 
        <term><option>-o
170
 
        <replaceable>PLUGIN</replaceable><literal>:</literal
171
 
        ><replaceable>OPTION</replaceable></option></term>
 
187
        <term><literal>-o</literal>,<literal> --options-for
 
188
        <replaceable>PLUGIN</replaceable>:<replaceable>OPTION</replaceable>
 
189
        </literal></term>
172
190
        <listitem>
173
191
          <para>
174
192
            Plugin specific options given to the plugin as additional
179
197
      </varlistentry>
180
198
 
181
199
      <varlistentry>
182
 
        <term><option> --disable
183
 
        <replaceable>PLUGIN</replaceable></option></term>
184
 
        <term><option>-d
185
 
        <replaceable>PLUGIN</replaceable></option></term>
 
200
        <term><literal>-d</literal>,<literal> --disable
 
201
        <replaceable>PLUGIN</replaceable>
 
202
        </literal></term>
186
203
        <listitem>
187
204
          <para>
188
205
            Disable a specific plugin
191
208
      </varlistentry>
192
209
 
193
210
      <varlistentry>
194
 
        <term><option>--groupid
195
 
        <replaceable>ID</replaceable></option></term>
 
211
        <term><literal>--groupid <replaceable>ID</replaceable>
 
212
        </literal></term>
196
213
        <listitem>
197
214
          <para>
198
215
            Group ID the plugins will run as
201
218
      </varlistentry>
202
219
 
203
220
      <varlistentry>
204
 
        <term><option>--userid
205
 
        <replaceable>ID</replaceable></option></term>
 
221
        <term><literal>--userid <replaceable>ID</replaceable>
 
222
        </literal></term>
206
223
        <listitem>
207
224
          <para>
208
225
            User ID the plugins will run as
211
228
      </varlistentry>
212
229
 
213
230
      <varlistentry>
214
 
        <term><option>--plugin-dir
215
 
        <replaceable>DIRECTORY</replaceable></option></term>
 
231
        <term><literal>--plugin-dir <replaceable>DIRECTORY</replaceable>
 
232
        </literal></term>
216
233
        <listitem>
217
234
          <para>
218
235
            Specify a different plugin directory
221
238
      </varlistentry>
222
239
      
223
240
      <varlistentry>
224
 
        <term><option>--debug</option></term>
 
241
        <term><literal>--debug</literal></term>
225
242
        <listitem>
226
243
          <para>
227
244
            Debug mode
230
247
      </varlistentry>
231
248
      
232
249
      <varlistentry>
233
 
        <term><option>--help</option></term>
234
 
        <term><option>-?</option></term>
 
250
        <term><literal>-?</literal>, <literal>--help</literal></term>
235
251
        <listitem>
236
252
          <para>
237
253
            Gives a help message
240
256
      </varlistentry>
241
257
      
242
258
      <varlistentry>
243
 
        <term><option>--usage</option></term>
 
259
        <term><literal>--usage</literal></term>
244
260
        <listitem>
245
261
          <para>
246
262
            Gives a short usage message
249
265
      </varlistentry>
250
266
 
251
267
      <varlistentry>
252
 
        <term><option>--version</option></term>
253
 
        <term><option>-V</option></term>
 
268
        <term><literal>-V</literal>, <literal>--version</literal></term>
254
269
        <listitem>
255
270
          <para>
256
271
            Prints the program version