/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-30">
 
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>
179
127
            Global options given to all plugins as additional start
180
128
            arguments.  Options are specified with a -o flag followed
181
129
            by a comma separated string of options.
182
 
          </para>       
 
130
          </para>         
183
131
        </listitem>
184
132
      </varlistentry>
185
133
 
192
140
            Plugin specific options given to the plugin as additional
193
141
            start arguments.  Options are specified with a -o flag
194
142
            followed by a comma separated string of options.
195
 
          </para>       
 
143
          </para>         
196
144
        </listitem>
197
 
      </varlistentry>
 
145
      </varlistentry>      
198
146
 
199
147
      <varlistentry>
200
148
        <term><literal>-d</literal>,<literal> --disable
203
151
        <listitem>
204
152
          <para>
205
153
            Disable a specific plugin
206
 
          </para>       
 
154
          </para>         
207
155
        </listitem>
208
156
      </varlistentry>
209
157
 
215
163
            Group ID the plugins will run as
216
164
          </para>
217
165
        </listitem>
218
 
      </varlistentry>
 
166
      </varlistentry>      
219
167
 
220
168
      <varlistentry>
221
169
        <term><literal>--userid <replaceable>ID</replaceable>
225
173
            User ID the plugins will run as
226
174
          </para>
227
175
        </listitem>
228
 
      </varlistentry>
 
176
      </varlistentry>      
229
177
 
230
178
      <varlistentry>
231
179
        <term><literal>--plugin-dir <replaceable>DIRECTORY</replaceable>
235
183
            Specify a different plugin directory
236
184
          </para>
237
185
        </listitem>
238
 
      </varlistentry>
 
186
      </varlistentry>       
239
187
      
240
188
      <varlistentry>
241
189
        <term><literal>--debug</literal></term>
271
219
            Prints the program version
272
220
          </para>
273
221
        </listitem>
274
 
      </varlistentry>
 
222
      </varlistentry>            
275
223
    </variablelist>
276
224
  </refsect1>
277
225
 
285
233
    <title>FILES</title>
286
234
    <para>
287
235
    </para>
288
 
  </refsect1>
 
236
  </refsect1>  
289
237
 
290
238
  <refsect1 id="notes">
291
239
    <title>NOTES</title>
297
245
    <title>BUGS</title>
298
246
    <para>
299
247
    </para>
300
 
  </refsect1>
 
248
  </refsect1>  
301
249
 
302
250
  <refsect1 id="examples">
303
251
    <title>EXAMPLE</title>
314
262
  <refsect1 id="see_also">
315
263
    <title>SEE ALSO</title>
316
264
    <para>
317
 
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
318
 
      <manvolnum>8</manvolnum></citerefentry>,
319
265
      <citerefentry><refentrytitle>mandos</refentrytitle>
320
 
      <manvolnum>8</manvolnum></citerefentry>,
321
 
      <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>
322
270
      <manvolnum>8mandos</manvolnum></citerefentry>,
323
 
      <citerefentry><refentrytitle>password-request</refentrytitle>
324
 
      <manvolnum>8mandos</manvolnum></citerefentry>
 
271
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
 
272
      <manvolnum>8</manvolnum></citerefentry>
325
273
    </para>
326
274
  </refsect1>
327
275