/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 10:27:33 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080831102733-2u083dacxul80ynp
* plugin-runner.xml (OPTIONS): Use <option> tags instead of
                               <literal>.  Split <term> tags into one
                               for each option.  Moved long options
                               before short.

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugin-runner.xml
4
4
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
5
5
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
6
6
<!ENTITY VERSION "1.0">
7
 
<!ENTITY COMMANDNAME "mandos-client">
 
7
<!ENTITY COMMANDNAME "plugin-runner">
 
8
<!ENTITY TIMESTAMP "2008-08-31">
8
9
]>
9
10
 
10
11
<refentry>
11
12
  <refentryinfo>
12
 
    <title>&COMMANDNAME;</title>
 
13
    <title>Mandos Manual</title>
13
14
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
14
 
    <productname>&COMMANDNAME;</productname>
 
15
    <productname>Mandos</productname>
15
16
    <productnumber>&VERSION;</productnumber>
 
17
    <date>&TIMESTAMP;</date>
16
18
    <authorgroup>
17
19
      <author>
18
20
        <firstname>Björn</firstname>
66
68
  <refnamediv>
67
69
    <refname><command>&COMMANDNAME;</command></refname>
68
70
    <refpurpose>
69
 
      get password for encrypted rootdisk
 
71
      Run Mandos plugins.  Pass data from first succesful one.
70
72
    </refpurpose>
71
73
  </refnamediv>
72
74
 
73
75
  <refsynopsisdiv>
74
76
    <cmdsynopsis>
75
77
      <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>    
 
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>
96
150
  </refsynopsisdiv>
97
151
 
98
152
  <refsect1 id="description">
100
154
    <para>
101
155
      <command>&COMMANDNAME;</command> is a plugin runner that waits
102
156
      for any of its plugins to return sucessfull with a password, and
103
 
      passes it to cryptsetup. plugins is defined as any executables
104
 
      in the plugins directory will by default will be
105
 
      /conf/conf.d/mandos/plugins.d.  to stdout.
 
157
      passes it to cryptsetup as stdout message. This command is not
 
158
      meant to be invoked directly, but is instead meant to be run by
 
159
      cryptsetup by being specified in /etc/crypttab as a keyscript
 
160
      and subsequlently started in the initrd environment. See
 
161
      <citerefentry><refentrytitle>crypttab</refentrytitle>
 
162
      <manvolnum>5</manvolnum></citerefentry> for more information on
 
163
      keyscripts.
106
164
    </para>
107
165
 
 
166
    <para>
 
167
      plugins is looked for in the plugins directory which by default will be
 
168
      /conf/conf.d/mandos/plugins.d if not changed by option --plugin-dir.
 
169
    </para>
 
170
  </refsect1>
 
171
  <refsect1>
 
172
    <title>OPTIONS</title>
108
173
    <variablelist>
109
174
      <varlistentry>
110
 
        <term><literal>-g</literal>,<literal>--global-options
111
 
        <replaceable>OPTIONS</replaceable></literal></term>
 
175
        <term><option>--global-options
 
176
        <replaceable>OPTIONS</replaceable></option></term>
 
177
        <term><option>-g
 
178
        <replaceable>OPTIONS</replaceable></option></term>
112
179
        <listitem>
113
180
          <para>
114
181
            Global options given to all plugins as additional start
115
182
            arguments.  Options are specified with a -o flag followed
116
183
            by a comma separated string of options.
117
 
          </para>         
 
184
          </para>       
118
185
        </listitem>
119
186
      </varlistentry>
120
187
 
121
188
      <varlistentry>
122
 
        <term><literal>-o</literal>,<literal> --options-for
123
 
        <replaceable>PLUGIN</replaceable>:<replaceable>OPTION</replaceable>
124
 
        </literal></term>
 
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>
125
195
        <listitem>
126
196
          <para>
127
197
            Plugin specific options given to the plugin as additional
128
198
            start arguments.  Options are specified with a -o flag
129
199
            followed by a comma separated string of options.
130
 
          </para>         
 
200
          </para>       
131
201
        </listitem>
132
 
      </varlistentry>      
 
202
      </varlistentry>
133
203
 
134
204
      <varlistentry>
135
 
        <term><literal>-d</literal>,<literal> --disable
136
 
        <replaceable>PLUGIN</replaceable>
137
 
        </literal></term>
 
205
        <term><option> --disable
 
206
        <replaceable>PLUGIN</replaceable></option></term>
 
207
        <term><option>-d
 
208
        <replaceable>PLUGIN</replaceable></option></term>
138
209
        <listitem>
139
210
          <para>
140
211
            Disable a specific plugin
141
 
          </para>         
 
212
          </para>       
142
213
        </listitem>
143
214
      </varlistentry>
144
215
 
145
216
      <varlistentry>
146
 
        <term><literal>--groupid <replaceable>ID</replaceable>
147
 
        </literal></term>
 
217
        <term><option>--groupid
 
218
        <replaceable>ID</replaceable></option></term>
148
219
        <listitem>
149
220
          <para>
150
221
            Group ID the plugins will run as
151
222
          </para>
152
223
        </listitem>
153
 
      </varlistentry>      
 
224
      </varlistentry>
154
225
 
155
226
      <varlistentry>
156
 
        <term><literal>--userid <replaceable>ID</replaceable>
157
 
        </literal></term>
 
227
        <term><option>--userid
 
228
        <replaceable>ID</replaceable></option></term>
158
229
        <listitem>
159
230
          <para>
160
231
            User ID the plugins will run as
161
232
          </para>
162
233
        </listitem>
163
 
      </varlistentry>      
 
234
      </varlistentry>
164
235
 
165
236
      <varlistentry>
166
 
        <term><literal>--plugin-dir <replaceable>DIRECTORY</replaceable>
167
 
        </literal></term>
 
237
        <term><option>--plugin-dir
 
238
        <replaceable>DIRECTORY</replaceable></option></term>
168
239
        <listitem>
169
240
          <para>
170
241
            Specify a different plugin directory
171
242
          </para>
172
243
        </listitem>
173
 
      </varlistentry>       
 
244
      </varlistentry>
174
245
      
175
246
      <varlistentry>
176
 
        <term><literal>--debug</literal></term>
 
247
        <term><option>--debug</option></term>
177
248
        <listitem>
178
249
          <para>
179
250
            Debug mode
182
253
      </varlistentry>
183
254
      
184
255
      <varlistentry>
185
 
        <term><literal>-?</literal>, <literal>--help</literal></term>
 
256
        <term><option>--help</option></term>
 
257
        <term><option>-?</option></term>
186
258
        <listitem>
187
259
          <para>
188
260
            Gives a help message
191
263
      </varlistentry>
192
264
      
193
265
      <varlistentry>
194
 
        <term><literal>--usage</literal></term>
 
266
        <term><option>--usage</option></term>
195
267
        <listitem>
196
268
          <para>
197
269
            Gives a short usage message
200
272
      </varlistentry>
201
273
 
202
274
      <varlistentry>
203
 
        <term><literal>-V</literal>, <literal>--version</literal></term>
 
275
        <term><option>--version</option></term>
 
276
        <term><option>-V</option></term>
204
277
        <listitem>
205
278
          <para>
206
279
            Prints the program version
207
280
          </para>
208
281
        </listitem>
209
 
      </varlistentry>            
 
282
      </varlistentry>
210
283
    </variablelist>
211
284
  </refsect1>
 
285
 
 
286
  <refsect1 id="exit_status">
 
287
    <title>EXIT STATUS</title>
 
288
    <para>
 
289
    </para>
 
290
  </refsect1>
 
291
 
 
292
  <refsect1 id="file">
 
293
    <title>FILES</title>
 
294
    <para>
 
295
    </para>
 
296
  </refsect1>
 
297
 
 
298
  <refsect1 id="notes">
 
299
    <title>NOTES</title>
 
300
    <para>
 
301
    </para>
 
302
  </refsect1>
 
303
  
 
304
  <refsect1 id="bugs">
 
305
    <title>BUGS</title>
 
306
    <para>
 
307
    </para>
 
308
  </refsect1>
 
309
 
 
310
  <refsect1 id="examples">
 
311
    <title>EXAMPLE</title>
 
312
    <para>
 
313
    </para>
 
314
  </refsect1>
 
315
 
 
316
  <refsect1 id="security">
 
317
    <title>SECURITY</title>
 
318
    <para>
 
319
    </para>
 
320
  </refsect1>
 
321
 
 
322
  <refsect1 id="see_also">
 
323
    <title>SEE ALSO</title>
 
324
    <para>
 
325
      <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>
 
333
    </para>
 
334
  </refsect1>
 
335
 
212
336
</refentry>
 
337
<!-- Local Variables: -->
 
338
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
339
<!-- time-stamp-end: "[\"']>" -->
 
340
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
341
<!-- End: -->