/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-30 18:45:41 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080830184541-j8zru4q0rlz5a0hw
* mandos-clients.conf.xml (SYNOPSIS): Remove line breaks.
  (OPTIONS): Add <option> tags.  Moved option name to outside
             <literal>.  Moved synopsis to inside <term> tags.
             Removed <synopsis> tags.  Improve wording of "secfile"
             option.
  (EXPANSION): Improved wording slightly.

* mandos-options.xml (interface): Improve wording.

* mandos.conf.xml (SYNOPSIS): Remove line breaks.
  (OPTIONS): Add <option> tags.  Moved option name to outside
             <literal>.  Moved synopsis to inside <term> tags.
             Removed <synopsis> tags.

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
2
<?xml-stylesheet type="text/xsl"
3
3
        href="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"?>
4
4
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
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>
12
12
  <refentryinfo>
13
13
    <title>Mandos Manual</title>
14
 
    <!-- Nwalsh’s docbook scripts use this to generate the footer: -->
 
14
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
15
15
    <productname>Mandos</productname>
16
16
    <productnumber>&VERSION;</productnumber>
17
17
    <date>&TIMESTAMP;</date>
33
33
    </authorgroup>
34
34
    <copyright>
35
35
      <year>2008</year>
36
 
      <holder>Teddy Hogeborn</holder>
37
 
      <holder>Björn Påhlsson</holder>
 
36
      <holder>Teddy Hogeborn &amp; Björn Påhlsson</holder>
38
37
    </copyright>
39
38
    <legalnotice>
40
39
      <para>
69
68
  <refnamediv>
70
69
    <refname><command>&COMMANDNAME;</command></refname>
71
70
    <refpurpose>
72
 
      Run Mandos plugins.  Pass data from first succesful one.
 
71
      get password for encrypted rootdisk
73
72
    </refpurpose>
74
73
  </refnamediv>
75
74
 
76
75
  <refsynopsisdiv>
77
76
    <cmdsynopsis>
78
77
      <command>&COMMANDNAME;</command>
79
 
      <group rep="repeat">
80
 
        <arg choice="plain"><option>--global-envs=<replaceable
81
 
        >VAR</replaceable><literal>=</literal><replaceable
82
 
        >value</replaceable></option></arg>
83
 
        <arg choice="plain"><option>-e
84
 
        <replaceable>VAR</replaceable><literal>=</literal><replaceable
85
 
        >value</replaceable> </option></arg>
86
 
      </group>
87
 
      <sbr/>
88
 
      <group rep="repeat">
89
 
        <arg choice="plain"><option>--envs-for=<replaceable
90
 
        >PLUGIN</replaceable><literal>:</literal><replaceable
91
 
        >ENV</replaceable><literal>=</literal><replaceable
92
 
        >value</replaceable></option></arg>
93
 
        <arg choice="plain"><option>-f<replaceable>
94
 
        PLUGIN</replaceable><literal>:</literal><replaceable
95
 
        >ENV</replaceable><literal>=</literal><replaceable
96
 
        >value</replaceable> </option></arg>
97
 
      </group>
98
 
      <sbr/>
99
 
      <group rep="repeat">
100
 
        <arg choice="plain"><option>--global-options=<replaceable
101
 
        >OPTIONS</replaceable></option></arg>
102
 
        <arg choice="plain"><option>-g<replaceable>
103
 
        OPTIONS</replaceable> </option></arg>
104
 
      </group>
105
 
      <sbr/>
106
 
      <group rep="repeat">
107
 
        <arg choice="plain"><option>--options-for=<replaceable
108
 
        >PLUGIN</replaceable><literal>:</literal><replaceable
109
 
        >OPTIONS</replaceable></option></arg>
110
 
        <arg choice="plain"><option>-f<replaceable>
111
 
        PLUGIN</replaceable><literal>:</literal><replaceable
112
 
        >OPTIONS</replaceable> </option></arg>
113
 
      </group>
114
 
      <sbr/>
115
 
      <group rep="repeat">
116
 
        <arg choice="plain"><option>--disable=<replaceable
117
 
        >PLUGIN</replaceable></option></arg>
118
 
        <arg choice="plain"><option>-d
119
 
        <replaceable>PLUGIN</replaceable> </option></arg>
120
 
      </group>
121
 
      <sbr/>
122
 
      <arg><option>--groupid=<replaceable
123
 
      >ID</replaceable></option></arg>
124
 
      <sbr/>
125
 
      <arg><option>--userid=<replaceable
126
 
      >ID</replaceable></option></arg>
127
 
      <sbr/>
128
 
      <arg><option>--plugin-dir=<replaceable
129
 
      >DIRECTORY</replaceable></option></arg>
130
 
      <sbr/>
131
 
      <arg><option>--debug</option></arg>
132
 
    </cmdsynopsis>
133
 
    <cmdsynopsis>
134
 
      <command>&COMMANDNAME;</command>
135
 
      <group choice="req">
136
 
        <arg choice="plain"><option>--help</option></arg>
137
 
        <arg choice="plain"><option>-?</option></arg>
138
 
      </group>
139
 
    </cmdsynopsis>
140
 
    <cmdsynopsis>
141
 
      <command>&COMMANDNAME;</command>
142
 
      <arg choice="plain"><option>--usage</option></arg>
143
 
    </cmdsynopsis>
144
 
    <cmdsynopsis>
145
 
      <command>&COMMANDNAME;</command>
146
 
      <group choice="req">
147
 
        <arg choice="plain"><option>--version</option></arg>
148
 
        <arg choice="plain"><option>-V</option></arg>
149
 
      </group>
 
78
      <arg choice='opt'>--global-options<arg choice='plain'>OPTIONS</arg></arg>
 
79
      <arg choice='opt'>--options-for<arg choice='plain'>PLUGIN:OPTIONS</arg></arg>
 
80
      <arg choice='opt'>--disable<arg choice='plain'>PLUGIN</arg></arg>
 
81
      <arg choice='opt'>--groupid<arg choice='plain'>ID</arg></arg>
 
82
      <arg choice='opt'>--userid<arg choice='plain'>ID</arg></arg>
 
83
      <arg choice='opt'>--plugin-dir<arg choice='plain'>DIRECTORY</arg></arg>
 
84
      <arg choice='opt'>--debug</arg>
 
85
    </cmdsynopsis>
 
86
    <cmdsynopsis>
 
87
      <command>&COMMANDNAME;</command>
 
88
      <arg choice='plain'>--help</arg>
 
89
    </cmdsynopsis>
 
90
    <cmdsynopsis>
 
91
      <command>&COMMANDNAME;</command>
 
92
      <arg choice='plain'>--usage</arg>
 
93
    </cmdsynopsis>
 
94
    <cmdsynopsis>
 
95
      <command>&COMMANDNAME;</command>
 
96
      <arg choice='plain'>--version</arg>
150
97
    </cmdsynopsis>
151
98
  </refsynopsisdiv>
152
99
 
173
120
    <title>OPTIONS</title>
174
121
    <variablelist>
175
122
      <varlistentry>
176
 
        <term><option>--global-options
177
 
        <replaceable>OPTIONS</replaceable></option></term>
178
 
        <term><option>-g
179
 
        <replaceable>OPTIONS</replaceable></option></term>
 
123
        <term><literal>-g</literal>,<literal>--global-options
 
124
        <replaceable>OPTIONS</replaceable></literal></term>
180
125
        <listitem>
181
126
          <para>
182
127
            Global options given to all plugins as additional start
187
132
      </varlistentry>
188
133
 
189
134
      <varlistentry>
190
 
        <term><option>--options-for
191
 
        <replaceable>PLUGIN</replaceable><literal>:</literal
192
 
        ><replaceable>OPTION</replaceable></option></term>
193
 
        <term><option>-o
194
 
        <replaceable>PLUGIN</replaceable><literal>:</literal
195
 
        ><replaceable>OPTION</replaceable></option></term>
 
135
        <term><literal>-o</literal>,<literal> --options-for
 
136
        <replaceable>PLUGIN</replaceable>:<replaceable>OPTION</replaceable>
 
137
        </literal></term>
196
138
        <listitem>
197
139
          <para>
198
140
            Plugin specific options given to the plugin as additional
203
145
      </varlistentry>
204
146
 
205
147
      <varlistentry>
206
 
        <term><option> --disable
207
 
        <replaceable>PLUGIN</replaceable></option></term>
208
 
        <term><option>-d
209
 
        <replaceable>PLUGIN</replaceable></option></term>
 
148
        <term><literal>-d</literal>,<literal> --disable
 
149
        <replaceable>PLUGIN</replaceable>
 
150
        </literal></term>
210
151
        <listitem>
211
152
          <para>
212
153
            Disable a specific plugin
215
156
      </varlistentry>
216
157
 
217
158
      <varlistentry>
218
 
        <term><option>--groupid
219
 
        <replaceable>ID</replaceable></option></term>
 
159
        <term><literal>--groupid <replaceable>ID</replaceable>
 
160
        </literal></term>
220
161
        <listitem>
221
162
          <para>
222
163
            Group ID the plugins will run as
225
166
      </varlistentry>
226
167
 
227
168
      <varlistentry>
228
 
        <term><option>--userid
229
 
        <replaceable>ID</replaceable></option></term>
 
169
        <term><literal>--userid <replaceable>ID</replaceable>
 
170
        </literal></term>
230
171
        <listitem>
231
172
          <para>
232
173
            User ID the plugins will run as
235
176
      </varlistentry>
236
177
 
237
178
      <varlistentry>
238
 
        <term><option>--plugin-dir
239
 
        <replaceable>DIRECTORY</replaceable></option></term>
 
179
        <term><literal>--plugin-dir <replaceable>DIRECTORY</replaceable>
 
180
        </literal></term>
240
181
        <listitem>
241
182
          <para>
242
183
            Specify a different plugin directory
245
186
      </varlistentry>
246
187
      
247
188
      <varlistentry>
248
 
        <term><option>--debug</option></term>
 
189
        <term><literal>--debug</literal></term>
249
190
        <listitem>
250
191
          <para>
251
192
            Debug mode
254
195
      </varlistentry>
255
196
      
256
197
      <varlistentry>
257
 
        <term><option>--help</option></term>
258
 
        <term><option>-?</option></term>
 
198
        <term><literal>-?</literal>, <literal>--help</literal></term>
259
199
        <listitem>
260
200
          <para>
261
201
            Gives a help message
264
204
      </varlistentry>
265
205
      
266
206
      <varlistentry>
267
 
        <term><option>--usage</option></term>
 
207
        <term><literal>--usage</literal></term>
268
208
        <listitem>
269
209
          <para>
270
210
            Gives a short usage message
273
213
      </varlistentry>
274
214
 
275
215
      <varlistentry>
276
 
        <term><option>--version</option></term>
277
 
        <term><option>-V</option></term>
 
216
        <term><literal>-V</literal>, <literal>--version</literal></term>
278
217
        <listitem>
279
218
          <para>
280
219
            Prints the program version