/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
 
<!ENTITY COMMANDNAME "mandos-client">
 
5
<!ENTITY COMMANDNAME "plugin-runner">
 
6
<!ENTITY TIMESTAMP "2008-08-31">
8
7
]>
9
8
 
10
9
<refentry>
11
10
  <refentryinfo>
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>
16
16
    <authorgroup>
17
17
      <author>
18
18
        <firstname>Björn</firstname>
31
31
    </authorgroup>
32
32
    <copyright>
33
33
      <year>2008</year>
34
 
      <holder>Teddy Hogeborn &amp; Björn Påhlsson</holder>
 
34
      <holder>Teddy Hogeborn</holder>
 
35
      <holder>Björn Påhlsson</holder>
35
36
    </copyright>
36
37
    <legalnotice>
37
38
      <para>
66
67
  <refnamediv>
67
68
    <refname><command>&COMMANDNAME;</command></refname>
68
69
    <refpurpose>
69
 
      get password for encrypted rootdisk
 
70
      Run Mandos plugins.  Pass data from first succesful one.
70
71
    </refpurpose>
71
72
  </refnamediv>
72
73
 
73
74
  <refsynopsisdiv>
74
75
    <cmdsynopsis>
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>
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>    
 
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>
96
149
  </refsynopsisdiv>
97
150
 
98
151
  <refsect1 id="description">
106
159
      and subsequlently started in the initrd environment. See
107
160
      <citerefentry><refentrytitle>crypttab</refentrytitle>
108
161
      <manvolnum>5</manvolnum></citerefentry> for more information on
109
 
      keyscripts.    
 
162
      keyscripts.
110
163
    </para>
111
164
 
112
165
    <para>
118
171
    <title>OPTIONS</title>
119
172
    <variablelist>
120
173
      <varlistentry>
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>
 
176
        <term><option>-g
 
177
        <replaceable>OPTIONS</replaceable></option></term>
123
178
        <listitem>
124
179
          <para>
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.
128
 
          </para>         
 
183
          </para>       
129
184
        </listitem>
130
185
      </varlistentry>
131
186
 
132
187
      <varlistentry>
133
 
        <term><literal>-o</literal>,<literal> --options-for
134
 
        <replaceable>PLUGIN</replaceable>:<replaceable>OPTION</replaceable>
135
 
        </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>
136
194
        <listitem>
137
195
          <para>
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.
141
 
          </para>         
 
199
          </para>       
142
200
        </listitem>
143
 
      </varlistentry>      
 
201
      </varlistentry>
144
202
 
145
203
      <varlistentry>
146
 
        <term><literal>-d</literal>,<literal> --disable
147
 
        <replaceable>PLUGIN</replaceable>
148
 
        </literal></term>
 
204
        <term><option> --disable
 
205
        <replaceable>PLUGIN</replaceable></option></term>
 
206
        <term><option>-d
 
207
        <replaceable>PLUGIN</replaceable></option></term>
149
208
        <listitem>
150
209
          <para>
151
210
            Disable a specific plugin
152
 
          </para>         
 
211
          </para>       
153
212
        </listitem>
154
213
      </varlistentry>
155
214
 
156
215
      <varlistentry>
157
 
        <term><literal>--groupid <replaceable>ID</replaceable>
158
 
        </literal></term>
 
216
        <term><option>--groupid
 
217
        <replaceable>ID</replaceable></option></term>
159
218
        <listitem>
160
219
          <para>
161
220
            Group ID the plugins will run as
162
221
          </para>
163
222
        </listitem>
164
 
      </varlistentry>      
 
223
      </varlistentry>
165
224
 
166
225
      <varlistentry>
167
 
        <term><literal>--userid <replaceable>ID</replaceable>
168
 
        </literal></term>
 
226
        <term><option>--userid
 
227
        <replaceable>ID</replaceable></option></term>
169
228
        <listitem>
170
229
          <para>
171
230
            User ID the plugins will run as
172
231
          </para>
173
232
        </listitem>
174
 
      </varlistentry>      
 
233
      </varlistentry>
175
234
 
176
235
      <varlistentry>
177
 
        <term><literal>--plugin-dir <replaceable>DIRECTORY</replaceable>
178
 
        </literal></term>
 
236
        <term><option>--plugin-dir
 
237
        <replaceable>DIRECTORY</replaceable></option></term>
179
238
        <listitem>
180
239
          <para>
181
240
            Specify a different plugin directory
182
241
          </para>
183
242
        </listitem>
184
 
      </varlistentry>       
 
243
      </varlistentry>
185
244
      
186
245
      <varlistentry>
187
 
        <term><literal>--debug</literal></term>
 
246
        <term><option>--debug</option></term>
188
247
        <listitem>
189
248
          <para>
190
249
            Debug mode
193
252
      </varlistentry>
194
253
      
195
254
      <varlistentry>
196
 
        <term><literal>-?</literal>, <literal>--help</literal></term>
 
255
        <term><option>--help</option></term>
 
256
        <term><option>-?</option></term>
197
257
        <listitem>
198
258
          <para>
199
259
            Gives a help message
202
262
      </varlistentry>
203
263
      
204
264
      <varlistentry>
205
 
        <term><literal>--usage</literal></term>
 
265
        <term><option>--usage</option></term>
206
266
        <listitem>
207
267
          <para>
208
268
            Gives a short usage message
211
271
      </varlistentry>
212
272
 
213
273
      <varlistentry>
214
 
        <term><literal>-V</literal>, <literal>--version</literal></term>
 
274
        <term><option>--version</option></term>
 
275
        <term><option>-V</option></term>
215
276
        <listitem>
216
277
          <para>
217
278
            Prints the program version
218
279
          </para>
219
280
        </listitem>
220
 
      </varlistentry>            
 
281
      </varlistentry>
221
282
    </variablelist>
222
283
  </refsect1>
 
284
 
 
285
  <refsect1 id="exit_status">
 
286
    <title>EXIT STATUS</title>
 
287
    <para>
 
288
    </para>
 
289
  </refsect1>
 
290
 
 
291
  <refsect1 id="file">
 
292
    <title>FILES</title>
 
293
    <para>
 
294
    </para>
 
295
  </refsect1>
 
296
 
 
297
  <refsect1 id="notes">
 
298
    <title>NOTES</title>
 
299
    <para>
 
300
    </para>
 
301
  </refsect1>
 
302
  
 
303
  <refsect1 id="bugs">
 
304
    <title>BUGS</title>
 
305
    <para>
 
306
    </para>
 
307
  </refsect1>
 
308
 
 
309
  <refsect1 id="examples">
 
310
    <title>EXAMPLE</title>
 
311
    <para>
 
312
    </para>
 
313
  </refsect1>
 
314
 
 
315
  <refsect1 id="security">
 
316
    <title>SECURITY</title>
 
317
    <para>
 
318
    </para>
 
319
  </refsect1>
 
320
 
 
321
  <refsect1 id="see_also">
 
322
    <title>SEE ALSO</title>
 
323
    <para>
 
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>
 
332
    </para>
 
333
  </refsect1>
 
334
 
223
335
</refentry>
 
336
<!-- Local Variables: -->
 
337
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
338
<!-- time-stamp-end: "[\"']>" -->
 
339
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
340
<!-- End: -->