/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

merge

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">
9
8
]>
10
9
 
11
10
<refentry>
12
11
  <refentryinfo>
13
 
    <title>Mandos Manual</title>
 
12
    <title>&COMMANDNAME;</title>
14
13
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
15
 
    <productname>Mandos</productname>
 
14
    <productname>&COMMANDNAME;</productname>
16
15
    <productnumber>&VERSION;</productnumber>
17
 
    <date>&TIMESTAMP;</date>
18
16
    <authorgroup>
19
17
      <author>
20
18
        <firstname>Björn</firstname>
68
66
  <refnamediv>
69
67
    <refname><command>&COMMANDNAME;</command></refname>
70
68
    <refpurpose>
71
 
      Run Mandos plugins.  Pass data from first succesful one.
 
69
      get password for encrypted rootdisk
72
70
    </refpurpose>
73
71
  </refnamediv>
74
72
 
75
73
  <refsynopsisdiv>
76
74
    <cmdsynopsis>
77
75
      <command>&COMMANDNAME;</command>
78
 
      <group rep="repeat">
79
 
        <arg choice="plain"><option>--global-envs=<replaceable
80
 
        >VAR</replaceable><literal>=</literal><replaceable
81
 
        >value</replaceable></option></arg>
82
 
        <arg choice="plain"><option>-e
83
 
        <replaceable>VAR</replaceable><literal>=</literal><replaceable
84
 
        >value</replaceable> </option></arg>
85
 
      </group>
86
 
      <sbr/>
87
 
      <group rep="repeat">
88
 
        <arg choice="plain"><option>--envs-for=<replaceable
89
 
        >PLUGIN</replaceable><literal>:</literal><replaceable
90
 
        >ENV</replaceable><literal>=</literal><replaceable
91
 
        >value</replaceable></option></arg>
92
 
        <arg choice="plain"><option>-f<replaceable>
93
 
        PLUGIN</replaceable><literal>:</literal><replaceable
94
 
        >ENV</replaceable><literal>=</literal><replaceable
95
 
        >value</replaceable> </option></arg>
96
 
      </group>
97
 
      <sbr/>
98
 
      <group rep="repeat">
99
 
        <arg choice="plain"><option>--global-options=<replaceable
100
 
        >OPTIONS</replaceable></option></arg>
101
 
        <arg choice="plain"><option>-g<replaceable>
102
 
        OPTIONS</replaceable> </option></arg>
103
 
      </group>
104
 
      <sbr/>
105
 
      <group rep="repeat">
106
 
        <arg choice="plain"><option>--options-for=<replaceable
107
 
        >PLUGIN</replaceable><literal>:</literal><replaceable
108
 
        >OPTIONS</replaceable></option></arg>
109
 
        <arg choice="plain"><option>-f<replaceable>
110
 
        PLUGIN</replaceable><literal>:</literal><replaceable
111
 
        >OPTIONS</replaceable> </option></arg>
112
 
      </group>
113
 
      <sbr/>
114
 
      <group rep="repeat">
115
 
        <arg choice="plain"><option>--disable=<replaceable
116
 
        >PLUGIN</replaceable></option></arg>
117
 
        <arg choice="plain"><option>-d
118
 
        <replaceable>PLUGIN</replaceable> </option></arg>
119
 
      </group>
120
 
      <sbr/>
121
 
      <arg><option>--groupid=<replaceable
122
 
      >ID</replaceable></option></arg>
123
 
      <sbr/>
124
 
      <arg><option>--userid=<replaceable
125
 
      >ID</replaceable></option></arg>
126
 
      <sbr/>
127
 
      <arg><option>--plugin-dir=<replaceable
128
 
      >DIRECTORY</replaceable></option></arg>
129
 
      <sbr/>
130
 
      <arg><option>--debug</option></arg>
131
 
    </cmdsynopsis>
132
 
    <cmdsynopsis>
133
 
      <command>&COMMANDNAME;</command>
134
 
      <group choice="req">
135
 
        <arg choice='plain'><option>--help</option></arg>
136
 
        <arg choice='plain'><option>-?</option></arg>
137
 
      </group>
138
 
    </cmdsynopsis>
139
 
    <cmdsynopsis>
140
 
      <command>&COMMANDNAME;</command>
141
 
      <arg choice='plain'><option>--usage</option></arg>
142
 
    </cmdsynopsis>
143
 
    <cmdsynopsis>
144
 
      <command>&COMMANDNAME;</command>
145
 
      <group choice="req">
146
 
        <arg choice='plain'><option>--version</option></arg>
147
 
        <arg choice='plain'><option>-V</option></arg>
148
 
      </group>
149
 
    </cmdsynopsis>
 
76
      <arg choice='opt'>--global-options<arg choice='plain'>OPTIONS</arg></arg>
 
77
      <arg choice='opt'>--options-for<arg choice='plain'>PLUGIN:OPTIONS</arg></arg>
 
78
      <arg choice='opt'>--disable<arg choice='plain'>PLUGIN</arg></arg>
 
79
      <arg choice='opt'>--groupid<arg choice='plain'>ID</arg></arg>
 
80
      <arg choice='opt'>--userid<arg choice='plain'>ID</arg></arg>
 
81
      <arg choice='opt'>--plugin-dir<arg choice='plain'>DIRECTORY</arg></arg>
 
82
      <arg choice='opt'>--debug</arg>
 
83
    </cmdsynopsis>
 
84
    <cmdsynopsis>
 
85
      <command>&COMMANDNAME;</command>
 
86
      <arg choice='plain'>--help</arg>
 
87
    </cmdsynopsis>
 
88
    <cmdsynopsis>
 
89
      <command>&COMMANDNAME;</command>
 
90
      <arg choice='plain'>--usage</arg>
 
91
    </cmdsynopsis>
 
92
    <cmdsynopsis>
 
93
      <command>&COMMANDNAME;</command>
 
94
      <arg choice='plain'>--version</arg>
 
95
    </cmdsynopsis>    
150
96
  </refsynopsisdiv>
151
97
 
152
98
  <refsect1 id="description">
160
106
      and subsequlently started in the initrd environment. See
161
107
      <citerefentry><refentrytitle>crypttab</refentrytitle>
162
108
      <manvolnum>5</manvolnum></citerefentry> for more information on
163
 
      keyscripts.
 
109
      keyscripts.    
164
110
    </para>
165
111
 
166
112
    <para>
172
118
    <title>OPTIONS</title>
173
119
    <variablelist>
174
120
      <varlistentry>
175
 
        <term><option>--global-options
176
 
        <replaceable>OPTIONS</replaceable></option></term>
177
 
        <term><option>-g
178
 
        <replaceable>OPTIONS</replaceable></option></term>
 
121
        <term><literal>-g</literal>,<literal>--global-options
 
122
        <replaceable>OPTIONS</replaceable></literal></term>
179
123
        <listitem>
180
124
          <para>
181
125
            Global options given to all plugins as additional start
182
126
            arguments.  Options are specified with a -o flag followed
183
127
            by a comma separated string of options.
184
 
          </para>       
 
128
          </para>         
185
129
        </listitem>
186
130
      </varlistentry>
187
131
 
188
132
      <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>
 
133
        <term><literal>-o</literal>,<literal> --options-for
 
134
        <replaceable>PLUGIN</replaceable>:<replaceable>OPTION</replaceable>
 
135
        </literal></term>
195
136
        <listitem>
196
137
          <para>
197
138
            Plugin specific options given to the plugin as additional
198
139
            start arguments.  Options are specified with a -o flag
199
140
            followed by a comma separated string of options.
200
 
          </para>       
 
141
          </para>         
201
142
        </listitem>
202
 
      </varlistentry>
 
143
      </varlistentry>      
203
144
 
204
145
      <varlistentry>
205
 
        <term><option> --disable
206
 
        <replaceable>PLUGIN</replaceable></option></term>
207
 
        <term><option>-d
208
 
        <replaceable>PLUGIN</replaceable></option></term>
 
146
        <term><literal>-d</literal>,<literal> --disable
 
147
        <replaceable>PLUGIN</replaceable>
 
148
        </literal></term>
209
149
        <listitem>
210
150
          <para>
211
151
            Disable a specific plugin
212
 
          </para>       
 
152
          </para>         
213
153
        </listitem>
214
154
      </varlistentry>
215
155
 
216
156
      <varlistentry>
217
 
        <term><option>--groupid
218
 
        <replaceable>ID</replaceable></option></term>
 
157
        <term><literal>--groupid <replaceable>ID</replaceable>
 
158
        </literal></term>
219
159
        <listitem>
220
160
          <para>
221
161
            Group ID the plugins will run as
222
162
          </para>
223
163
        </listitem>
224
 
      </varlistentry>
 
164
      </varlistentry>      
225
165
 
226
166
      <varlistentry>
227
 
        <term><option>--userid
228
 
        <replaceable>ID</replaceable></option></term>
 
167
        <term><literal>--userid <replaceable>ID</replaceable>
 
168
        </literal></term>
229
169
        <listitem>
230
170
          <para>
231
171
            User ID the plugins will run as
232
172
          </para>
233
173
        </listitem>
234
 
      </varlistentry>
 
174
      </varlistentry>      
235
175
 
236
176
      <varlistentry>
237
 
        <term><option>--plugin-dir
238
 
        <replaceable>DIRECTORY</replaceable></option></term>
 
177
        <term><literal>--plugin-dir <replaceable>DIRECTORY</replaceable>
 
178
        </literal></term>
239
179
        <listitem>
240
180
          <para>
241
181
            Specify a different plugin directory
242
182
          </para>
243
183
        </listitem>
244
 
      </varlistentry>
 
184
      </varlistentry>       
245
185
      
246
186
      <varlistentry>
247
 
        <term><option>--debug</option></term>
 
187
        <term><literal>--debug</literal></term>
248
188
        <listitem>
249
189
          <para>
250
190
            Debug mode
253
193
      </varlistentry>
254
194
      
255
195
      <varlistentry>
256
 
        <term><option>--help</option></term>
257
 
        <term><option>-?</option></term>
 
196
        <term><literal>-?</literal>, <literal>--help</literal></term>
258
197
        <listitem>
259
198
          <para>
260
199
            Gives a help message
263
202
      </varlistentry>
264
203
      
265
204
      <varlistentry>
266
 
        <term><option>--usage</option></term>
 
205
        <term><literal>--usage</literal></term>
267
206
        <listitem>
268
207
          <para>
269
208
            Gives a short usage message
272
211
      </varlistentry>
273
212
 
274
213
      <varlistentry>
275
 
        <term><option>--version</option></term>
276
 
        <term><option>-V</option></term>
 
214
        <term><literal>-V</literal>, <literal>--version</literal></term>
277
215
        <listitem>
278
216
          <para>
279
217
            Prints the program version
280
218
          </para>
281
219
        </listitem>
282
 
      </varlistentry>
 
220
      </varlistentry>            
283
221
    </variablelist>
284
222
  </refsect1>
285
223
 
293
231
    <title>FILES</title>
294
232
    <para>
295
233
    </para>
296
 
  </refsect1>
 
234
  </refsect1>  
297
235
 
298
236
  <refsect1 id="notes">
299
237
    <title>NOTES</title>
305
243
    <title>BUGS</title>
306
244
    <para>
307
245
    </para>
308
 
  </refsect1>
 
246
  </refsect1>  
309
247
 
310
248
  <refsect1 id="examples">
311
 
    <title>EXAMPLE</title>
 
249
    <title>EXAMPLES</title>
312
250
    <para>
313
251
    </para>
314
252
  </refsect1>
322
260
  <refsect1 id="see_also">
323
261
    <title>SEE ALSO</title>
324
262
    <para>
 
263
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
264
      <manvolnum>8</manvolnum></citerefentry>, <citerefentry>
 
265
      <refentrytitle>password-request</refentrytitle>
 
266
      <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
 
267
      <refentrytitle>password-prompt</refentrytitle>
 
268
      <manvolnum>8mandos</manvolnum></citerefentry>, and
325
269
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
326
 
      <manvolnum>8</manvolnum></citerefentry>,
327
 
      <citerefentry><refentrytitle>mandos</refentrytitle>
328
 
      <manvolnum>8</manvolnum></citerefentry>,
329
 
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
330
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
331
 
      <citerefentry><refentrytitle>password-request</refentrytitle>
332
 
      <manvolnum>8mandos</manvolnum></citerefentry>
 
270
      <manvolnum>8</manvolnum></citerefentry>
333
271
    </para>
334
272
  </refsect1>
335
273
 
336
274
</refentry>
337
 
<!-- Local Variables: -->
338
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
339
 
<!-- time-stamp-end: "[\"']>" -->
340
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
341
 
<!-- End: -->