/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-18 23:55:28 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080818235528-dn628nlbrtzl7z4f
* Makefile: Bug fix: fixed creation of man pages for section 5 pages.

* mandos (main): Changed from requiring "[server]" in mandos.conf(5)
                 to requiring "[DEFAULT]".

* mandos.conf ([server]): Renamed to "[DEFAULT]".

* mandos.conf.xml: Removed <?xml-stylesheet>.  New entity "&OVERVIEW;"
                   referring to "overview.xml".
  (DESCRIPTION): Updated to specify the syntax more precisely.  Use
                 <varname> around the option names.

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">
7
8
]>
8
9
 
9
 
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
 
10
<refentry>
10
11
  <refentryinfo>
11
 
    <title>Mandos Manual</title>
12
 
    <!-- Nwalsh’s docbook scripts use this to generate the footer: -->
13
 
    <productname>Mandos</productname>
 
12
    <title>&COMMANDNAME;</title>
 
13
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
 
14
    <productname>&COMMANDNAME;</productname>
14
15
    <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</holder>
35
 
      <holder>Björn Påhlsson</holder>
 
34
      <holder>Teddy Hogeborn &amp; Björn Påhlsson</holder>
36
35
    </copyright>
37
 
    <xi:include href="legalnotice.xml"/>
 
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>
38
59
  </refentryinfo>
39
60
 
40
61
  <refmeta>
45
66
  <refnamediv>
46
67
    <refname><command>&COMMANDNAME;</command></refname>
47
68
    <refpurpose>
48
 
      Run Mandos plugins.  Pass data from first succesful one.
 
69
      get password for encrypted rootdisk
49
70
    </refpurpose>
50
71
  </refnamediv>
51
72
 
52
73
  <refsynopsisdiv>
53
74
    <cmdsynopsis>
54
75
      <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>
 
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>    
127
96
  </refsynopsisdiv>
128
97
 
129
98
  <refsect1 id="description">
137
106
      and subsequlently started in the initrd environment. See
138
107
      <citerefentry><refentrytitle>crypttab</refentrytitle>
139
108
      <manvolnum>5</manvolnum></citerefentry> for more information on
140
 
      keyscripts.
 
109
      keyscripts.    
141
110
    </para>
142
111
 
143
112
    <para>
149
118
    <title>OPTIONS</title>
150
119
    <variablelist>
151
120
      <varlistentry>
152
 
        <term><option>--global-options
153
 
        <replaceable>OPTIONS</replaceable></option></term>
154
 
        <term><option>-g
155
 
        <replaceable>OPTIONS</replaceable></option></term>
 
121
        <term><literal>-g</literal>,<literal>--global-options
 
122
        <replaceable>OPTIONS</replaceable></literal></term>
156
123
        <listitem>
157
124
          <para>
158
125
            Global options given to all plugins as additional start
159
126
            arguments.  Options are specified with a -o flag followed
160
127
            by a comma separated string of options.
161
 
          </para>       
 
128
          </para>         
162
129
        </listitem>
163
130
      </varlistentry>
164
131
 
165
132
      <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>
 
133
        <term><literal>-o</literal>,<literal> --options-for
 
134
        <replaceable>PLUGIN</replaceable>:<replaceable>OPTION</replaceable>
 
135
        </literal></term>
172
136
        <listitem>
173
137
          <para>
174
138
            Plugin specific options given to the plugin as additional
175
139
            start arguments.  Options are specified with a -o flag
176
140
            followed by a comma separated string of options.
177
 
          </para>       
 
141
          </para>         
178
142
        </listitem>
179
 
      </varlistentry>
 
143
      </varlistentry>      
180
144
 
181
145
      <varlistentry>
182
 
        <term><option> --disable
183
 
        <replaceable>PLUGIN</replaceable></option></term>
184
 
        <term><option>-d
185
 
        <replaceable>PLUGIN</replaceable></option></term>
 
146
        <term><literal>-d</literal>,<literal> --disable
 
147
        <replaceable>PLUGIN</replaceable>
 
148
        </literal></term>
186
149
        <listitem>
187
150
          <para>
188
151
            Disable a specific plugin
189
 
          </para>       
 
152
          </para>         
190
153
        </listitem>
191
154
      </varlistentry>
192
155
 
193
156
      <varlistentry>
194
 
        <term><option>--groupid
195
 
        <replaceable>ID</replaceable></option></term>
 
157
        <term><literal>--groupid <replaceable>ID</replaceable>
 
158
        </literal></term>
196
159
        <listitem>
197
160
          <para>
198
161
            Group ID the plugins will run as
199
162
          </para>
200
163
        </listitem>
201
 
      </varlistentry>
 
164
      </varlistentry>      
202
165
 
203
166
      <varlistentry>
204
 
        <term><option>--userid
205
 
        <replaceable>ID</replaceable></option></term>
 
167
        <term><literal>--userid <replaceable>ID</replaceable>
 
168
        </literal></term>
206
169
        <listitem>
207
170
          <para>
208
171
            User ID the plugins will run as
209
172
          </para>
210
173
        </listitem>
211
 
      </varlistentry>
 
174
      </varlistentry>      
212
175
 
213
176
      <varlistentry>
214
 
        <term><option>--plugin-dir
215
 
        <replaceable>DIRECTORY</replaceable></option></term>
 
177
        <term><literal>--plugin-dir <replaceable>DIRECTORY</replaceable>
 
178
        </literal></term>
216
179
        <listitem>
217
180
          <para>
218
181
            Specify a different plugin directory
219
182
          </para>
220
183
        </listitem>
221
 
      </varlistentry>
 
184
      </varlistentry>       
222
185
      
223
186
      <varlistentry>
224
 
        <term><option>--debug</option></term>
 
187
        <term><literal>--debug</literal></term>
225
188
        <listitem>
226
189
          <para>
227
190
            Debug mode
230
193
      </varlistentry>
231
194
      
232
195
      <varlistentry>
233
 
        <term><option>--help</option></term>
234
 
        <term><option>-?</option></term>
 
196
        <term><literal>-?</literal>, <literal>--help</literal></term>
235
197
        <listitem>
236
198
          <para>
237
199
            Gives a help message
240
202
      </varlistentry>
241
203
      
242
204
      <varlistentry>
243
 
        <term><option>--usage</option></term>
 
205
        <term><literal>--usage</literal></term>
244
206
        <listitem>
245
207
          <para>
246
208
            Gives a short usage message
249
211
      </varlistentry>
250
212
 
251
213
      <varlistentry>
252
 
        <term><option>--version</option></term>
253
 
        <term><option>-V</option></term>
 
214
        <term><literal>-V</literal>, <literal>--version</literal></term>
254
215
        <listitem>
255
216
          <para>
256
217
            Prints the program version
257
218
          </para>
258
219
        </listitem>
259
 
      </varlistentry>
 
220
      </varlistentry>            
260
221
    </variablelist>
261
222
  </refsect1>
262
223
 
270
231
    <title>FILES</title>
271
232
    <para>
272
233
    </para>
273
 
  </refsect1>
 
234
  </refsect1>  
274
235
 
275
236
  <refsect1 id="notes">
276
237
    <title>NOTES</title>
282
243
    <title>BUGS</title>
283
244
    <para>
284
245
    </para>
285
 
  </refsect1>
 
246
  </refsect1>  
286
247
 
287
248
  <refsect1 id="examples">
288
 
    <title>EXAMPLE</title>
 
249
    <title>EXAMPLES</title>
289
250
    <para>
290
251
    </para>
291
252
  </refsect1>
299
260
  <refsect1 id="see_also">
300
261
    <title>SEE ALSO</title>
301
262
    <para>
 
263
      <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
302
269
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
303
 
      <manvolnum>8</manvolnum></citerefentry>,
304
 
      <citerefentry><refentrytitle>mandos</refentrytitle>
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>
 
270
      <manvolnum>8</manvolnum></citerefentry>
310
271
    </para>
311
272
  </refsect1>
312
273
 
313
274
</refentry>
314
 
<!-- Local Variables: -->
315
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
316
 
<!-- time-stamp-end: "[\"']>" -->
317
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
318
 
<!-- End: -->