/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-25 07:52:35 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080825075235-gq338t4ywhqhire8
* mandos-clients.conf.xml (DESCRIPTION): Do not imply that this is the
                                         only configuration file of
                                         mandos(8).
  (OPTIONS): Note that unknown options are ignored.  When describing
             "checker", be more specific about exit codes, and refer
             to PATH.  When describing "secret", refer to
             mandos-keygen(8), and note the relationship with
             "secfile".  Added synopsis to "secfile", and note
             relationship with "secret".  Added synopsis and more text
             to "host".
  (EXAMPLE): Remove Radix-64 checksum from "secret" option value.
  (SEE ALSO): New section, refer to mandos(8), mandos-keygen(8), and
              mandos.conf(5).

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
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
36
    <legalnotice>
38
37
      <para>
67
66
  <refnamediv>
68
67
    <refname><command>&COMMANDNAME;</command></refname>
69
68
    <refpurpose>
70
 
      Run Mandos plugins.  Pass data from first succesful one.
 
69
      get password for encrypted rootdisk
71
70
    </refpurpose>
72
71
  </refnamediv>
73
72
 
74
73
  <refsynopsisdiv>
75
74
    <cmdsynopsis>
76
75
      <command>&COMMANDNAME;</command>
77
 
      <group rep="repeat">
78
 
        <arg choice="plain"><option>--global-envs=<replaceable
79
 
        >VAR</replaceable><literal>=</literal><replaceable
80
 
        >value</replaceable></option></arg>
81
 
        <arg choice="plain"><option>-e
82
 
        <replaceable>VAR</replaceable><literal>=</literal><replaceable
83
 
        >value</replaceable> </option></arg>
84
 
      </group>
85
 
      <sbr/>
86
 
      <group rep="repeat">
87
 
        <arg choice="plain"><option>--envs-for=<replaceable
88
 
        >PLUGIN</replaceable><literal>:</literal><replaceable
89
 
        >ENV</replaceable><literal>=</literal><replaceable
90
 
        >value</replaceable></option></arg>
91
 
        <arg choice="plain"><option>-f<replaceable>
92
 
        PLUGIN</replaceable><literal>:</literal><replaceable
93
 
        >ENV</replaceable><literal>=</literal><replaceable
94
 
        >value</replaceable> </option></arg>
95
 
      </group>
96
 
      <sbr/>
97
 
      <group rep="repeat">
98
 
        <arg choice="plain"><option>--global-options=<replaceable
99
 
        >OPTIONS</replaceable></option></arg>
100
 
        <arg choice="plain"><option>-g<replaceable>
101
 
        OPTIONS</replaceable> </option></arg>
102
 
      </group>
103
 
      <sbr/>
104
 
      <group rep="repeat">
105
 
        <arg choice="plain"><option>--options-for=<replaceable
106
 
        >PLUGIN</replaceable><literal>:</literal><replaceable
107
 
        >OPTIONS</replaceable></option></arg>
108
 
        <arg choice="plain"><option>-f<replaceable>
109
 
        PLUGIN</replaceable><literal>:</literal><replaceable
110
 
        >OPTIONS</replaceable> </option></arg>
111
 
      </group>
112
 
      <sbr/>
113
 
      <group rep="repeat">
114
 
        <arg choice="plain"><option>--disable=<replaceable
115
 
        >PLUGIN</replaceable></option></arg>
116
 
        <arg choice="plain"><option>-d
117
 
        <replaceable>PLUGIN</replaceable> </option></arg>
118
 
      </group>
119
 
      <sbr/>
120
 
      <arg><option>--groupid=<replaceable
121
 
      >ID</replaceable></option></arg>
122
 
      <sbr/>
123
 
      <arg><option>--userid=<replaceable
124
 
      >ID</replaceable></option></arg>
125
 
      <sbr/>
126
 
      <arg><option>--plugin-dir=<replaceable
127
 
      >DIRECTORY</replaceable></option></arg>
128
 
      <sbr/>
129
 
      <arg><option>--debug</option></arg>
130
 
    </cmdsynopsis>
131
 
    <cmdsynopsis>
132
 
      <command>&COMMANDNAME;</command>
133
 
      <group choice="req">
134
 
        <arg choice="plain"><option>--help</option></arg>
135
 
        <arg choice="plain"><option>-?</option></arg>
136
 
      </group>
137
 
    </cmdsynopsis>
138
 
    <cmdsynopsis>
139
 
      <command>&COMMANDNAME;</command>
140
 
      <arg choice="plain"><option>--usage</option></arg>
141
 
    </cmdsynopsis>
142
 
    <cmdsynopsis>
143
 
      <command>&COMMANDNAME;</command>
144
 
      <group choice="req">
145
 
        <arg choice="plain"><option>--version</option></arg>
146
 
        <arg choice="plain"><option>-V</option></arg>
147
 
      </group>
148
 
    </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>    
149
96
  </refsynopsisdiv>
150
97
 
151
98
  <refsect1 id="description">
159
106
      and subsequlently started in the initrd environment. See
160
107
      <citerefentry><refentrytitle>crypttab</refentrytitle>
161
108
      <manvolnum>5</manvolnum></citerefentry> for more information on
162
 
      keyscripts.
 
109
      keyscripts.    
163
110
    </para>
164
111
 
165
112
    <para>
171
118
    <title>OPTIONS</title>
172
119
    <variablelist>
173
120
      <varlistentry>
174
 
        <term><option>--global-options
175
 
        <replaceable>OPTIONS</replaceable></option></term>
176
 
        <term><option>-g
177
 
        <replaceable>OPTIONS</replaceable></option></term>
 
121
        <term><literal>-g</literal>,<literal>--global-options
 
122
        <replaceable>OPTIONS</replaceable></literal></term>
178
123
        <listitem>
179
124
          <para>
180
125
            Global options given to all plugins as additional start
181
126
            arguments.  Options are specified with a -o flag followed
182
127
            by a comma separated string of options.
183
 
          </para>       
 
128
          </para>         
184
129
        </listitem>
185
130
      </varlistentry>
186
131
 
187
132
      <varlistentry>
188
 
        <term><option>--options-for
189
 
        <replaceable>PLUGIN</replaceable><literal>:</literal
190
 
        ><replaceable>OPTION</replaceable></option></term>
191
 
        <term><option>-o
192
 
        <replaceable>PLUGIN</replaceable><literal>:</literal
193
 
        ><replaceable>OPTION</replaceable></option></term>
 
133
        <term><literal>-o</literal>,<literal> --options-for
 
134
        <replaceable>PLUGIN</replaceable>:<replaceable>OPTION</replaceable>
 
135
        </literal></term>
194
136
        <listitem>
195
137
          <para>
196
138
            Plugin specific options given to the plugin as additional
197
139
            start arguments.  Options are specified with a -o flag
198
140
            followed by a comma separated string of options.
199
 
          </para>       
 
141
          </para>         
200
142
        </listitem>
201
 
      </varlistentry>
 
143
      </varlistentry>      
202
144
 
203
145
      <varlistentry>
204
 
        <term><option> --disable
205
 
        <replaceable>PLUGIN</replaceable></option></term>
206
 
        <term><option>-d
207
 
        <replaceable>PLUGIN</replaceable></option></term>
 
146
        <term><literal>-d</literal>,<literal> --disable
 
147
        <replaceable>PLUGIN</replaceable>
 
148
        </literal></term>
208
149
        <listitem>
209
150
          <para>
210
151
            Disable a specific plugin
211
 
          </para>       
 
152
          </para>         
212
153
        </listitem>
213
154
      </varlistentry>
214
155
 
215
156
      <varlistentry>
216
 
        <term><option>--groupid
217
 
        <replaceable>ID</replaceable></option></term>
 
157
        <term><literal>--groupid <replaceable>ID</replaceable>
 
158
        </literal></term>
218
159
        <listitem>
219
160
          <para>
220
161
            Group ID the plugins will run as
221
162
          </para>
222
163
        </listitem>
223
 
      </varlistentry>
 
164
      </varlistentry>      
224
165
 
225
166
      <varlistentry>
226
 
        <term><option>--userid
227
 
        <replaceable>ID</replaceable></option></term>
 
167
        <term><literal>--userid <replaceable>ID</replaceable>
 
168
        </literal></term>
228
169
        <listitem>
229
170
          <para>
230
171
            User ID the plugins will run as
231
172
          </para>
232
173
        </listitem>
233
 
      </varlistentry>
 
174
      </varlistentry>      
234
175
 
235
176
      <varlistentry>
236
 
        <term><option>--plugin-dir
237
 
        <replaceable>DIRECTORY</replaceable></option></term>
 
177
        <term><literal>--plugin-dir <replaceable>DIRECTORY</replaceable>
 
178
        </literal></term>
238
179
        <listitem>
239
180
          <para>
240
181
            Specify a different plugin directory
241
182
          </para>
242
183
        </listitem>
243
 
      </varlistentry>
 
184
      </varlistentry>       
244
185
      
245
186
      <varlistentry>
246
 
        <term><option>--debug</option></term>
 
187
        <term><literal>--debug</literal></term>
247
188
        <listitem>
248
189
          <para>
249
190
            Debug mode
252
193
      </varlistentry>
253
194
      
254
195
      <varlistentry>
255
 
        <term><option>--help</option></term>
256
 
        <term><option>-?</option></term>
 
196
        <term><literal>-?</literal>, <literal>--help</literal></term>
257
197
        <listitem>
258
198
          <para>
259
199
            Gives a help message
262
202
      </varlistentry>
263
203
      
264
204
      <varlistentry>
265
 
        <term><option>--usage</option></term>
 
205
        <term><literal>--usage</literal></term>
266
206
        <listitem>
267
207
          <para>
268
208
            Gives a short usage message
271
211
      </varlistentry>
272
212
 
273
213
      <varlistentry>
274
 
        <term><option>--version</option></term>
275
 
        <term><option>-V</option></term>
 
214
        <term><literal>-V</literal>, <literal>--version</literal></term>
276
215
        <listitem>
277
216
          <para>
278
217
            Prints the program version
279
218
          </para>
280
219
        </listitem>
281
 
      </varlistentry>
 
220
      </varlistentry>            
282
221
    </variablelist>
283
222
  </refsect1>
284
223
 
292
231
    <title>FILES</title>
293
232
    <para>
294
233
    </para>
295
 
  </refsect1>
 
234
  </refsect1>  
296
235
 
297
236
  <refsect1 id="notes">
298
237
    <title>NOTES</title>
304
243
    <title>BUGS</title>
305
244
    <para>
306
245
    </para>
307
 
  </refsect1>
 
246
  </refsect1>  
308
247
 
309
248
  <refsect1 id="examples">
310
 
    <title>EXAMPLE</title>
 
249
    <title>EXAMPLES</title>
311
250
    <para>
312
251
    </para>
313
252
  </refsect1>
321
260
  <refsect1 id="see_also">
322
261
    <title>SEE ALSO</title>
323
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
324
269
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
325
 
      <manvolnum>8</manvolnum></citerefentry>,
326
 
      <citerefentry><refentrytitle>mandos</refentrytitle>
327
 
      <manvolnum>8</manvolnum></citerefentry>,
328
 
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
329
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
330
 
      <citerefentry><refentrytitle>password-request</refentrytitle>
331
 
      <manvolnum>8mandos</manvolnum></citerefentry>
 
270
      <manvolnum>8</manvolnum></citerefentry>
332
271
    </para>
333
272
  </refsect1>
334
273
 
335
274
</refentry>
336
 
<!-- Local Variables: -->
337
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
338
 
<!-- time-stamp-end: "[\"']>" -->
339
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
340
 
<!-- End: -->