/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 16:53:41 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080829165341-xzrp0xxxfrua5kzq
* mandos.xml (SYNOPSIS): Split <term> tags for the "--help" and
                         "--interface" options.

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
<?xml-stylesheet type="text/xsl"
 
3
        href="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"?>
2
4
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
5
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
6
<!ENTITY VERSION "1.0">
5
7
<!ENTITY COMMANDNAME "plugin-runner">
6
 
<!ENTITY TIMESTAMP "2008-08-31">
 
8
<!ENTITY TIMESTAMP "2008-08-29">
7
9
]>
8
10
 
9
 
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
 
11
<refentry>
10
12
  <refentryinfo>
11
13
    <title>Mandos Manual</title>
12
 
    <!-- Nwalsh’s docbook scripts use this to generate the footer: -->
 
14
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
13
15
    <productname>Mandos</productname>
14
16
    <productnumber>&VERSION;</productnumber>
15
17
    <date>&TIMESTAMP;</date>
31
33
    </authorgroup>
32
34
    <copyright>
33
35
      <year>2008</year>
34
 
      <holder>Teddy Hogeborn</holder>
35
 
      <holder>Björn Påhlsson</holder>
 
36
      <holder>Teddy Hogeborn &amp; Björn Påhlsson</holder>
36
37
    </copyright>
37
 
    <xi:include href="legalnotice.xml"/>
 
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>
38
61
  </refentryinfo>
39
62
 
40
63
  <refmeta>
45
68
  <refnamediv>
46
69
    <refname><command>&COMMANDNAME;</command></refname>
47
70
    <refpurpose>
48
 
      Run Mandos plugins.  Pass data from first succesful one.
 
71
      get password for encrypted rootdisk
49
72
    </refpurpose>
50
73
  </refnamediv>
51
74
 
52
75
  <refsynopsisdiv>
53
76
    <cmdsynopsis>
54
77
      <command>&COMMANDNAME;</command>
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>
 
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>    
127
98
  </refsynopsisdiv>
128
99
 
129
100
  <refsect1 id="description">
137
108
      and subsequlently started in the initrd environment. See
138
109
      <citerefentry><refentrytitle>crypttab</refentrytitle>
139
110
      <manvolnum>5</manvolnum></citerefentry> for more information on
140
 
      keyscripts.
 
111
      keyscripts.    
141
112
    </para>
142
113
 
143
114
    <para>
149
120
    <title>OPTIONS</title>
150
121
    <variablelist>
151
122
      <varlistentry>
152
 
        <term><option>--global-options
153
 
        <replaceable>OPTIONS</replaceable></option></term>
154
 
        <term><option>-g
155
 
        <replaceable>OPTIONS</replaceable></option></term>
 
123
        <term><literal>-g</literal>,<literal>--global-options
 
124
        <replaceable>OPTIONS</replaceable></literal></term>
156
125
        <listitem>
157
126
          <para>
158
127
            Global options given to all plugins as additional start
159
128
            arguments.  Options are specified with a -o flag followed
160
129
            by a comma separated string of options.
161
 
          </para>       
 
130
          </para>         
162
131
        </listitem>
163
132
      </varlistentry>
164
133
 
165
134
      <varlistentry>
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>
 
135
        <term><literal>-o</literal>,<literal> --options-for
 
136
        <replaceable>PLUGIN</replaceable>:<replaceable>OPTION</replaceable>
 
137
        </literal></term>
172
138
        <listitem>
173
139
          <para>
174
140
            Plugin specific options given to the plugin as additional
175
141
            start arguments.  Options are specified with a -o flag
176
142
            followed by a comma separated string of options.
177
 
          </para>       
 
143
          </para>         
178
144
        </listitem>
179
 
      </varlistentry>
 
145
      </varlistentry>      
180
146
 
181
147
      <varlistentry>
182
 
        <term><option> --disable
183
 
        <replaceable>PLUGIN</replaceable></option></term>
184
 
        <term><option>-d
185
 
        <replaceable>PLUGIN</replaceable></option></term>
 
148
        <term><literal>-d</literal>,<literal> --disable
 
149
        <replaceable>PLUGIN</replaceable>
 
150
        </literal></term>
186
151
        <listitem>
187
152
          <para>
188
153
            Disable a specific plugin
189
 
          </para>       
 
154
          </para>         
190
155
        </listitem>
191
156
      </varlistentry>
192
157
 
193
158
      <varlistentry>
194
 
        <term><option>--groupid
195
 
        <replaceable>ID</replaceable></option></term>
 
159
        <term><literal>--groupid <replaceable>ID</replaceable>
 
160
        </literal></term>
196
161
        <listitem>
197
162
          <para>
198
163
            Group ID the plugins will run as
199
164
          </para>
200
165
        </listitem>
201
 
      </varlistentry>
 
166
      </varlistentry>      
202
167
 
203
168
      <varlistentry>
204
 
        <term><option>--userid
205
 
        <replaceable>ID</replaceable></option></term>
 
169
        <term><literal>--userid <replaceable>ID</replaceable>
 
170
        </literal></term>
206
171
        <listitem>
207
172
          <para>
208
173
            User ID the plugins will run as
209
174
          </para>
210
175
        </listitem>
211
 
      </varlistentry>
 
176
      </varlistentry>      
212
177
 
213
178
      <varlistentry>
214
 
        <term><option>--plugin-dir
215
 
        <replaceable>DIRECTORY</replaceable></option></term>
 
179
        <term><literal>--plugin-dir <replaceable>DIRECTORY</replaceable>
 
180
        </literal></term>
216
181
        <listitem>
217
182
          <para>
218
183
            Specify a different plugin directory
219
184
          </para>
220
185
        </listitem>
221
 
      </varlistentry>
 
186
      </varlistentry>       
222
187
      
223
188
      <varlistentry>
224
 
        <term><option>--debug</option></term>
 
189
        <term><literal>--debug</literal></term>
225
190
        <listitem>
226
191
          <para>
227
192
            Debug mode
230
195
      </varlistentry>
231
196
      
232
197
      <varlistentry>
233
 
        <term><option>--help</option></term>
234
 
        <term><option>-?</option></term>
 
198
        <term><literal>-?</literal>, <literal>--help</literal></term>
235
199
        <listitem>
236
200
          <para>
237
201
            Gives a help message
240
204
      </varlistentry>
241
205
      
242
206
      <varlistentry>
243
 
        <term><option>--usage</option></term>
 
207
        <term><literal>--usage</literal></term>
244
208
        <listitem>
245
209
          <para>
246
210
            Gives a short usage message
249
213
      </varlistentry>
250
214
 
251
215
      <varlistentry>
252
 
        <term><option>--version</option></term>
253
 
        <term><option>-V</option></term>
 
216
        <term><literal>-V</literal>, <literal>--version</literal></term>
254
217
        <listitem>
255
218
          <para>
256
219
            Prints the program version
257
220
          </para>
258
221
        </listitem>
259
 
      </varlistentry>
 
222
      </varlistentry>            
260
223
    </variablelist>
261
224
  </refsect1>
262
225
 
270
233
    <title>FILES</title>
271
234
    <para>
272
235
    </para>
273
 
  </refsect1>
 
236
  </refsect1>  
274
237
 
275
238
  <refsect1 id="notes">
276
239
    <title>NOTES</title>
282
245
    <title>BUGS</title>
283
246
    <para>
284
247
    </para>
285
 
  </refsect1>
 
248
  </refsect1>  
286
249
 
287
250
  <refsect1 id="examples">
288
251
    <title>EXAMPLE</title>