/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

merge

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugin-runner.xml
1
 
<?xml version='1.0' encoding='UTF-8'?>
2
 
<?xml-stylesheet type="text/xsl"
3
 
        href="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"?>
 
1
<?xml version="1.0" encoding="UTF-8"?>
4
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
5
3
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
6
4
<!ENTITY VERSION "1.0">
7
5
<!ENTITY COMMANDNAME "plugin-runner">
 
6
<!ENTITY TIMESTAMP "2008-08-31">
8
7
]>
9
8
 
10
 
<refentry>
 
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
11
10
  <refentryinfo>
12
 
    <title>&COMMANDNAME;</title>
13
 
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
14
 
    <productname>&COMMANDNAME;</productname>
 
11
    <title>Mandos Manual</title>
 
12
    <!-- Nwalsh’s docbook scripts use this to generate the footer: -->
 
13
    <productname>Mandos</productname>
15
14
    <productnumber>&VERSION;</productnumber>
 
15
    <date>&TIMESTAMP;</date>
16
16
    <authorgroup>
17
17
      <author>
18
18
        <firstname>Björn</firstname>
31
31
    </authorgroup>
32
32
    <copyright>
33
33
      <year>2008</year>
34
 
      <holder>Teddy Hogeborn &amp; Björn Påhlsson</holder>
 
34
      <holder>Teddy Hogeborn</holder>
 
35
      <holder>Björn Påhlsson</holder>
35
36
    </copyright>
36
 
    <legalnotice>
37
 
      <para>
38
 
        This manual page is free software: you can redistribute it
39
 
        and/or modify it under the terms of the GNU General Public
40
 
        License as published by the Free Software Foundation,
41
 
        either version 3 of the License, or (at your option) any
42
 
        later version.
43
 
      </para>
44
 
 
45
 
      <para>
46
 
        This manual page is distributed in the hope that it will
47
 
        be useful, but WITHOUT ANY WARRANTY; without even the
48
 
        implied warranty of MERCHANTABILITY or FITNESS FOR A
49
 
        PARTICULAR PURPOSE.  See the GNU General Public License
50
 
        for more details.
51
 
      </para>
52
 
 
53
 
      <para>
54
 
        You should have received a copy of the GNU General Public
55
 
        License along with this program; If not, see
56
 
        <ulink url="http://www.gnu.org/licenses/"/>.
57
 
      </para>
58
 
    </legalnotice>
 
37
    <xi:include href="legalnotice.xml"/>
59
38
  </refentryinfo>
60
39
 
61
40
  <refmeta>
66
45
  <refnamediv>
67
46
    <refname><command>&COMMANDNAME;</command></refname>
68
47
    <refpurpose>
69
 
      get password for encrypted rootdisk
 
48
      Run Mandos plugins.  Pass data from first succesful one.
70
49
    </refpurpose>
71
50
  </refnamediv>
72
51
 
73
52
  <refsynopsisdiv>
74
53
    <cmdsynopsis>
75
54
      <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>    
 
55
      <group rep="repeat">
 
56
        <arg choice="plain"><option>--global-envs=<replaceable
 
57
        >VAR</replaceable><literal>=</literal><replaceable
 
58
        >value</replaceable></option></arg>
 
59
        <arg choice="plain"><option>-e
 
60
        <replaceable>VAR</replaceable><literal>=</literal><replaceable
 
61
        >value</replaceable> </option></arg>
 
62
      </group>
 
63
      <sbr/>
 
64
      <group rep="repeat">
 
65
        <arg choice="plain"><option>--envs-for=<replaceable
 
66
        >PLUGIN</replaceable><literal>:</literal><replaceable
 
67
        >ENV</replaceable><literal>=</literal><replaceable
 
68
        >value</replaceable></option></arg>
 
69
        <arg choice="plain"><option>-f<replaceable>
 
70
        PLUGIN</replaceable><literal>:</literal><replaceable
 
71
        >ENV</replaceable><literal>=</literal><replaceable
 
72
        >value</replaceable> </option></arg>
 
73
      </group>
 
74
      <sbr/>
 
75
      <group rep="repeat">
 
76
        <arg choice="plain"><option>--global-options=<replaceable
 
77
        >OPTIONS</replaceable></option></arg>
 
78
        <arg choice="plain"><option>-g<replaceable>
 
79
        OPTIONS</replaceable> </option></arg>
 
80
      </group>
 
81
      <sbr/>
 
82
      <group rep="repeat">
 
83
        <arg choice="plain"><option>--options-for=<replaceable
 
84
        >PLUGIN</replaceable><literal>:</literal><replaceable
 
85
        >OPTIONS</replaceable></option></arg>
 
86
        <arg choice="plain"><option>-f<replaceable>
 
87
        PLUGIN</replaceable><literal>:</literal><replaceable
 
88
        >OPTIONS</replaceable> </option></arg>
 
89
      </group>
 
90
      <sbr/>
 
91
      <group rep="repeat">
 
92
        <arg choice="plain"><option>--disable=<replaceable
 
93
        >PLUGIN</replaceable></option></arg>
 
94
        <arg choice="plain"><option>-d
 
95
        <replaceable>PLUGIN</replaceable> </option></arg>
 
96
      </group>
 
97
      <sbr/>
 
98
      <arg><option>--groupid=<replaceable
 
99
      >ID</replaceable></option></arg>
 
100
      <sbr/>
 
101
      <arg><option>--userid=<replaceable
 
102
      >ID</replaceable></option></arg>
 
103
      <sbr/>
 
104
      <arg><option>--plugin-dir=<replaceable
 
105
      >DIRECTORY</replaceable></option></arg>
 
106
      <sbr/>
 
107
      <arg><option>--debug</option></arg>
 
108
    </cmdsynopsis>
 
109
    <cmdsynopsis>
 
110
      <command>&COMMANDNAME;</command>
 
111
      <group choice="req">
 
112
        <arg choice="plain"><option>--help</option></arg>
 
113
        <arg choice="plain"><option>-?</option></arg>
 
114
      </group>
 
115
    </cmdsynopsis>
 
116
    <cmdsynopsis>
 
117
      <command>&COMMANDNAME;</command>
 
118
      <arg choice="plain"><option>--usage</option></arg>
 
119
    </cmdsynopsis>
 
120
    <cmdsynopsis>
 
121
      <command>&COMMANDNAME;</command>
 
122
      <group choice="req">
 
123
        <arg choice="plain"><option>--version</option></arg>
 
124
        <arg choice="plain"><option>-V</option></arg>
 
125
      </group>
 
126
    </cmdsynopsis>
96
127
  </refsynopsisdiv>
97
128
 
98
129
  <refsect1 id="description">
106
137
      and subsequlently started in the initrd environment. See
107
138
      <citerefentry><refentrytitle>crypttab</refentrytitle>
108
139
      <manvolnum>5</manvolnum></citerefentry> for more information on
109
 
      keyscripts.    
 
140
      keyscripts.
110
141
    </para>
111
142
 
112
143
    <para>
118
149
    <title>OPTIONS</title>
119
150
    <variablelist>
120
151
      <varlistentry>
121
 
        <term><literal>-g</literal>,<literal>--global-options
122
 
        <replaceable>OPTIONS</replaceable></literal></term>
 
152
        <term><option>--global-options
 
153
        <replaceable>OPTIONS</replaceable></option></term>
 
154
        <term><option>-g
 
155
        <replaceable>OPTIONS</replaceable></option></term>
123
156
        <listitem>
124
157
          <para>
125
158
            Global options given to all plugins as additional start
126
159
            arguments.  Options are specified with a -o flag followed
127
160
            by a comma separated string of options.
128
 
          </para>         
 
161
          </para>       
129
162
        </listitem>
130
163
      </varlistentry>
131
164
 
132
165
      <varlistentry>
133
 
        <term><literal>-o</literal>,<literal> --options-for
134
 
        <replaceable>PLUGIN</replaceable>:<replaceable>OPTION</replaceable>
135
 
        </literal></term>
 
166
        <term><option>--options-for
 
167
        <replaceable>PLUGIN</replaceable><literal>:</literal
 
168
        ><replaceable>OPTION</replaceable></option></term>
 
169
        <term><option>-o
 
170
        <replaceable>PLUGIN</replaceable><literal>:</literal
 
171
        ><replaceable>OPTION</replaceable></option></term>
136
172
        <listitem>
137
173
          <para>
138
174
            Plugin specific options given to the plugin as additional
139
175
            start arguments.  Options are specified with a -o flag
140
176
            followed by a comma separated string of options.
141
 
          </para>         
 
177
          </para>       
142
178
        </listitem>
143
 
      </varlistentry>      
 
179
      </varlistentry>
144
180
 
145
181
      <varlistentry>
146
 
        <term><literal>-d</literal>,<literal> --disable
147
 
        <replaceable>PLUGIN</replaceable>
148
 
        </literal></term>
 
182
        <term><option> --disable
 
183
        <replaceable>PLUGIN</replaceable></option></term>
 
184
        <term><option>-d
 
185
        <replaceable>PLUGIN</replaceable></option></term>
149
186
        <listitem>
150
187
          <para>
151
188
            Disable a specific plugin
152
 
          </para>         
 
189
          </para>       
153
190
        </listitem>
154
191
      </varlistentry>
155
192
 
156
193
      <varlistentry>
157
 
        <term><literal>--groupid <replaceable>ID</replaceable>
158
 
        </literal></term>
 
194
        <term><option>--groupid
 
195
        <replaceable>ID</replaceable></option></term>
159
196
        <listitem>
160
197
          <para>
161
198
            Group ID the plugins will run as
162
199
          </para>
163
200
        </listitem>
164
 
      </varlistentry>      
 
201
      </varlistentry>
165
202
 
166
203
      <varlistentry>
167
 
        <term><literal>--userid <replaceable>ID</replaceable>
168
 
        </literal></term>
 
204
        <term><option>--userid
 
205
        <replaceable>ID</replaceable></option></term>
169
206
        <listitem>
170
207
          <para>
171
208
            User ID the plugins will run as
172
209
          </para>
173
210
        </listitem>
174
 
      </varlistentry>      
 
211
      </varlistentry>
175
212
 
176
213
      <varlistentry>
177
 
        <term><literal>--plugin-dir <replaceable>DIRECTORY</replaceable>
178
 
        </literal></term>
 
214
        <term><option>--plugin-dir
 
215
        <replaceable>DIRECTORY</replaceable></option></term>
179
216
        <listitem>
180
217
          <para>
181
218
            Specify a different plugin directory
182
219
          </para>
183
220
        </listitem>
184
 
      </varlistentry>       
 
221
      </varlistentry>
185
222
      
186
223
      <varlistentry>
187
 
        <term><literal>--debug</literal></term>
 
224
        <term><option>--debug</option></term>
188
225
        <listitem>
189
226
          <para>
190
227
            Debug mode
193
230
      </varlistentry>
194
231
      
195
232
      <varlistentry>
196
 
        <term><literal>-?</literal>, <literal>--help</literal></term>
 
233
        <term><option>--help</option></term>
 
234
        <term><option>-?</option></term>
197
235
        <listitem>
198
236
          <para>
199
237
            Gives a help message
202
240
      </varlistentry>
203
241
      
204
242
      <varlistentry>
205
 
        <term><literal>--usage</literal></term>
 
243
        <term><option>--usage</option></term>
206
244
        <listitem>
207
245
          <para>
208
246
            Gives a short usage message
211
249
      </varlistentry>
212
250
 
213
251
      <varlistentry>
214
 
        <term><literal>-V</literal>, <literal>--version</literal></term>
 
252
        <term><option>--version</option></term>
 
253
        <term><option>-V</option></term>
215
254
        <listitem>
216
255
          <para>
217
256
            Prints the program version
218
257
          </para>
219
258
        </listitem>
220
 
      </varlistentry>            
 
259
      </varlistentry>
221
260
    </variablelist>
222
261
  </refsect1>
223
262
 
231
270
    <title>FILES</title>
232
271
    <para>
233
272
    </para>
234
 
  </refsect1>  
 
273
  </refsect1>
235
274
 
236
275
  <refsect1 id="notes">
237
276
    <title>NOTES</title>
243
282
    <title>BUGS</title>
244
283
    <para>
245
284
    </para>
246
 
  </refsect1>  
 
285
  </refsect1>
247
286
 
248
287
  <refsect1 id="examples">
249
 
    <title>EXAMPLES</title>
 
288
    <title>EXAMPLE</title>
250
289
    <para>
251
290
    </para>
252
291
  </refsect1>
260
299
  <refsect1 id="see_also">
261
300
    <title>SEE ALSO</title>
262
301
    <para>
 
302
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
 
303
      <manvolnum>8</manvolnum></citerefentry>,
263
304
      <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>
 
305
      <manvolnum>8</manvolnum></citerefentry>,
 
306
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
 
307
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
308
      <citerefentry><refentrytitle>password-request</refentrytitle>
 
309
      <manvolnum>8mandos</manvolnum></citerefentry>
271
310
    </para>
272
311
  </refsect1>
273
312
 
274
313
</refentry>
 
314
<!-- Local Variables: -->
 
315
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
316
<!-- time-stamp-end: "[\"']>" -->
 
317
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
318
<!-- End: -->