/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to plugin-runner.xml

  • Committer: Teddy Hogeborn
  • Date: 2008-08-31 12:23:33 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080831122333-qgppahxb4d4b0coc
* plugins.d/password-request.xml (OPTIONS): Make replaceables match
                                            the ones in the SYNOPSIS.
                                            Split <term> tags into one
                                            for each option.  Use
                                            <option> tags instead of
                                            <literal>.  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-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">
106
160
      and subsequlently started in the initrd environment. See
107
161
      <citerefentry><refentrytitle>crypttab</refentrytitle>
108
162
      <manvolnum>5</manvolnum></citerefentry> for more information on
109
 
      keyscripts.    
 
163
      keyscripts.
110
164
    </para>
111
165
 
112
166
    <para>
118
172
    <title>OPTIONS</title>
119
173
    <variablelist>
120
174
      <varlistentry>
121
 
        <term><literal>-g</literal>,<literal>--global-options
122
 
        <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>
123
179
        <listitem>
124
180
          <para>
125
181
            Global options given to all plugins as additional start
126
182
            arguments.  Options are specified with a -o flag followed
127
183
            by a comma separated string of options.
128
 
          </para>         
 
184
          </para>       
129
185
        </listitem>
130
186
      </varlistentry>
131
187
 
132
188
      <varlistentry>
133
 
        <term><literal>-o</literal>,<literal> --options-for
134
 
        <replaceable>PLUGIN</replaceable>:<replaceable>OPTION</replaceable>
135
 
        </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>
136
195
        <listitem>
137
196
          <para>
138
197
            Plugin specific options given to the plugin as additional
139
198
            start arguments.  Options are specified with a -o flag
140
199
            followed by a comma separated string of options.
141
 
          </para>         
 
200
          </para>       
142
201
        </listitem>
143
 
      </varlistentry>      
 
202
      </varlistentry>
144
203
 
145
204
      <varlistentry>
146
 
        <term><literal>-d</literal>,<literal> --disable
147
 
        <replaceable>PLUGIN</replaceable>
148
 
        </literal></term>
 
205
        <term><option> --disable
 
206
        <replaceable>PLUGIN</replaceable></option></term>
 
207
        <term><option>-d
 
208
        <replaceable>PLUGIN</replaceable></option></term>
149
209
        <listitem>
150
210
          <para>
151
211
            Disable a specific plugin
152
 
          </para>         
 
212
          </para>       
153
213
        </listitem>
154
214
      </varlistentry>
155
215
 
156
216
      <varlistentry>
157
 
        <term><literal>--groupid <replaceable>ID</replaceable>
158
 
        </literal></term>
 
217
        <term><option>--groupid
 
218
        <replaceable>ID</replaceable></option></term>
159
219
        <listitem>
160
220
          <para>
161
221
            Group ID the plugins will run as
162
222
          </para>
163
223
        </listitem>
164
 
      </varlistentry>      
 
224
      </varlistentry>
165
225
 
166
226
      <varlistentry>
167
 
        <term><literal>--userid <replaceable>ID</replaceable>
168
 
        </literal></term>
 
227
        <term><option>--userid
 
228
        <replaceable>ID</replaceable></option></term>
169
229
        <listitem>
170
230
          <para>
171
231
            User ID the plugins will run as
172
232
          </para>
173
233
        </listitem>
174
 
      </varlistentry>      
 
234
      </varlistentry>
175
235
 
176
236
      <varlistentry>
177
 
        <term><literal>--plugin-dir <replaceable>DIRECTORY</replaceable>
178
 
        </literal></term>
 
237
        <term><option>--plugin-dir
 
238
        <replaceable>DIRECTORY</replaceable></option></term>
179
239
        <listitem>
180
240
          <para>
181
241
            Specify a different plugin directory
182
242
          </para>
183
243
        </listitem>
184
 
      </varlistentry>       
 
244
      </varlistentry>
185
245
      
186
246
      <varlistentry>
187
 
        <term><literal>--debug</literal></term>
 
247
        <term><option>--debug</option></term>
188
248
        <listitem>
189
249
          <para>
190
250
            Debug mode
193
253
      </varlistentry>
194
254
      
195
255
      <varlistentry>
196
 
        <term><literal>-?</literal>, <literal>--help</literal></term>
 
256
        <term><option>--help</option></term>
 
257
        <term><option>-?</option></term>
197
258
        <listitem>
198
259
          <para>
199
260
            Gives a help message
202
263
      </varlistentry>
203
264
      
204
265
      <varlistentry>
205
 
        <term><literal>--usage</literal></term>
 
266
        <term><option>--usage</option></term>
206
267
        <listitem>
207
268
          <para>
208
269
            Gives a short usage message
211
272
      </varlistentry>
212
273
 
213
274
      <varlistentry>
214
 
        <term><literal>-V</literal>, <literal>--version</literal></term>
 
275
        <term><option>--version</option></term>
 
276
        <term><option>-V</option></term>
215
277
        <listitem>
216
278
          <para>
217
279
            Prints the program version
218
280
          </para>
219
281
        </listitem>
220
 
      </varlistentry>            
 
282
      </varlistentry>
221
283
    </variablelist>
222
284
  </refsect1>
223
285
 
231
293
    <title>FILES</title>
232
294
    <para>
233
295
    </para>
234
 
  </refsect1>  
 
296
  </refsect1>
235
297
 
236
298
  <refsect1 id="notes">
237
299
    <title>NOTES</title>
243
305
    <title>BUGS</title>
244
306
    <para>
245
307
    </para>
246
 
  </refsect1>  
 
308
  </refsect1>
247
309
 
248
310
  <refsect1 id="examples">
249
 
    <title>EXAMPLES</title>
 
311
    <title>EXAMPLE</title>
250
312
    <para>
251
313
    </para>
252
314
  </refsect1>
260
322
  <refsect1 id="see_also">
261
323
    <title>SEE ALSO</title>
262
324
    <para>
 
325
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
 
326
      <manvolnum>8</manvolnum></citerefentry>,
263
327
      <citerefentry><refentrytitle>mandos</refentrytitle>
264
 
      <manvolnum>8</manvolnum></citerefentry>, <citerefentry>
265
 
      <refentrytitle>password-request</refentrytitle>
266
 
      <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
267
 
      <refentrytitle>password-prompt</refentrytitle>
268
 
      <manvolnum>8mandos</manvolnum></citerefentry>, and
269
 
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
270
 
      <manvolnum>8</manvolnum></citerefentry>
 
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>
271
333
    </para>
272
334
  </refsect1>
273
335
 
274
336
</refentry>
 
337
<!-- Local Variables: -->
 
338
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
339
<!-- time-stamp-end: "[\"']>" -->
 
340
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
341
<!-- End: -->