/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-30 19:49:24 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080830194924-f4liqq8wxajlbshn
* plugin-runner.xml (NAME): Improved wording.
  (SYNOPSIS): Use <option> and <replaceable> tags.  Unify short and
              long options.  Add "--global-envs" and "--envs-for"
              options.

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-30">
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>
125
179
            Global options given to all plugins as additional start
126
180
            arguments.  Options are specified with a -o flag followed
127
181
            by a comma separated string of options.
128
 
          </para>         
 
182
          </para>       
129
183
        </listitem>
130
184
      </varlistentry>
131
185
 
138
192
            Plugin specific options given to the plugin as additional
139
193
            start arguments.  Options are specified with a -o flag
140
194
            followed by a comma separated string of options.
141
 
          </para>         
 
195
          </para>       
142
196
        </listitem>
143
 
      </varlistentry>      
 
197
      </varlistentry>
144
198
 
145
199
      <varlistentry>
146
200
        <term><literal>-d</literal>,<literal> --disable
149
203
        <listitem>
150
204
          <para>
151
205
            Disable a specific plugin
152
 
          </para>         
 
206
          </para>       
153
207
        </listitem>
154
208
      </varlistentry>
155
209
 
161
215
            Group ID the plugins will run as
162
216
          </para>
163
217
        </listitem>
164
 
      </varlistentry>      
 
218
      </varlistentry>
165
219
 
166
220
      <varlistentry>
167
221
        <term><literal>--userid <replaceable>ID</replaceable>
171
225
            User ID the plugins will run as
172
226
          </para>
173
227
        </listitem>
174
 
      </varlistentry>      
 
228
      </varlistentry>
175
229
 
176
230
      <varlistentry>
177
231
        <term><literal>--plugin-dir <replaceable>DIRECTORY</replaceable>
181
235
            Specify a different plugin directory
182
236
          </para>
183
237
        </listitem>
184
 
      </varlistentry>       
 
238
      </varlistentry>
185
239
      
186
240
      <varlistentry>
187
241
        <term><literal>--debug</literal></term>
217
271
            Prints the program version
218
272
          </para>
219
273
        </listitem>
220
 
      </varlistentry>            
 
274
      </varlistentry>
221
275
    </variablelist>
222
276
  </refsect1>
223
277
 
230
284
  <refsect1 id="file">
231
285
    <title>FILES</title>
232
286
    <para>
233
 
      </para>
234
 
  </refsect1>  
 
287
    </para>
 
288
  </refsect1>
235
289
 
236
290
  <refsect1 id="notes">
237
291
    <title>NOTES</title>
238
292
    <para>
239
 
      </para>
 
293
    </para>
240
294
  </refsect1>
241
295
  
242
296
  <refsect1 id="bugs">
243
297
    <title>BUGS</title>
244
298
    <para>
245
 
      </para>
246
 
  </refsect1>  
 
299
    </para>
 
300
  </refsect1>
247
301
 
248
302
  <refsect1 id="examples">
249
 
    <title>EXAMPLES</title>
 
303
    <title>EXAMPLE</title>
250
304
    <para>
251
 
      </para>
 
305
    </para>
252
306
  </refsect1>
253
307
 
254
308
  <refsect1 id="security">
255
309
    <title>SECURITY</title>
256
310
    <para>
257
 
      </para>
 
311
    </para>
258
312
  </refsect1>
259
313
 
260
314
  <refsect1 id="see_also">
261
315
    <title>SEE ALSO</title>
262
316
    <para>
 
317
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
 
318
      <manvolnum>8</manvolnum></citerefentry>,
263
319
      <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>
 
320
      <manvolnum>8</manvolnum></citerefentry>,
 
321
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
 
322
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
323
      <citerefentry><refentrytitle>password-request</refentrytitle>
268
324
      <manvolnum>8mandos</manvolnum></citerefentry>
269
325
    </para>
270
326
  </refsect1>
271
327
 
272
328
</refentry>
 
329
<!-- Local Variables: -->
 
330
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
331
<!-- time-stamp-end: "[\"']>" -->
 
332
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
333
<!-- End: -->