/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 mandos-client.xml

  • Committer: Teddy Hogeborn
  • Date: 2008-08-09 15:56:13 UTC
  • mfrom: (24.1.29 mandos)
  • Revision ID: teddy@fukt.bsnet.se-20080809155613-pm1o10yh44nafc0g
Merge.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-client.xml
1
 
<?xml version="1.0" encoding="UTF-8"?>
 
1
<?xml version='1.0' encoding='UTF-8'?>
2
2
<?xml-stylesheet type="text/xsl"
3
3
        href="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"?>
4
4
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
5
5
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
6
6
<!ENTITY VERSION "1.0">
7
 
<!ENTITY COMMANDNAME "plugin-runner">
8
 
<!ENTITY TIMESTAMP "2008-08-31">
 
7
<!ENTITY COMMANDNAME "mandos-client">
9
8
]>
10
9
 
11
10
<refentry>
12
11
  <refentryinfo>
13
 
    <title>Mandos Manual</title>
14
 
    <!-- Nwalsh’s docbook scripts use this to generate the footer: -->
15
 
    <productname>Mandos</productname>
 
12
    <title>&COMMANDNAME;</title>
 
13
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
 
14
    <productname>&COMMANDNAME;</productname>
16
15
    <productnumber>&VERSION;</productnumber>
17
 
    <date>&TIMESTAMP;</date>
18
16
    <authorgroup>
19
17
      <author>
20
18
        <firstname>Björn</firstname>
33
31
    </authorgroup>
34
32
    <copyright>
35
33
      <year>2008</year>
36
 
      <holder>Teddy Hogeborn</holder>
37
 
      <holder>Björn Påhlsson</holder>
 
34
      <holder>Teddy Hogeborn &amp; Björn Påhlsson</holder>
38
35
    </copyright>
39
36
    <legalnotice>
40
37
      <para>
69
66
  <refnamediv>
70
67
    <refname><command>&COMMANDNAME;</command></refname>
71
68
    <refpurpose>
72
 
      Run Mandos plugins.  Pass data from first succesful one.
 
69
      get password for encrypted rootdisk
73
70
    </refpurpose>
74
71
  </refnamediv>
75
72
 
76
73
  <refsynopsisdiv>
77
74
    <cmdsynopsis>
78
75
      <command>&COMMANDNAME;</command>
79
 
      <group rep="repeat">
80
 
        <arg choice="plain"><option>--global-envs=<replaceable
81
 
        >VAR</replaceable><literal>=</literal><replaceable
82
 
        >value</replaceable></option></arg>
83
 
        <arg choice="plain"><option>-e
84
 
        <replaceable>VAR</replaceable><literal>=</literal><replaceable
85
 
        >value</replaceable> </option></arg>
86
 
      </group>
87
 
      <sbr/>
88
 
      <group rep="repeat">
89
 
        <arg choice="plain"><option>--envs-for=<replaceable
90
 
        >PLUGIN</replaceable><literal>:</literal><replaceable
91
 
        >ENV</replaceable><literal>=</literal><replaceable
92
 
        >value</replaceable></option></arg>
93
 
        <arg choice="plain"><option>-f<replaceable>
94
 
        PLUGIN</replaceable><literal>:</literal><replaceable
95
 
        >ENV</replaceable><literal>=</literal><replaceable
96
 
        >value</replaceable> </option></arg>
97
 
      </group>
98
 
      <sbr/>
99
 
      <group rep="repeat">
100
 
        <arg choice="plain"><option>--global-options=<replaceable
101
 
        >OPTIONS</replaceable></option></arg>
102
 
        <arg choice="plain"><option>-g<replaceable>
103
 
        OPTIONS</replaceable> </option></arg>
104
 
      </group>
105
 
      <sbr/>
106
 
      <group rep="repeat">
107
 
        <arg choice="plain"><option>--options-for=<replaceable
108
 
        >PLUGIN</replaceable><literal>:</literal><replaceable
109
 
        >OPTIONS</replaceable></option></arg>
110
 
        <arg choice="plain"><option>-f<replaceable>
111
 
        PLUGIN</replaceable><literal>:</literal><replaceable
112
 
        >OPTIONS</replaceable> </option></arg>
113
 
      </group>
114
 
      <sbr/>
115
 
      <group rep="repeat">
116
 
        <arg choice="plain"><option>--disable=<replaceable
117
 
        >PLUGIN</replaceable></option></arg>
118
 
        <arg choice="plain"><option>-d
119
 
        <replaceable>PLUGIN</replaceable> </option></arg>
120
 
      </group>
121
 
      <sbr/>
122
 
      <arg><option>--groupid=<replaceable
123
 
      >ID</replaceable></option></arg>
124
 
      <sbr/>
125
 
      <arg><option>--userid=<replaceable
126
 
      >ID</replaceable></option></arg>
127
 
      <sbr/>
128
 
      <arg><option>--plugin-dir=<replaceable
129
 
      >DIRECTORY</replaceable></option></arg>
130
 
      <sbr/>
131
 
      <arg><option>--debug</option></arg>
132
 
    </cmdsynopsis>
133
 
    <cmdsynopsis>
134
 
      <command>&COMMANDNAME;</command>
135
 
      <group choice="req">
136
 
        <arg choice="plain"><option>--help</option></arg>
137
 
        <arg choice="plain"><option>-?</option></arg>
138
 
      </group>
139
 
    </cmdsynopsis>
140
 
    <cmdsynopsis>
141
 
      <command>&COMMANDNAME;</command>
142
 
      <arg choice="plain"><option>--usage</option></arg>
143
 
    </cmdsynopsis>
144
 
    <cmdsynopsis>
145
 
      <command>&COMMANDNAME;</command>
146
 
      <group choice="req">
147
 
        <arg choice="plain"><option>--version</option></arg>
148
 
        <arg choice="plain"><option>-V</option></arg>
149
 
      </group>
 
76
      <arg choice='opt' rep='repeat'>OPTION</arg>
150
77
    </cmdsynopsis>
151
78
  </refsynopsisdiv>
152
79
 
155
82
    <para>
156
83
      <command>&COMMANDNAME;</command> is a plugin runner that waits
157
84
      for any of its plugins to return sucessfull with a password, and
158
 
      passes it to cryptsetup as stdout message. This command is not
159
 
      meant to be invoked directly, but is instead meant to be run by
160
 
      cryptsetup by being specified in /etc/crypttab as a keyscript
161
 
      and subsequlently started in the initrd environment. See
162
 
      <citerefentry><refentrytitle>crypttab</refentrytitle>
163
 
      <manvolnum>5</manvolnum></citerefentry> for more information on
164
 
      keyscripts.
 
85
      passes it to cryptsetup. plugins is defined as any executables
 
86
      in the plugins directory will by default will be
 
87
      /conf/conf.d/mandos/plugins.d.  to stdout.
165
88
    </para>
166
89
 
167
 
    <para>
168
 
      plugins is looked for in the plugins directory which by default will be
169
 
      /conf/conf.d/mandos/plugins.d if not changed by option --plugin-dir.
170
 
    </para>
171
 
  </refsect1>
172
 
  <refsect1>
173
 
    <title>OPTIONS</title>
174
90
    <variablelist>
175
91
      <varlistentry>
176
 
        <term><option>--global-options
177
 
        <replaceable>OPTIONS</replaceable></option></term>
178
 
        <term><option>-g
179
 
        <replaceable>OPTIONS</replaceable></option></term>
 
92
        <term><literal>-g</literal>,<literal>--global-options
 
93
        <replaceable>OPTIONS</replaceable></literal></term>
180
94
        <listitem>
181
95
          <para>
182
96
            Global options given to all plugins as additional start
183
97
            arguments.  Options are specified with a -o flag followed
184
98
            by a comma separated string of options.
185
 
          </para>       
 
99
          </para>         
186
100
        </listitem>
187
101
      </varlistentry>
188
102
 
189
103
      <varlistentry>
190
 
        <term><option>--options-for
191
 
        <replaceable>PLUGIN</replaceable><literal>:</literal
192
 
        ><replaceable>OPTION</replaceable></option></term>
193
 
        <term><option>-o
194
 
        <replaceable>PLUGIN</replaceable><literal>:</literal
195
 
        ><replaceable>OPTION</replaceable></option></term>
 
104
        <term><literal>-o</literal>,<literal> --options-for
 
105
        <replaceable>PLUGIN</replaceable>:<replaceable>OPTION</replaceable>
 
106
        </literal></term>
196
107
        <listitem>
197
108
          <para>
198
109
            Plugin specific options given to the plugin as additional
199
110
            start arguments.  Options are specified with a -o flag
200
111
            followed by a comma separated string of options.
201
 
          </para>       
 
112
          </para>         
202
113
        </listitem>
203
 
      </varlistentry>
 
114
      </varlistentry>      
204
115
 
205
116
      <varlistentry>
206
 
        <term><option> --disable
207
 
        <replaceable>PLUGIN</replaceable></option></term>
208
 
        <term><option>-d
209
 
        <replaceable>PLUGIN</replaceable></option></term>
 
117
        <term><literal>-d</literal>,<literal> --disable
 
118
        <replaceable>PLUGIN</replaceable>
 
119
        </literal></term>
210
120
        <listitem>
211
121
          <para>
212
122
            Disable a specific plugin
213
 
          </para>       
 
123
          </para>         
214
124
        </listitem>
215
125
      </varlistentry>
216
126
 
217
127
      <varlistentry>
218
 
        <term><option>--groupid
219
 
        <replaceable>ID</replaceable></option></term>
 
128
        <term><literal>--groupid <replaceable>ID</replaceable>
 
129
        </literal></term>
220
130
        <listitem>
221
131
          <para>
222
132
            Group ID the plugins will run as
223
133
          </para>
224
134
        </listitem>
225
 
      </varlistentry>
 
135
      </varlistentry>      
226
136
 
227
137
      <varlistentry>
228
 
        <term><option>--userid
229
 
        <replaceable>ID</replaceable></option></term>
 
138
        <term><literal>--userid <replaceable>ID</replaceable>
 
139
        </literal></term>
230
140
        <listitem>
231
141
          <para>
232
142
            User ID the plugins will run as
233
143
          </para>
234
144
        </listitem>
235
 
      </varlistentry>
 
145
      </varlistentry>      
236
146
 
237
147
      <varlistentry>
238
 
        <term><option>--plugin-dir
239
 
        <replaceable>DIRECTORY</replaceable></option></term>
 
148
        <term><literal>--plugin-dir <replaceable>DIRECTORY</replaceable>
 
149
        </literal></term>
240
150
        <listitem>
241
151
          <para>
242
152
            Specify a different plugin directory
243
153
          </para>
244
154
        </listitem>
245
 
      </varlistentry>
 
155
      </varlistentry>       
246
156
      
247
157
      <varlistentry>
248
 
        <term><option>--debug</option></term>
 
158
        <term><literal>--debug</literal></term>
249
159
        <listitem>
250
160
          <para>
251
161
            Debug mode
254
164
      </varlistentry>
255
165
      
256
166
      <varlistentry>
257
 
        <term><option>--help</option></term>
258
 
        <term><option>-?</option></term>
 
167
        <term><literal>-?</literal>, <literal>--help</literal></term>
259
168
        <listitem>
260
169
          <para>
261
170
            Gives a help message
264
173
      </varlistentry>
265
174
      
266
175
      <varlistentry>
267
 
        <term><option>--usage</option></term>
 
176
        <term><literal>--usage</literal></term>
268
177
        <listitem>
269
178
          <para>
270
179
            Gives a short usage message
273
182
      </varlistentry>
274
183
 
275
184
      <varlistentry>
276
 
        <term><option>--version</option></term>
277
 
        <term><option>-V</option></term>
 
185
        <term><literal>-V</literal>, <literal>--version</literal></term>
278
186
        <listitem>
279
187
          <para>
280
188
            Prints the program version
281
189
          </para>
282
190
        </listitem>
283
 
      </varlistentry>
 
191
      </varlistentry>            
284
192
    </variablelist>
285
193
  </refsect1>
286
 
 
287
 
  <refsect1 id="exit_status">
288
 
    <title>EXIT STATUS</title>
289
 
    <para>
290
 
    </para>
291
 
  </refsect1>
292
 
 
293
 
  <refsect1 id="file">
294
 
    <title>FILES</title>
295
 
    <para>
296
 
    </para>
297
 
  </refsect1>
298
 
 
299
 
  <refsect1 id="notes">
300
 
    <title>NOTES</title>
301
 
    <para>
302
 
    </para>
303
 
  </refsect1>
304
 
  
305
 
  <refsect1 id="bugs">
306
 
    <title>BUGS</title>
307
 
    <para>
308
 
    </para>
309
 
  </refsect1>
310
 
 
311
 
  <refsect1 id="examples">
312
 
    <title>EXAMPLE</title>
313
 
    <para>
314
 
    </para>
315
 
  </refsect1>
316
 
 
317
 
  <refsect1 id="security">
318
 
    <title>SECURITY</title>
319
 
    <para>
320
 
    </para>
321
 
  </refsect1>
322
 
 
323
 
  <refsect1 id="see_also">
324
 
    <title>SEE ALSO</title>
325
 
    <para>
326
 
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
327
 
      <manvolnum>8</manvolnum></citerefentry>,
328
 
      <citerefentry><refentrytitle>mandos</refentrytitle>
329
 
      <manvolnum>8</manvolnum></citerefentry>,
330
 
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
331
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
332
 
      <citerefentry><refentrytitle>password-request</refentrytitle>
333
 
      <manvolnum>8mandos</manvolnum></citerefentry>
334
 
    </para>
335
 
  </refsect1>
336
 
 
337
194
</refentry>
338
 
<!-- Local Variables: -->
339
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
340
 
<!-- time-stamp-end: "[\"']>" -->
341
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
342
 
<!-- End: -->