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