/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:44:32 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080831104432-9hzi47foc7tlmade
* plugins.d/password-prompt.xml (OPTIONS): Move <replaceable> tags to
                                           inside <option> tags.
                                           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' rep='repeat'>OPTION</arg>
 
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>
77
149
    </cmdsynopsis>
78
150
  </refsynopsisdiv>
79
151
 
82
154
    <para>
83
155
      <command>&COMMANDNAME;</command> is a plugin runner that waits
84
156
      for any of its plugins to return sucessfull with a password, and
85
 
      passes it to cryptsetup. plugins is defined as any executables
86
 
      in the plugins directory will by default will be
87
 
      /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.
88
164
    </para>
89
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>
90
173
    <variablelist>
91
174
      <varlistentry>
92
 
        <term><literal>-g</literal>,<literal>--global-options
93
 
        <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>
94
179
        <listitem>
95
180
          <para>
96
181
            Global options given to all plugins as additional start
97
182
            arguments.  Options are specified with a -o flag followed
98
183
            by a comma separated string of options.
99
 
          </para>         
 
184
          </para>       
100
185
        </listitem>
101
186
      </varlistentry>
102
187
 
103
188
      <varlistentry>
104
 
        <term><literal>-o</literal>,<literal> --options-for
105
 
        <replaceable>PLUGIN</replaceable>:<replaceable>OPTION</replaceable>
106
 
        </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>
107
195
        <listitem>
108
196
          <para>
109
197
            Plugin specific options given to the plugin as additional
110
198
            start arguments.  Options are specified with a -o flag
111
199
            followed by a comma separated string of options.
112
 
          </para>         
 
200
          </para>       
113
201
        </listitem>
114
 
      </varlistentry>      
 
202
      </varlistentry>
115
203
 
116
204
      <varlistentry>
117
 
        <term><literal>-d</literal>,<literal> --disable
118
 
        <replaceable>PLUGIN</replaceable>
119
 
        </literal></term>
 
205
        <term><option> --disable
 
206
        <replaceable>PLUGIN</replaceable></option></term>
 
207
        <term><option>-d
 
208
        <replaceable>PLUGIN</replaceable></option></term>
120
209
        <listitem>
121
210
          <para>
122
211
            Disable a specific plugin
123
 
          </para>         
 
212
          </para>       
124
213
        </listitem>
125
214
      </varlistentry>
126
215
 
127
216
      <varlistentry>
128
 
        <term><literal>--groupid <replaceable>ID</replaceable>
129
 
        </literal></term>
 
217
        <term><option>--groupid
 
218
        <replaceable>ID</replaceable></option></term>
130
219
        <listitem>
131
220
          <para>
132
221
            Group ID the plugins will run as
133
222
          </para>
134
223
        </listitem>
135
 
      </varlistentry>      
 
224
      </varlistentry>
136
225
 
137
226
      <varlistentry>
138
 
        <term><literal>--userid <replaceable>ID</replaceable>
139
 
        </literal></term>
 
227
        <term><option>--userid
 
228
        <replaceable>ID</replaceable></option></term>
140
229
        <listitem>
141
230
          <para>
142
231
            User ID the plugins will run as
143
232
          </para>
144
233
        </listitem>
145
 
      </varlistentry>      
 
234
      </varlistentry>
146
235
 
147
236
      <varlistentry>
148
 
        <term><literal>--plugin-dir <replaceable>DIRECTORY</replaceable>
149
 
        </literal></term>
 
237
        <term><option>--plugin-dir
 
238
        <replaceable>DIRECTORY</replaceable></option></term>
150
239
        <listitem>
151
240
          <para>
152
241
            Specify a different plugin directory
153
242
          </para>
154
243
        </listitem>
155
 
      </varlistentry>       
 
244
      </varlistentry>
156
245
      
157
246
      <varlistentry>
158
 
        <term><literal>--debug</literal></term>
 
247
        <term><option>--debug</option></term>
159
248
        <listitem>
160
249
          <para>
161
250
            Debug mode
164
253
      </varlistentry>
165
254
      
166
255
      <varlistentry>
167
 
        <term><literal>-?</literal>, <literal>--help</literal></term>
 
256
        <term><option>--help</option></term>
 
257
        <term><option>-?</option></term>
168
258
        <listitem>
169
259
          <para>
170
260
            Gives a help message
173
263
      </varlistentry>
174
264
      
175
265
      <varlistentry>
176
 
        <term><literal>--usage</literal></term>
 
266
        <term><option>--usage</option></term>
177
267
        <listitem>
178
268
          <para>
179
269
            Gives a short usage message
182
272
      </varlistentry>
183
273
 
184
274
      <varlistentry>
185
 
        <term><literal>-V</literal>, <literal>--version</literal></term>
 
275
        <term><option>--version</option></term>
 
276
        <term><option>-V</option></term>
186
277
        <listitem>
187
278
          <para>
188
279
            Prints the program version
189
280
          </para>
190
281
        </listitem>
191
 
      </varlistentry>            
 
282
      </varlistentry>
192
283
    </variablelist>
193
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
 
194
336
</refentry>
 
337
<!-- Local Variables: -->
 
338
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
339
<!-- time-stamp-end: "[\"']>" -->
 
340
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
341
<!-- End: -->