/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 11:31:37 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080830113137-v0inyj0limprzfwn
* mandos-options.xml (priority): Added <acronym> tags.

* mandos.xml (NAME): 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-29">
7
9
]>
8
10
 
9
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
38
    <legalnotice>
38
39
      <para>
67
68
  <refnamediv>
68
69
    <refname><command>&COMMANDNAME;</command></refname>
69
70
    <refpurpose>
70
 
      Run Mandos plugins.  Pass data from first succesful one.
 
71
      get password for encrypted rootdisk
71
72
    </refpurpose>
72
73
  </refnamediv>
73
74
 
74
75
  <refsynopsisdiv>
75
76
    <cmdsynopsis>
76
77
      <command>&COMMANDNAME;</command>
77
 
      <group rep="repeat">
78
 
        <arg choice="plain"><option>--global-envs=<replaceable
79
 
        >VAR</replaceable><literal>=</literal><replaceable
80
 
        >value</replaceable></option></arg>
81
 
        <arg choice="plain"><option>-e
82
 
        <replaceable>VAR</replaceable><literal>=</literal><replaceable
83
 
        >value</replaceable> </option></arg>
84
 
      </group>
85
 
      <sbr/>
86
 
      <group rep="repeat">
87
 
        <arg choice="plain"><option>--envs-for=<replaceable
88
 
        >PLUGIN</replaceable><literal>:</literal><replaceable
89
 
        >ENV</replaceable><literal>=</literal><replaceable
90
 
        >value</replaceable></option></arg>
91
 
        <arg choice="plain"><option>-f<replaceable>
92
 
        PLUGIN</replaceable><literal>:</literal><replaceable
93
 
        >ENV</replaceable><literal>=</literal><replaceable
94
 
        >value</replaceable> </option></arg>
95
 
      </group>
96
 
      <sbr/>
97
 
      <group rep="repeat">
98
 
        <arg choice="plain"><option>--global-options=<replaceable
99
 
        >OPTIONS</replaceable></option></arg>
100
 
        <arg choice="plain"><option>-g<replaceable>
101
 
        OPTIONS</replaceable> </option></arg>
102
 
      </group>
103
 
      <sbr/>
104
 
      <group rep="repeat">
105
 
        <arg choice="plain"><option>--options-for=<replaceable
106
 
        >PLUGIN</replaceable><literal>:</literal><replaceable
107
 
        >OPTIONS</replaceable></option></arg>
108
 
        <arg choice="plain"><option>-f<replaceable>
109
 
        PLUGIN</replaceable><literal>:</literal><replaceable
110
 
        >OPTIONS</replaceable> </option></arg>
111
 
      </group>
112
 
      <sbr/>
113
 
      <group rep="repeat">
114
 
        <arg choice="plain"><option>--disable=<replaceable
115
 
        >PLUGIN</replaceable></option></arg>
116
 
        <arg choice="plain"><option>-d
117
 
        <replaceable>PLUGIN</replaceable> </option></arg>
118
 
      </group>
119
 
      <sbr/>
120
 
      <arg><option>--groupid=<replaceable
121
 
      >ID</replaceable></option></arg>
122
 
      <sbr/>
123
 
      <arg><option>--userid=<replaceable
124
 
      >ID</replaceable></option></arg>
125
 
      <sbr/>
126
 
      <arg><option>--plugin-dir=<replaceable
127
 
      >DIRECTORY</replaceable></option></arg>
128
 
      <sbr/>
129
 
      <arg><option>--debug</option></arg>
130
 
    </cmdsynopsis>
131
 
    <cmdsynopsis>
132
 
      <command>&COMMANDNAME;</command>
133
 
      <group choice="req">
134
 
        <arg choice="plain"><option>--help</option></arg>
135
 
        <arg choice="plain"><option>-?</option></arg>
136
 
      </group>
137
 
    </cmdsynopsis>
138
 
    <cmdsynopsis>
139
 
      <command>&COMMANDNAME;</command>
140
 
      <arg choice="plain"><option>--usage</option></arg>
141
 
    </cmdsynopsis>
142
 
    <cmdsynopsis>
143
 
      <command>&COMMANDNAME;</command>
144
 
      <group choice="req">
145
 
        <arg choice="plain"><option>--version</option></arg>
146
 
        <arg choice="plain"><option>-V</option></arg>
147
 
      </group>
148
 
    </cmdsynopsis>
 
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>
 
97
    </cmdsynopsis>    
149
98
  </refsynopsisdiv>
150
99
 
151
100
  <refsect1 id="description">
159
108
      and subsequlently started in the initrd environment. See
160
109
      <citerefentry><refentrytitle>crypttab</refentrytitle>
161
110
      <manvolnum>5</manvolnum></citerefentry> for more information on
162
 
      keyscripts.
 
111
      keyscripts.    
163
112
    </para>
164
113
 
165
114
    <para>
171
120
    <title>OPTIONS</title>
172
121
    <variablelist>
173
122
      <varlistentry>
174
 
        <term><option>--global-options
175
 
        <replaceable>OPTIONS</replaceable></option></term>
176
 
        <term><option>-g
177
 
        <replaceable>OPTIONS</replaceable></option></term>
 
123
        <term><literal>-g</literal>,<literal>--global-options
 
124
        <replaceable>OPTIONS</replaceable></literal></term>
178
125
        <listitem>
179
126
          <para>
180
127
            Global options given to all plugins as additional start
181
128
            arguments.  Options are specified with a -o flag followed
182
129
            by a comma separated string of options.
183
 
          </para>       
 
130
          </para>         
184
131
        </listitem>
185
132
      </varlistentry>
186
133
 
187
134
      <varlistentry>
188
 
        <term><option>--options-for
189
 
        <replaceable>PLUGIN</replaceable><literal>:</literal
190
 
        ><replaceable>OPTION</replaceable></option></term>
191
 
        <term><option>-o
192
 
        <replaceable>PLUGIN</replaceable><literal>:</literal
193
 
        ><replaceable>OPTION</replaceable></option></term>
 
135
        <term><literal>-o</literal>,<literal> --options-for
 
136
        <replaceable>PLUGIN</replaceable>:<replaceable>OPTION</replaceable>
 
137
        </literal></term>
194
138
        <listitem>
195
139
          <para>
196
140
            Plugin specific options given to the plugin as additional
197
141
            start arguments.  Options are specified with a -o flag
198
142
            followed by a comma separated string of options.
199
 
          </para>       
 
143
          </para>         
200
144
        </listitem>
201
 
      </varlistentry>
 
145
      </varlistentry>      
202
146
 
203
147
      <varlistentry>
204
 
        <term><option> --disable
205
 
        <replaceable>PLUGIN</replaceable></option></term>
206
 
        <term><option>-d
207
 
        <replaceable>PLUGIN</replaceable></option></term>
 
148
        <term><literal>-d</literal>,<literal> --disable
 
149
        <replaceable>PLUGIN</replaceable>
 
150
        </literal></term>
208
151
        <listitem>
209
152
          <para>
210
153
            Disable a specific plugin
211
 
          </para>       
 
154
          </para>         
212
155
        </listitem>
213
156
      </varlistentry>
214
157
 
215
158
      <varlistentry>
216
 
        <term><option>--groupid
217
 
        <replaceable>ID</replaceable></option></term>
 
159
        <term><literal>--groupid <replaceable>ID</replaceable>
 
160
        </literal></term>
218
161
        <listitem>
219
162
          <para>
220
163
            Group ID the plugins will run as
221
164
          </para>
222
165
        </listitem>
223
 
      </varlistentry>
 
166
      </varlistentry>      
224
167
 
225
168
      <varlistentry>
226
 
        <term><option>--userid
227
 
        <replaceable>ID</replaceable></option></term>
 
169
        <term><literal>--userid <replaceable>ID</replaceable>
 
170
        </literal></term>
228
171
        <listitem>
229
172
          <para>
230
173
            User ID the plugins will run as
231
174
          </para>
232
175
        </listitem>
233
 
      </varlistentry>
 
176
      </varlistentry>      
234
177
 
235
178
      <varlistentry>
236
 
        <term><option>--plugin-dir
237
 
        <replaceable>DIRECTORY</replaceable></option></term>
 
179
        <term><literal>--plugin-dir <replaceable>DIRECTORY</replaceable>
 
180
        </literal></term>
238
181
        <listitem>
239
182
          <para>
240
183
            Specify a different plugin directory
241
184
          </para>
242
185
        </listitem>
243
 
      </varlistentry>
 
186
      </varlistentry>       
244
187
      
245
188
      <varlistentry>
246
 
        <term><option>--debug</option></term>
 
189
        <term><literal>--debug</literal></term>
247
190
        <listitem>
248
191
          <para>
249
192
            Debug mode
252
195
      </varlistentry>
253
196
      
254
197
      <varlistentry>
255
 
        <term><option>--help</option></term>
256
 
        <term><option>-?</option></term>
 
198
        <term><literal>-?</literal>, <literal>--help</literal></term>
257
199
        <listitem>
258
200
          <para>
259
201
            Gives a help message
262
204
      </varlistentry>
263
205
      
264
206
      <varlistentry>
265
 
        <term><option>--usage</option></term>
 
207
        <term><literal>--usage</literal></term>
266
208
        <listitem>
267
209
          <para>
268
210
            Gives a short usage message
271
213
      </varlistentry>
272
214
 
273
215
      <varlistentry>
274
 
        <term><option>--version</option></term>
275
 
        <term><option>-V</option></term>
 
216
        <term><literal>-V</literal>, <literal>--version</literal></term>
276
217
        <listitem>
277
218
          <para>
278
219
            Prints the program version
279
220
          </para>
280
221
        </listitem>
281
 
      </varlistentry>
 
222
      </varlistentry>            
282
223
    </variablelist>
283
224
  </refsect1>
284
225
 
292
233
    <title>FILES</title>
293
234
    <para>
294
235
    </para>
295
 
  </refsect1>
 
236
  </refsect1>  
296
237
 
297
238
  <refsect1 id="notes">
298
239
    <title>NOTES</title>
304
245
    <title>BUGS</title>
305
246
    <para>
306
247
    </para>
307
 
  </refsect1>
 
248
  </refsect1>  
308
249
 
309
250
  <refsect1 id="examples">
310
251
    <title>EXAMPLE</title>