/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 13:55:04 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080831135504-2ka1cccglsghslxy
* plugin-runner.xml (/refentry/refentryinfo/copyright): Split
                                                        copyright
                                                        holders.
* plugins.d/password-request.xml (/refentry/refentryinfo/copyright):
                                 Split copyright holders.

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>
31
33
    </authorgroup>
32
34
    <copyright>
33
35
      <year>2008</year>
34
 
      <holder>Teddy Hogeborn &amp; Björn Påhlsson</holder>
 
36
      <holder>Teddy Hogeborn</holder>
 
37
      <holder>Björn Påhlsson</holder>
35
38
    </copyright>
36
39
    <legalnotice>
37
40
      <para>
66
69
  <refnamediv>
67
70
    <refname><command>&COMMANDNAME;</command></refname>
68
71
    <refpurpose>
69
 
      get password for encrypted rootdisk
 
72
      Run Mandos plugins.  Pass data from first succesful one.
70
73
    </refpurpose>
71
74
  </refnamediv>
72
75
 
73
76
  <refsynopsisdiv>
74
77
    <cmdsynopsis>
75
78
      <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>    
 
79
      <group rep="repeat">
 
80
        <arg choice="plain"><option>--global-envs=<replaceable
 
81
        >VAR</replaceable><literal>=</literal><replaceable
 
82
        >value</replaceable></option></arg>
 
83
        <arg choice="plain"><option>-e
 
84
        <replaceable>VAR</replaceable><literal>=</literal><replaceable
 
85
        >value</replaceable> </option></arg>
 
86
      </group>
 
87
      <sbr/>
 
88
      <group rep="repeat">
 
89
        <arg choice="plain"><option>--envs-for=<replaceable
 
90
        >PLUGIN</replaceable><literal>:</literal><replaceable
 
91
        >ENV</replaceable><literal>=</literal><replaceable
 
92
        >value</replaceable></option></arg>
 
93
        <arg choice="plain"><option>-f<replaceable>
 
94
        PLUGIN</replaceable><literal>:</literal><replaceable
 
95
        >ENV</replaceable><literal>=</literal><replaceable
 
96
        >value</replaceable> </option></arg>
 
97
      </group>
 
98
      <sbr/>
 
99
      <group rep="repeat">
 
100
        <arg choice="plain"><option>--global-options=<replaceable
 
101
        >OPTIONS</replaceable></option></arg>
 
102
        <arg choice="plain"><option>-g<replaceable>
 
103
        OPTIONS</replaceable> </option></arg>
 
104
      </group>
 
105
      <sbr/>
 
106
      <group rep="repeat">
 
107
        <arg choice="plain"><option>--options-for=<replaceable
 
108
        >PLUGIN</replaceable><literal>:</literal><replaceable
 
109
        >OPTIONS</replaceable></option></arg>
 
110
        <arg choice="plain"><option>-f<replaceable>
 
111
        PLUGIN</replaceable><literal>:</literal><replaceable
 
112
        >OPTIONS</replaceable> </option></arg>
 
113
      </group>
 
114
      <sbr/>
 
115
      <group rep="repeat">
 
116
        <arg choice="plain"><option>--disable=<replaceable
 
117
        >PLUGIN</replaceable></option></arg>
 
118
        <arg choice="plain"><option>-d
 
119
        <replaceable>PLUGIN</replaceable> </option></arg>
 
120
      </group>
 
121
      <sbr/>
 
122
      <arg><option>--groupid=<replaceable
 
123
      >ID</replaceable></option></arg>
 
124
      <sbr/>
 
125
      <arg><option>--userid=<replaceable
 
126
      >ID</replaceable></option></arg>
 
127
      <sbr/>
 
128
      <arg><option>--plugin-dir=<replaceable
 
129
      >DIRECTORY</replaceable></option></arg>
 
130
      <sbr/>
 
131
      <arg><option>--debug</option></arg>
 
132
    </cmdsynopsis>
 
133
    <cmdsynopsis>
 
134
      <command>&COMMANDNAME;</command>
 
135
      <group choice="req">
 
136
        <arg choice='plain'><option>--help</option></arg>
 
137
        <arg choice='plain'><option>-?</option></arg>
 
138
      </group>
 
139
    </cmdsynopsis>
 
140
    <cmdsynopsis>
 
141
      <command>&COMMANDNAME;</command>
 
142
      <arg choice='plain'><option>--usage</option></arg>
 
143
    </cmdsynopsis>
 
144
    <cmdsynopsis>
 
145
      <command>&COMMANDNAME;</command>
 
146
      <group choice="req">
 
147
        <arg choice='plain'><option>--version</option></arg>
 
148
        <arg choice='plain'><option>-V</option></arg>
 
149
      </group>
 
150
    </cmdsynopsis>
96
151
  </refsynopsisdiv>
97
152
 
98
153
  <refsect1 id="description">
106
161
      and subsequlently started in the initrd environment. See
107
162
      <citerefentry><refentrytitle>crypttab</refentrytitle>
108
163
      <manvolnum>5</manvolnum></citerefentry> for more information on
109
 
      keyscripts.    
 
164
      keyscripts.
110
165
    </para>
111
166
 
112
167
    <para>
118
173
    <title>OPTIONS</title>
119
174
    <variablelist>
120
175
      <varlistentry>
121
 
        <term><literal>-g</literal>,<literal>--global-options
122
 
        <replaceable>OPTIONS</replaceable></literal></term>
 
176
        <term><option>--global-options
 
177
        <replaceable>OPTIONS</replaceable></option></term>
 
178
        <term><option>-g
 
179
        <replaceable>OPTIONS</replaceable></option></term>
123
180
        <listitem>
124
181
          <para>
125
182
            Global options given to all plugins as additional start
126
183
            arguments.  Options are specified with a -o flag followed
127
184
            by a comma separated string of options.
128
 
          </para>         
 
185
          </para>       
129
186
        </listitem>
130
187
      </varlistentry>
131
188
 
132
189
      <varlistentry>
133
 
        <term><literal>-o</literal>,<literal> --options-for
134
 
        <replaceable>PLUGIN</replaceable>:<replaceable>OPTION</replaceable>
135
 
        </literal></term>
 
190
        <term><option>--options-for
 
191
        <replaceable>PLUGIN</replaceable><literal>:</literal
 
192
        ><replaceable>OPTION</replaceable></option></term>
 
193
        <term><option>-o
 
194
        <replaceable>PLUGIN</replaceable><literal>:</literal
 
195
        ><replaceable>OPTION</replaceable></option></term>
136
196
        <listitem>
137
197
          <para>
138
198
            Plugin specific options given to the plugin as additional
139
199
            start arguments.  Options are specified with a -o flag
140
200
            followed by a comma separated string of options.
141
 
          </para>         
 
201
          </para>       
142
202
        </listitem>
143
 
      </varlistentry>      
 
203
      </varlistentry>
144
204
 
145
205
      <varlistentry>
146
 
        <term><literal>-d</literal>,<literal> --disable
147
 
        <replaceable>PLUGIN</replaceable>
148
 
        </literal></term>
 
206
        <term><option> --disable
 
207
        <replaceable>PLUGIN</replaceable></option></term>
 
208
        <term><option>-d
 
209
        <replaceable>PLUGIN</replaceable></option></term>
149
210
        <listitem>
150
211
          <para>
151
212
            Disable a specific plugin
152
 
          </para>         
 
213
          </para>       
153
214
        </listitem>
154
215
      </varlistentry>
155
216
 
156
217
      <varlistentry>
157
 
        <term><literal>--groupid <replaceable>ID</replaceable>
158
 
        </literal></term>
 
218
        <term><option>--groupid
 
219
        <replaceable>ID</replaceable></option></term>
159
220
        <listitem>
160
221
          <para>
161
222
            Group ID the plugins will run as
162
223
          </para>
163
224
        </listitem>
164
 
      </varlistentry>      
 
225
      </varlistentry>
165
226
 
166
227
      <varlistentry>
167
 
        <term><literal>--userid <replaceable>ID</replaceable>
168
 
        </literal></term>
 
228
        <term><option>--userid
 
229
        <replaceable>ID</replaceable></option></term>
169
230
        <listitem>
170
231
          <para>
171
232
            User ID the plugins will run as
172
233
          </para>
173
234
        </listitem>
174
 
      </varlistentry>      
 
235
      </varlistentry>
175
236
 
176
237
      <varlistentry>
177
 
        <term><literal>--plugin-dir <replaceable>DIRECTORY</replaceable>
178
 
        </literal></term>
 
238
        <term><option>--plugin-dir
 
239
        <replaceable>DIRECTORY</replaceable></option></term>
179
240
        <listitem>
180
241
          <para>
181
242
            Specify a different plugin directory
182
243
          </para>
183
244
        </listitem>
184
 
      </varlistentry>       
 
245
      </varlistentry>
185
246
      
186
247
      <varlistentry>
187
 
        <term><literal>--debug</literal></term>
 
248
        <term><option>--debug</option></term>
188
249
        <listitem>
189
250
          <para>
190
251
            Debug mode
193
254
      </varlistentry>
194
255
      
195
256
      <varlistentry>
196
 
        <term><literal>-?</literal>, <literal>--help</literal></term>
 
257
        <term><option>--help</option></term>
 
258
        <term><option>-?</option></term>
197
259
        <listitem>
198
260
          <para>
199
261
            Gives a help message
202
264
      </varlistentry>
203
265
      
204
266
      <varlistentry>
205
 
        <term><literal>--usage</literal></term>
 
267
        <term><option>--usage</option></term>
206
268
        <listitem>
207
269
          <para>
208
270
            Gives a short usage message
211
273
      </varlistentry>
212
274
 
213
275
      <varlistentry>
214
 
        <term><literal>-V</literal>, <literal>--version</literal></term>
 
276
        <term><option>--version</option></term>
 
277
        <term><option>-V</option></term>
215
278
        <listitem>
216
279
          <para>
217
280
            Prints the program version
218
281
          </para>
219
282
        </listitem>
220
 
      </varlistentry>            
 
283
      </varlistentry>
221
284
    </variablelist>
222
285
  </refsect1>
223
286
 
230
293
  <refsect1 id="file">
231
294
    <title>FILES</title>
232
295
    <para>
233
 
      </para>
234
 
  </refsect1>  
 
296
    </para>
 
297
  </refsect1>
235
298
 
236
299
  <refsect1 id="notes">
237
300
    <title>NOTES</title>
238
301
    <para>
239
 
      </para>
 
302
    </para>
240
303
  </refsect1>
241
304
  
242
305
  <refsect1 id="bugs">
243
306
    <title>BUGS</title>
244
307
    <para>
245
 
      </para>
246
 
  </refsect1>  
 
308
    </para>
 
309
  </refsect1>
247
310
 
248
311
  <refsect1 id="examples">
249
 
    <title>EXAMPLES</title>
 
312
    <title>EXAMPLE</title>
250
313
    <para>
251
 
      </para>
 
314
    </para>
252
315
  </refsect1>
253
316
 
254
317
  <refsect1 id="security">
255
318
    <title>SECURITY</title>
256
319
    <para>
257
 
      </para>
 
320
    </para>
258
321
  </refsect1>
259
322
 
260
323
  <refsect1 id="see_also">
261
324
    <title>SEE ALSO</title>
262
325
    <para>
 
326
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
 
327
      <manvolnum>8</manvolnum></citerefentry>,
263
328
      <citerefentry><refentrytitle>mandos</refentrytitle>
264
 
      <manvolnum>8</manvolnum></citerefentry>, <citerefentry>
265
 
      <refentrytitle>password-request</refentrytitle>
266
 
      <manvolnum>8mandos</manvolnum></citerefentry> and <citerefentry>
267
 
      <refentrytitle>password-prompt</refentrytitle>
 
329
      <manvolnum>8</manvolnum></citerefentry>,
 
330
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
 
331
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
332
      <citerefentry><refentrytitle>password-request</refentrytitle>
268
333
      <manvolnum>8mandos</manvolnum></citerefentry>
269
334
    </para>
270
335
  </refsect1>
271
336
 
272
337
</refentry>
 
338
<!-- Local Variables: -->
 
339
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
340
<!-- time-stamp-end: "[\"']>" -->
 
341
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
342
<!-- End: -->