/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-31 16:04:47 UTC
  • mfrom: (24.1.77 mandos)
  • Revision ID: teddy@fukt.bsnet.se-20080831160447-2xte5k90onspphki
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">
8
 
<!ENTITY TIMESTAMP "2008-08-29">
 
6
<!ENTITY TIMESTAMP "2008-08-31">
9
7
]>
10
8
 
11
 
<refentry>
 
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
12
10
  <refentryinfo>
13
11
    <title>Mandos Manual</title>
14
 
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
 
12
    <!-- Nwalsh’s docbook scripts use this to generate the footer: -->
15
13
    <productname>Mandos</productname>
16
14
    <productnumber>&VERSION;</productnumber>
17
15
    <date>&TIMESTAMP;</date>
33
31
    </authorgroup>
34
32
    <copyright>
35
33
      <year>2008</year>
36
 
      <holder>Teddy Hogeborn &amp; Björn Påhlsson</holder>
 
34
      <holder>Teddy Hogeborn</holder>
 
35
      <holder>Björn Påhlsson</holder>
37
36
    </copyright>
38
 
    <legalnotice>
39
 
      <para>
40
 
        This manual page is free software: you can redistribute it
41
 
        and/or modify it under the terms of the GNU General Public
42
 
        License as published by the Free Software Foundation,
43
 
        either version 3 of the License, or (at your option) any
44
 
        later version.
45
 
      </para>
46
 
 
47
 
      <para>
48
 
        This manual page is distributed in the hope that it will
49
 
        be useful, but WITHOUT ANY WARRANTY; without even the
50
 
        implied warranty of MERCHANTABILITY or FITNESS FOR A
51
 
        PARTICULAR PURPOSE.  See the GNU General Public License
52
 
        for more details.
53
 
      </para>
54
 
 
55
 
      <para>
56
 
        You should have received a copy of the GNU General Public
57
 
        License along with this program; If not, see
58
 
        <ulink url="http://www.gnu.org/licenses/"/>.
59
 
      </para>
60
 
    </legalnotice>
 
37
    <xi:include href="legalnotice.xml"/>
61
38
  </refentryinfo>
62
39
 
63
40
  <refmeta>
68
45
  <refnamediv>
69
46
    <refname><command>&COMMANDNAME;</command></refname>
70
47
    <refpurpose>
71
 
      get password for encrypted rootdisk
 
48
      Run Mandos plugins.  Pass data from first succesful one.
72
49
    </refpurpose>
73
50
  </refnamediv>
74
51
 
75
52
  <refsynopsisdiv>
76
53
    <cmdsynopsis>
77
54
      <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>    
 
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>
98
127
  </refsynopsisdiv>
99
128
 
100
129
  <refsect1 id="description">
108
137
      and subsequlently started in the initrd environment. See
109
138
      <citerefentry><refentrytitle>crypttab</refentrytitle>
110
139
      <manvolnum>5</manvolnum></citerefentry> for more information on
111
 
      keyscripts.    
 
140
      keyscripts.
112
141
    </para>
113
142
 
114
143
    <para>
120
149
    <title>OPTIONS</title>
121
150
    <variablelist>
122
151
      <varlistentry>
123
 
        <term><literal>-g</literal>,<literal>--global-options
124
 
        <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>
125
156
        <listitem>
126
157
          <para>
127
158
            Global options given to all plugins as additional start
128
159
            arguments.  Options are specified with a -o flag followed
129
160
            by a comma separated string of options.
130
 
          </para>         
 
161
          </para>       
131
162
        </listitem>
132
163
      </varlistentry>
133
164
 
134
165
      <varlistentry>
135
 
        <term><literal>-o</literal>,<literal> --options-for
136
 
        <replaceable>PLUGIN</replaceable>:<replaceable>OPTION</replaceable>
137
 
        </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>
138
172
        <listitem>
139
173
          <para>
140
174
            Plugin specific options given to the plugin as additional
141
175
            start arguments.  Options are specified with a -o flag
142
176
            followed by a comma separated string of options.
143
 
          </para>         
 
177
          </para>       
144
178
        </listitem>
145
 
      </varlistentry>      
 
179
      </varlistentry>
146
180
 
147
181
      <varlistentry>
148
 
        <term><literal>-d</literal>,<literal> --disable
149
 
        <replaceable>PLUGIN</replaceable>
150
 
        </literal></term>
 
182
        <term><option> --disable
 
183
        <replaceable>PLUGIN</replaceable></option></term>
 
184
        <term><option>-d
 
185
        <replaceable>PLUGIN</replaceable></option></term>
151
186
        <listitem>
152
187
          <para>
153
188
            Disable a specific plugin
154
 
          </para>         
 
189
          </para>       
155
190
        </listitem>
156
191
      </varlistentry>
157
192
 
158
193
      <varlistentry>
159
 
        <term><literal>--groupid <replaceable>ID</replaceable>
160
 
        </literal></term>
 
194
        <term><option>--groupid
 
195
        <replaceable>ID</replaceable></option></term>
161
196
        <listitem>
162
197
          <para>
163
198
            Group ID the plugins will run as
164
199
          </para>
165
200
        </listitem>
166
 
      </varlistentry>      
 
201
      </varlistentry>
167
202
 
168
203
      <varlistentry>
169
 
        <term><literal>--userid <replaceable>ID</replaceable>
170
 
        </literal></term>
 
204
        <term><option>--userid
 
205
        <replaceable>ID</replaceable></option></term>
171
206
        <listitem>
172
207
          <para>
173
208
            User ID the plugins will run as
174
209
          </para>
175
210
        </listitem>
176
 
      </varlistentry>      
 
211
      </varlistentry>
177
212
 
178
213
      <varlistentry>
179
 
        <term><literal>--plugin-dir <replaceable>DIRECTORY</replaceable>
180
 
        </literal></term>
 
214
        <term><option>--plugin-dir
 
215
        <replaceable>DIRECTORY</replaceable></option></term>
181
216
        <listitem>
182
217
          <para>
183
218
            Specify a different plugin directory
184
219
          </para>
185
220
        </listitem>
186
 
      </varlistentry>       
 
221
      </varlistentry>
187
222
      
188
223
      <varlistentry>
189
 
        <term><literal>--debug</literal></term>
 
224
        <term><option>--debug</option></term>
190
225
        <listitem>
191
226
          <para>
192
227
            Debug mode
195
230
      </varlistentry>
196
231
      
197
232
      <varlistentry>
198
 
        <term><literal>-?</literal>, <literal>--help</literal></term>
 
233
        <term><option>--help</option></term>
 
234
        <term><option>-?</option></term>
199
235
        <listitem>
200
236
          <para>
201
237
            Gives a help message
204
240
      </varlistentry>
205
241
      
206
242
      <varlistentry>
207
 
        <term><literal>--usage</literal></term>
 
243
        <term><option>--usage</option></term>
208
244
        <listitem>
209
245
          <para>
210
246
            Gives a short usage message
213
249
      </varlistentry>
214
250
 
215
251
      <varlistentry>
216
 
        <term><literal>-V</literal>, <literal>--version</literal></term>
 
252
        <term><option>--version</option></term>
 
253
        <term><option>-V</option></term>
217
254
        <listitem>
218
255
          <para>
219
256
            Prints the program version
220
257
          </para>
221
258
        </listitem>
222
 
      </varlistentry>            
 
259
      </varlistentry>
223
260
    </variablelist>
224
261
  </refsect1>
225
262
 
233
270
    <title>FILES</title>
234
271
    <para>
235
272
    </para>
236
 
  </refsect1>  
 
273
  </refsect1>
237
274
 
238
275
  <refsect1 id="notes">
239
276
    <title>NOTES</title>
245
282
    <title>BUGS</title>
246
283
    <para>
247
284
    </para>
248
 
  </refsect1>  
 
285
  </refsect1>
249
286
 
250
287
  <refsect1 id="examples">
251
288
    <title>EXAMPLE</title>