/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-29 07:14:39 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080829071439-feg1el14hx1abvqg
* mandos-keygen.xml (EXAMPLE): Replaced all occurrences of command
                               name with "&COMMANDNAME;".
* plugin-runner.xml (EXAMPLES): Renamed to "EXAMPLE".  - '' -

Show diffs side-by-side

added added

removed removed

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