/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-31 14:02:37 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080831140237-oz9knd88esz8cj4y
* plugin-runner.xml: Removed <?xml-stylesheet>.
* plugins.d/password-request.xml: - '' -

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