/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 14:00:36 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080831140036-5bruinjq267s5f8p
* mandos-clients.conf.xml: Changed all single quotes to double quotes
                           for consistency.
* mandos.conf.xml: - '' -
* plugin-runner.xml: - '' -
* plugins.d/password-request.xml: - '' -

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugin-runner.xml
1
 
<?xml version='1.0' encoding='UTF-8'?>
 
1
<?xml version="1.0" encoding="UTF-8"?>
2
2
<?xml-stylesheet type="text/xsl"
3
3
        href="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"?>
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
7
<!ENTITY COMMANDNAME "plugin-runner">
8
 
<!ENTITY TIMESTAMP "2008-08-29">
 
8
<!ENTITY TIMESTAMP "2008-08-31">
9
9
]>
10
10
 
11
11
<refentry>
12
12
  <refentryinfo>
13
13
    <title>Mandos Manual</title>
14
 
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
 
14
    <!-- Nwalsh’s docbook scripts use this to generate the footer: -->
15
15
    <productname>Mandos</productname>
16
16
    <productnumber>&VERSION;</productnumber>
17
17
    <date>&TIMESTAMP;</date>
33
33
    </authorgroup>
34
34
    <copyright>
35
35
      <year>2008</year>
36
 
      <holder>Teddy Hogeborn &amp; Björn Påhlsson</holder>
 
36
      <holder>Teddy Hogeborn</holder>
 
37
      <holder>Björn Påhlsson</holder>
37
38
    </copyright>
38
39
    <legalnotice>
39
40
      <para>
68
69
  <refnamediv>
69
70
    <refname><command>&COMMANDNAME;</command></refname>
70
71
    <refpurpose>
71
 
      get password for encrypted rootdisk
 
72
      Run Mandos plugins.  Pass data from first succesful one.
72
73
    </refpurpose>
73
74
  </refnamediv>
74
75
 
75
76
  <refsynopsisdiv>
76
77
    <cmdsynopsis>
77
78
      <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>    
 
79
      <group rep="repeat">
 
80
        <arg choice="plain"><option>--global-envs=<replaceable
 
81
        >VAR</replaceable><literal>=</literal><replaceable
 
82
        >value</replaceable></option></arg>
 
83
        <arg choice="plain"><option>-e
 
84
        <replaceable>VAR</replaceable><literal>=</literal><replaceable
 
85
        >value</replaceable> </option></arg>
 
86
      </group>
 
87
      <sbr/>
 
88
      <group rep="repeat">
 
89
        <arg choice="plain"><option>--envs-for=<replaceable
 
90
        >PLUGIN</replaceable><literal>:</literal><replaceable
 
91
        >ENV</replaceable><literal>=</literal><replaceable
 
92
        >value</replaceable></option></arg>
 
93
        <arg choice="plain"><option>-f<replaceable>
 
94
        PLUGIN</replaceable><literal>:</literal><replaceable
 
95
        >ENV</replaceable><literal>=</literal><replaceable
 
96
        >value</replaceable> </option></arg>
 
97
      </group>
 
98
      <sbr/>
 
99
      <group rep="repeat">
 
100
        <arg choice="plain"><option>--global-options=<replaceable
 
101
        >OPTIONS</replaceable></option></arg>
 
102
        <arg choice="plain"><option>-g<replaceable>
 
103
        OPTIONS</replaceable> </option></arg>
 
104
      </group>
 
105
      <sbr/>
 
106
      <group rep="repeat">
 
107
        <arg choice="plain"><option>--options-for=<replaceable
 
108
        >PLUGIN</replaceable><literal>:</literal><replaceable
 
109
        >OPTIONS</replaceable></option></arg>
 
110
        <arg choice="plain"><option>-f<replaceable>
 
111
        PLUGIN</replaceable><literal>:</literal><replaceable
 
112
        >OPTIONS</replaceable> </option></arg>
 
113
      </group>
 
114
      <sbr/>
 
115
      <group rep="repeat">
 
116
        <arg choice="plain"><option>--disable=<replaceable
 
117
        >PLUGIN</replaceable></option></arg>
 
118
        <arg choice="plain"><option>-d
 
119
        <replaceable>PLUGIN</replaceable> </option></arg>
 
120
      </group>
 
121
      <sbr/>
 
122
      <arg><option>--groupid=<replaceable
 
123
      >ID</replaceable></option></arg>
 
124
      <sbr/>
 
125
      <arg><option>--userid=<replaceable
 
126
      >ID</replaceable></option></arg>
 
127
      <sbr/>
 
128
      <arg><option>--plugin-dir=<replaceable
 
129
      >DIRECTORY</replaceable></option></arg>
 
130
      <sbr/>
 
131
      <arg><option>--debug</option></arg>
 
132
    </cmdsynopsis>
 
133
    <cmdsynopsis>
 
134
      <command>&COMMANDNAME;</command>
 
135
      <group choice="req">
 
136
        <arg choice="plain"><option>--help</option></arg>
 
137
        <arg choice="plain"><option>-?</option></arg>
 
138
      </group>
 
139
    </cmdsynopsis>
 
140
    <cmdsynopsis>
 
141
      <command>&COMMANDNAME;</command>
 
142
      <arg choice="plain"><option>--usage</option></arg>
 
143
    </cmdsynopsis>
 
144
    <cmdsynopsis>
 
145
      <command>&COMMANDNAME;</command>
 
146
      <group choice="req">
 
147
        <arg choice="plain"><option>--version</option></arg>
 
148
        <arg choice="plain"><option>-V</option></arg>
 
149
      </group>
 
150
    </cmdsynopsis>
98
151
  </refsynopsisdiv>
99
152
 
100
153
  <refsect1 id="description">
108
161
      and subsequlently started in the initrd environment. See
109
162
      <citerefentry><refentrytitle>crypttab</refentrytitle>
110
163
      <manvolnum>5</manvolnum></citerefentry> for more information on
111
 
      keyscripts.    
 
164
      keyscripts.
112
165
    </para>
113
166
 
114
167
    <para>
120
173
    <title>OPTIONS</title>
121
174
    <variablelist>
122
175
      <varlistentry>
123
 
        <term><literal>-g</literal>,<literal>--global-options
124
 
        <replaceable>OPTIONS</replaceable></literal></term>
 
176
        <term><option>--global-options
 
177
        <replaceable>OPTIONS</replaceable></option></term>
 
178
        <term><option>-g
 
179
        <replaceable>OPTIONS</replaceable></option></term>
125
180
        <listitem>
126
181
          <para>
127
182
            Global options given to all plugins as additional start
128
183
            arguments.  Options are specified with a -o flag followed
129
184
            by a comma separated string of options.
130
 
          </para>         
 
185
          </para>       
131
186
        </listitem>
132
187
      </varlistentry>
133
188
 
134
189
      <varlistentry>
135
 
        <term><literal>-o</literal>,<literal> --options-for
136
 
        <replaceable>PLUGIN</replaceable>:<replaceable>OPTION</replaceable>
137
 
        </literal></term>
 
190
        <term><option>--options-for
 
191
        <replaceable>PLUGIN</replaceable><literal>:</literal
 
192
        ><replaceable>OPTION</replaceable></option></term>
 
193
        <term><option>-o
 
194
        <replaceable>PLUGIN</replaceable><literal>:</literal
 
195
        ><replaceable>OPTION</replaceable></option></term>
138
196
        <listitem>
139
197
          <para>
140
198
            Plugin specific options given to the plugin as additional
141
199
            start arguments.  Options are specified with a -o flag
142
200
            followed by a comma separated string of options.
143
 
          </para>         
 
201
          </para>       
144
202
        </listitem>
145
 
      </varlistentry>      
 
203
      </varlistentry>
146
204
 
147
205
      <varlistentry>
148
 
        <term><literal>-d</literal>,<literal> --disable
149
 
        <replaceable>PLUGIN</replaceable>
150
 
        </literal></term>
 
206
        <term><option> --disable
 
207
        <replaceable>PLUGIN</replaceable></option></term>
 
208
        <term><option>-d
 
209
        <replaceable>PLUGIN</replaceable></option></term>
151
210
        <listitem>
152
211
          <para>
153
212
            Disable a specific plugin
154
 
          </para>         
 
213
          </para>       
155
214
        </listitem>
156
215
      </varlistentry>
157
216
 
158
217
      <varlistentry>
159
 
        <term><literal>--groupid <replaceable>ID</replaceable>
160
 
        </literal></term>
 
218
        <term><option>--groupid
 
219
        <replaceable>ID</replaceable></option></term>
161
220
        <listitem>
162
221
          <para>
163
222
            Group ID the plugins will run as
164
223
          </para>
165
224
        </listitem>
166
 
      </varlistentry>      
 
225
      </varlistentry>
167
226
 
168
227
      <varlistentry>
169
 
        <term><literal>--userid <replaceable>ID</replaceable>
170
 
        </literal></term>
 
228
        <term><option>--userid
 
229
        <replaceable>ID</replaceable></option></term>
171
230
        <listitem>
172
231
          <para>
173
232
            User ID the plugins will run as
174
233
          </para>
175
234
        </listitem>
176
 
      </varlistentry>      
 
235
      </varlistentry>
177
236
 
178
237
      <varlistentry>
179
 
        <term><literal>--plugin-dir <replaceable>DIRECTORY</replaceable>
180
 
        </literal></term>
 
238
        <term><option>--plugin-dir
 
239
        <replaceable>DIRECTORY</replaceable></option></term>
181
240
        <listitem>
182
241
          <para>
183
242
            Specify a different plugin directory
184
243
          </para>
185
244
        </listitem>
186
 
      </varlistentry>       
 
245
      </varlistentry>
187
246
      
188
247
      <varlistentry>
189
 
        <term><literal>--debug</literal></term>
 
248
        <term><option>--debug</option></term>
190
249
        <listitem>
191
250
          <para>
192
251
            Debug mode
195
254
      </varlistentry>
196
255
      
197
256
      <varlistentry>
198
 
        <term><literal>-?</literal>, <literal>--help</literal></term>
 
257
        <term><option>--help</option></term>
 
258
        <term><option>-?</option></term>
199
259
        <listitem>
200
260
          <para>
201
261
            Gives a help message
204
264
      </varlistentry>
205
265
      
206
266
      <varlistentry>
207
 
        <term><literal>--usage</literal></term>
 
267
        <term><option>--usage</option></term>
208
268
        <listitem>
209
269
          <para>
210
270
            Gives a short usage message
213
273
      </varlistentry>
214
274
 
215
275
      <varlistentry>
216
 
        <term><literal>-V</literal>, <literal>--version</literal></term>
 
276
        <term><option>--version</option></term>
 
277
        <term><option>-V</option></term>
217
278
        <listitem>
218
279
          <para>
219
280
            Prints the program version
220
281
          </para>
221
282
        </listitem>
222
 
      </varlistentry>            
 
283
      </varlistentry>
223
284
    </variablelist>
224
285
  </refsect1>
225
286
 
233
294
    <title>FILES</title>
234
295
    <para>
235
296
    </para>
236
 
  </refsect1>  
 
297
  </refsect1>
237
298
 
238
299
  <refsect1 id="notes">
239
300
    <title>NOTES</title>
245
306
    <title>BUGS</title>
246
307
    <para>
247
308
    </para>
248
 
  </refsect1>  
 
309
  </refsect1>
249
310
 
250
311
  <refsect1 id="examples">
251
312
    <title>EXAMPLE</title>