/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

merge

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugin-runner.xml
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"?>
 
1
<?xml version="1.0" encoding="UTF-8"?>
4
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
5
3
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
6
4
<!ENTITY VERSION "1.0">
7
5
<!ENTITY COMMANDNAME "plugin-runner">
8
 
<!ENTITY TIMESTAMP "2008-08-30">
 
6
<!ENTITY TIMESTAMP "2008-08-31">
9
7
]>
10
8
 
11
 
<refentry>
 
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
12
10
  <refentryinfo>
13
11
    <title>Mandos Manual</title>
14
 
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
 
12
    <!-- Nwalsh’s docbook scripts use this to generate the footer: -->
15
13
    <productname>Mandos</productname>
16
14
    <productnumber>&VERSION;</productnumber>
17
15
    <date>&TIMESTAMP;</date>
33
31
    </authorgroup>
34
32
    <copyright>
35
33
      <year>2008</year>
36
 
      <holder>Teddy Hogeborn &amp; Björn Påhlsson</holder>
 
34
      <holder>Teddy Hogeborn</holder>
 
35
      <holder>Björn Påhlsson</holder>
37
36
    </copyright>
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>
 
37
    <xi:include href="legalnotice.xml"/>
61
38
  </refentryinfo>
62
39
 
63
40
  <refmeta>
132
109
    <cmdsynopsis>
133
110
      <command>&COMMANDNAME;</command>
134
111
      <group choice="req">
135
 
        <arg choice='plain'><option>--help</option></arg>
136
 
        <arg choice='plain'><option>-?</option></arg>
 
112
        <arg choice="plain"><option>--help</option></arg>
 
113
        <arg choice="plain"><option>-?</option></arg>
137
114
      </group>
138
115
    </cmdsynopsis>
139
116
    <cmdsynopsis>
140
117
      <command>&COMMANDNAME;</command>
141
 
      <arg choice='plain'><option>--usage</option></arg>
 
118
      <arg choice="plain"><option>--usage</option></arg>
142
119
    </cmdsynopsis>
143
120
    <cmdsynopsis>
144
121
      <command>&COMMANDNAME;</command>
145
122
      <group choice="req">
146
 
        <arg choice='plain'><option>--version</option></arg>
147
 
        <arg choice='plain'><option>-V</option></arg>
 
123
        <arg choice="plain"><option>--version</option></arg>
 
124
        <arg choice="plain"><option>-V</option></arg>
148
125
      </group>
149
126
    </cmdsynopsis>
150
127
  </refsynopsisdiv>
172
149
    <title>OPTIONS</title>
173
150
    <variablelist>
174
151
      <varlistentry>
175
 
        <term><literal>-g</literal>,<literal>--global-options
176
 
        <replaceable>OPTIONS</replaceable></literal></term>
 
152
        <term><option>--global-options
 
153
        <replaceable>OPTIONS</replaceable></option></term>
 
154
        <term><option>-g
 
155
        <replaceable>OPTIONS</replaceable></option></term>
177
156
        <listitem>
178
157
          <para>
179
158
            Global options given to all plugins as additional start
184
163
      </varlistentry>
185
164
 
186
165
      <varlistentry>
187
 
        <term><literal>-o</literal>,<literal> --options-for
188
 
        <replaceable>PLUGIN</replaceable>:<replaceable>OPTION</replaceable>
189
 
        </literal></term>
 
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>
190
172
        <listitem>
191
173
          <para>
192
174
            Plugin specific options given to the plugin as additional
197
179
      </varlistentry>
198
180
 
199
181
      <varlistentry>
200
 
        <term><literal>-d</literal>,<literal> --disable
201
 
        <replaceable>PLUGIN</replaceable>
202
 
        </literal></term>
 
182
        <term><option> --disable
 
183
        <replaceable>PLUGIN</replaceable></option></term>
 
184
        <term><option>-d
 
185
        <replaceable>PLUGIN</replaceable></option></term>
203
186
        <listitem>
204
187
          <para>
205
188
            Disable a specific plugin
208
191
      </varlistentry>
209
192
 
210
193
      <varlistentry>
211
 
        <term><literal>--groupid <replaceable>ID</replaceable>
212
 
        </literal></term>
 
194
        <term><option>--groupid
 
195
        <replaceable>ID</replaceable></option></term>
213
196
        <listitem>
214
197
          <para>
215
198
            Group ID the plugins will run as
218
201
      </varlistentry>
219
202
 
220
203
      <varlistentry>
221
 
        <term><literal>--userid <replaceable>ID</replaceable>
222
 
        </literal></term>
 
204
        <term><option>--userid
 
205
        <replaceable>ID</replaceable></option></term>
223
206
        <listitem>
224
207
          <para>
225
208
            User ID the plugins will run as
228
211
      </varlistentry>
229
212
 
230
213
      <varlistentry>
231
 
        <term><literal>--plugin-dir <replaceable>DIRECTORY</replaceable>
232
 
        </literal></term>
 
214
        <term><option>--plugin-dir
 
215
        <replaceable>DIRECTORY</replaceable></option></term>
233
216
        <listitem>
234
217
          <para>
235
218
            Specify a different plugin directory
238
221
      </varlistentry>
239
222
      
240
223
      <varlistentry>
241
 
        <term><literal>--debug</literal></term>
 
224
        <term><option>--debug</option></term>
242
225
        <listitem>
243
226
          <para>
244
227
            Debug mode
247
230
      </varlistentry>
248
231
      
249
232
      <varlistentry>
250
 
        <term><literal>-?</literal>, <literal>--help</literal></term>
 
233
        <term><option>--help</option></term>
 
234
        <term><option>-?</option></term>
251
235
        <listitem>
252
236
          <para>
253
237
            Gives a help message
256
240
      </varlistentry>
257
241
      
258
242
      <varlistentry>
259
 
        <term><literal>--usage</literal></term>
 
243
        <term><option>--usage</option></term>
260
244
        <listitem>
261
245
          <para>
262
246
            Gives a short usage message
265
249
      </varlistentry>
266
250
 
267
251
      <varlistentry>
268
 
        <term><literal>-V</literal>, <literal>--version</literal></term>
 
252
        <term><option>--version</option></term>
 
253
        <term><option>-V</option></term>
269
254
        <listitem>
270
255
          <para>
271
256
            Prints the program version