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
<!ENTITY COMMANDNAME "mandos-client">
5
<!ENTITY COMMANDNAME "plugin-runner">
6
<!ENTITY TIMESTAMP "2008-08-31">
12
<title>&COMMANDNAME;</title>
13
<!-- NWalsh's docbook scripts use this to generate the footer: -->
14
<productname>&COMMANDNAME;</productname>
11
<title>Mandos Manual</title>
12
<!-- Nwalsh’s docbook scripts use this to generate the footer: -->
13
<productname>Mandos</productname>
15
14
<productnumber>&VERSION;</productnumber>
15
<date>&TIMESTAMP;</date>
18
18
<firstname>Björn</firstname>
67
68
<refname><command>&COMMANDNAME;</command></refname>
69
get password for encrypted rootdisk
70
Run Mandos plugins. Pass data from first succesful one.
75
76
<command>&COMMANDNAME;</command>
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>
85
<command>&COMMANDNAME;</command>
86
<arg choice='plain'>--help</arg>
89
<command>&COMMANDNAME;</command>
90
<arg choice='plain'>--usage</arg>
93
<command>&COMMANDNAME;</command>
94
<arg choice='plain'>--version</arg>
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>
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>
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>
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>
114
<arg choice="plain"><option>--disable=<replaceable
115
>PLUGIN</replaceable></option></arg>
116
<arg choice="plain"><option>-d
117
<replaceable>PLUGIN</replaceable> </option></arg>
120
<arg><option>--groupid=<replaceable
121
>ID</replaceable></option></arg>
123
<arg><option>--userid=<replaceable
124
>ID</replaceable></option></arg>
126
<arg><option>--plugin-dir=<replaceable
127
>DIRECTORY</replaceable></option></arg>
129
<arg><option>--debug</option></arg>
132
<command>&COMMANDNAME;</command>
134
<arg choice="plain"><option>--help</option></arg>
135
<arg choice="plain"><option>-?</option></arg>
139
<command>&COMMANDNAME;</command>
140
<arg choice="plain"><option>--usage</option></arg>
143
<command>&COMMANDNAME;</command>
145
<arg choice="plain"><option>--version</option></arg>
146
<arg choice="plain"><option>-V</option></arg>
98
151
<refsect1 id="description">
118
171
<title>OPTIONS</title>
121
<term><literal>-g</literal>,<literal>--global-options
122
<replaceable>OPTIONS</replaceable></literal></term>
174
<term><option>--global-options
175
<replaceable>OPTIONS</replaceable></option></term>
177
<replaceable>OPTIONS</replaceable></option></term>
125
180
Global options given to all plugins as additional start
126
181
arguments. Options are specified with a -o flag followed
127
182
by a comma separated string of options.
133
<term><literal>-o</literal>,<literal> --options-for
134
<replaceable>PLUGIN</replaceable>:<replaceable>OPTION</replaceable>
188
<term><option>--options-for
189
<replaceable>PLUGIN</replaceable><literal>:</literal
190
><replaceable>OPTION</replaceable></option></term>
192
<replaceable>PLUGIN</replaceable><literal>:</literal
193
><replaceable>OPTION</replaceable></option></term>
138
196
Plugin specific options given to the plugin as additional
139
197
start arguments. Options are specified with a -o flag
140
198
followed by a comma separated string of options.
146
<term><literal>-d</literal>,<literal> --disable
147
<replaceable>PLUGIN</replaceable>
204
<term><option> --disable
205
<replaceable>PLUGIN</replaceable></option></term>
207
<replaceable>PLUGIN</replaceable></option></term>
151
210
Disable a specific plugin
157
<term><literal>--groupid <replaceable>ID</replaceable>
216
<term><option>--groupid
217
<replaceable>ID</replaceable></option></term>
161
220
Group ID the plugins will run as
167
<term><literal>--userid <replaceable>ID</replaceable>
226
<term><option>--userid
227
<replaceable>ID</replaceable></option></term>
171
230
User ID the plugins will run as
177
<term><literal>--plugin-dir <replaceable>DIRECTORY</replaceable>
236
<term><option>--plugin-dir
237
<replaceable>DIRECTORY</replaceable></option></term>
181
240
Specify a different plugin directory
187
<term><literal>--debug</literal></term>
246
<term><option>--debug</option></term>
214
<term><literal>-V</literal>, <literal>--version</literal></term>
274
<term><option>--version</option></term>
275
<term><option>-V</option></term>
217
278
Prints the program version
285
<refsect1 id="exit_status">
286
<title>EXIT STATUS</title>
297
<refsect1 id="notes">
309
<refsect1 id="examples">
310
<title>EXAMPLE</title>
315
<refsect1 id="security">
316
<title>SECURITY</title>
321
<refsect1 id="see_also">
322
<title>SEE ALSO</title>
324
<citerefentry><refentrytitle>cryptsetup</refentrytitle>
325
<manvolnum>8</manvolnum></citerefentry>,
326
<citerefentry><refentrytitle>mandos</refentrytitle>
327
<manvolnum>8</manvolnum></citerefentry>,
328
<citerefentry><refentrytitle>password-prompt</refentrytitle>
329
<manvolnum>8mandos</manvolnum></citerefentry>,
330
<citerefentry><refentrytitle>password-request</refentrytitle>
331
<manvolnum>8mandos</manvolnum></citerefentry>
336
<!-- Local Variables: -->
337
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
338
<!-- time-stamp-end: "[\"']>" -->
339
<!-- time-stamp-format: "%:y-%02m-%02d" -->