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

Added manual pages for:
      clients.conf
      mandos.conf
      mandos
      mandos-client
      password-prompt
      password-request

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
<?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
 
<!ENTITY COMMANDNAME "plugin-runner">
6
 
<!ENTITY TIMESTAMP "2008-08-31">
 
7
<!ENTITY COMMANDNAME "mandos-client">
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>
 
76
      <arg choice='opt' rep='repeat'>OPTION</arg>
148
77
    </cmdsynopsis>
149
78
  </refsynopsisdiv>
150
79
 
153
82
    <para>
154
83
      <command>&COMMANDNAME;</command> is a plugin runner that waits
155
84
      for any of its plugins to return sucessfull with a password, and
156
 
      passes it to cryptsetup as stdout message. This command is not
157
 
      meant to be invoked directly, but is instead meant to be run by
158
 
      cryptsetup by being specified in /etc/crypttab as a keyscript
159
 
      and subsequlently started in the initrd environment. See
160
 
      <citerefentry><refentrytitle>crypttab</refentrytitle>
161
 
      <manvolnum>5</manvolnum></citerefentry> for more information on
162
 
      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.
163
88
    </para>
164
89
 
165
 
    <para>
166
 
      plugins is looked for in the plugins directory which by default will be
167
 
      /conf/conf.d/mandos/plugins.d if not changed by option --plugin-dir.
168
 
    </para>
169
 
  </refsect1>
170
 
  <refsect1>
171
 
    <title>OPTIONS</title>
172
90
    <variablelist>
173
91
      <varlistentry>
174
 
        <term><option>--global-options
175
 
        <replaceable>OPTIONS</replaceable></option></term>
176
 
        <term><option>-g
177
 
        <replaceable>OPTIONS</replaceable></option></term>
 
92
        <term><literal>-g</literal>,<literal>--global-options
 
93
        <replaceable>OPTIONS</replaceable></literal></term>
178
94
        <listitem>
179
95
          <para>
180
96
            Global options given to all plugins as additional start
181
97
            arguments.  Options are specified with a -o flag followed
182
98
            by a comma separated string of options.
183
 
          </para>       
 
99
          </para>         
184
100
        </listitem>
185
101
      </varlistentry>
186
102
 
187
103
      <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>
 
104
        <term><literal>-o</literal>,<literal> --options-for
 
105
        <replaceable>PLUGIN</replaceable>:<replaceable>OPTION</replaceable>
 
106
        </literal></term>
194
107
        <listitem>
195
108
          <para>
196
109
            Plugin specific options given to the plugin as additional
197
110
            start arguments.  Options are specified with a -o flag
198
111
            followed by a comma separated string of options.
199
 
          </para>       
 
112
          </para>         
200
113
        </listitem>
201
 
      </varlistentry>
 
114
      </varlistentry>      
202
115
 
203
116
      <varlistentry>
204
 
        <term><option> --disable
205
 
        <replaceable>PLUGIN</replaceable></option></term>
206
 
        <term><option>-d
207
 
        <replaceable>PLUGIN</replaceable></option></term>
 
117
        <term><literal>-d</literal>,<literal> --disable
 
118
        <replaceable>PLUGIN</replaceable>
 
119
        </literal></term>
208
120
        <listitem>
209
121
          <para>
210
122
            Disable a specific plugin
211
 
          </para>       
 
123
          </para>         
212
124
        </listitem>
213
125
      </varlistentry>
214
126
 
215
127
      <varlistentry>
216
 
        <term><option>--groupid
217
 
        <replaceable>ID</replaceable></option></term>
 
128
        <term><literal>--groupid <replaceable>ID</replaceable>
 
129
        </literal></term>
218
130
        <listitem>
219
131
          <para>
220
132
            Group ID the plugins will run as
221
133
          </para>
222
134
        </listitem>
223
 
      </varlistentry>
 
135
      </varlistentry>      
224
136
 
225
137
      <varlistentry>
226
 
        <term><option>--userid
227
 
        <replaceable>ID</replaceable></option></term>
 
138
        <term><literal>--userid <replaceable>ID</replaceable>
 
139
        </literal></term>
228
140
        <listitem>
229
141
          <para>
230
142
            User ID the plugins will run as
231
143
          </para>
232
144
        </listitem>
233
 
      </varlistentry>
 
145
      </varlistentry>      
234
146
 
235
147
      <varlistentry>
236
 
        <term><option>--plugin-dir
237
 
        <replaceable>DIRECTORY</replaceable></option></term>
 
148
        <term><literal>--plugin-dir <replaceable>DIRECTORY</replaceable>
 
149
        </literal></term>
238
150
        <listitem>
239
151
          <para>
240
152
            Specify a different plugin directory
241
153
          </para>
242
154
        </listitem>
243
 
      </varlistentry>
 
155
      </varlistentry>       
244
156
      
245
157
      <varlistentry>
246
 
        <term><option>--debug</option></term>
 
158
        <term><literal>--debug</literal></term>
247
159
        <listitem>
248
160
          <para>
249
161
            Debug mode
252
164
      </varlistentry>
253
165
      
254
166
      <varlistentry>
255
 
        <term><option>--help</option></term>
256
 
        <term><option>-?</option></term>
 
167
        <term><literal>-?</literal>, <literal>--help</literal></term>
257
168
        <listitem>
258
169
          <para>
259
170
            Gives a help message
262
173
      </varlistentry>
263
174
      
264
175
      <varlistentry>
265
 
        <term><option>--usage</option></term>
 
176
        <term><literal>--usage</literal></term>
266
177
        <listitem>
267
178
          <para>
268
179
            Gives a short usage message
271
182
      </varlistentry>
272
183
 
273
184
      <varlistentry>
274
 
        <term><option>--version</option></term>
275
 
        <term><option>-V</option></term>
 
185
        <term><literal>-V</literal>, <literal>--version</literal></term>
276
186
        <listitem>
277
187
          <para>
278
188
            Prints the program version
279
189
          </para>
280
190
        </listitem>
281
 
      </varlistentry>
 
191
      </varlistentry>            
282
192
    </variablelist>
283
193
  </refsect1>
284
 
 
285
 
  <refsect1 id="exit_status">
286
 
    <title>EXIT STATUS</title>
287
 
    <para>
288
 
    </para>
289
 
  </refsect1>
290
 
 
291
 
  <refsect1 id="file">
292
 
    <title>FILES</title>
293
 
    <para>
294
 
    </para>
295
 
  </refsect1>
296
 
 
297
 
  <refsect1 id="notes">
298
 
    <title>NOTES</title>
299
 
    <para>
300
 
    </para>
301
 
  </refsect1>
302
 
  
303
 
  <refsect1 id="bugs">
304
 
    <title>BUGS</title>
305
 
    <para>
306
 
    </para>
307
 
  </refsect1>
308
 
 
309
 
  <refsect1 id="examples">
310
 
    <title>EXAMPLE</title>
311
 
    <para>
312
 
    </para>
313
 
  </refsect1>
314
 
 
315
 
  <refsect1 id="security">
316
 
    <title>SECURITY</title>
317
 
    <para>
318
 
    </para>
319
 
  </refsect1>
320
 
 
321
 
  <refsect1 id="see_also">
322
 
    <title>SEE ALSO</title>
323
 
    <para>
324
 
      <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>
332
 
    </para>
333
 
  </refsect1>
334
 
 
335
194
</refentry>
336
 
<!-- Local Variables: -->
337
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
338
 
<!-- time-stamp-end: "[\"']>" -->
339
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
340
 
<!-- End: -->