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