/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-31 08:47:38 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080831084738-uu70kayyt876982d
* mandos-keygen: Minor help text change.

* mandos-keygen.xml: Changed plural "keys" to singular "key"
                     throughout.
  (NAME): Improved wording.
  (DESCRIPTION): Improved wording.
  (OPTIONS): Split options in <term> tags into separate <term> tags.
             Use <option> tags.  Move long options before short
             options.  Uppercase replaceables.
  (OVERVIEW): Improved wording.
  (EXIT STATUS): Also cover --password option.
  (EXAMPLE): Add two examples using the --password option.
  (SECURITY): Improved wording.

* overview.xml: Improved wording.

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugin-runner.xml
 
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"?>
 
4
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
 
5
        "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
 
6
<!ENTITY VERSION "1.0">
 
7
<!ENTITY COMMANDNAME "plugin-runner">
 
8
<!ENTITY TIMESTAMP "2008-08-30">
 
9
]>
 
10
 
 
11
<refentry>
 
12
  <refentryinfo>
 
13
    <title>Mandos Manual</title>
 
14
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
 
15
    <productname>Mandos</productname>
 
16
    <productnumber>&VERSION;</productnumber>
 
17
    <date>&TIMESTAMP;</date>
 
18
    <authorgroup>
 
19
      <author>
 
20
        <firstname>Björn</firstname>
 
21
        <surname>Påhlsson</surname>
 
22
        <address>
 
23
          <email>belorn@fukt.bsnet.se</email>
 
24
        </address>
 
25
      </author>
 
26
      <author>
 
27
        <firstname>Teddy</firstname>
 
28
        <surname>Hogeborn</surname>
 
29
        <address>
 
30
          <email>teddy@fukt.bsnet.se</email>
 
31
        </address>
 
32
      </author>
 
33
    </authorgroup>
 
34
    <copyright>
 
35
      <year>2008</year>
 
36
      <holder>Teddy Hogeborn &amp; Björn Påhlsson</holder>
 
37
    </copyright>
 
38
    <legalnotice>
 
39
      <para>
 
40
        This manual page is free software: you can redistribute it
 
41
        and/or modify it under the terms of the GNU General Public
 
42
        License as published by the Free Software Foundation,
 
43
        either version 3 of the License, or (at your option) any
 
44
        later version.
 
45
      </para>
 
46
 
 
47
      <para>
 
48
        This manual page is distributed in the hope that it will
 
49
        be useful, but WITHOUT ANY WARRANTY; without even the
 
50
        implied warranty of MERCHANTABILITY or FITNESS FOR A
 
51
        PARTICULAR PURPOSE.  See the GNU General Public License
 
52
        for more details.
 
53
      </para>
 
54
 
 
55
      <para>
 
56
        You should have received a copy of the GNU General Public
 
57
        License along with this program; If not, see
 
58
        <ulink url="http://www.gnu.org/licenses/"/>.
 
59
      </para>
 
60
    </legalnotice>
 
61
  </refentryinfo>
 
62
 
 
63
  <refmeta>
 
64
    <refentrytitle>&COMMANDNAME;</refentrytitle>
 
65
    <manvolnum>8mandos</manvolnum>
 
66
  </refmeta>
 
67
  
 
68
  <refnamediv>
 
69
    <refname><command>&COMMANDNAME;</command></refname>
 
70
    <refpurpose>
 
71
      Run Mandos plugins.  Pass data from first succesful one.
 
72
    </refpurpose>
 
73
  </refnamediv>
 
74
 
 
75
  <refsynopsisdiv>
 
76
    <cmdsynopsis>
 
77
      <command>&COMMANDNAME;</command>
 
78
      <group rep="repeat">
 
79
        <arg choice="plain"><option>--global-envs=<replaceable
 
80
        >VAR</replaceable><literal>=</literal><replaceable
 
81
        >value</replaceable></option></arg>
 
82
        <arg choice="plain"><option>-e
 
83
        <replaceable>VAR</replaceable><literal>=</literal><replaceable
 
84
        >value</replaceable> </option></arg>
 
85
      </group>
 
86
      <sbr/>
 
87
      <group rep="repeat">
 
88
        <arg choice="plain"><option>--envs-for=<replaceable
 
89
        >PLUGIN</replaceable><literal>:</literal><replaceable
 
90
        >ENV</replaceable><literal>=</literal><replaceable
 
91
        >value</replaceable></option></arg>
 
92
        <arg choice="plain"><option>-f<replaceable>
 
93
        PLUGIN</replaceable><literal>:</literal><replaceable
 
94
        >ENV</replaceable><literal>=</literal><replaceable
 
95
        >value</replaceable> </option></arg>
 
96
      </group>
 
97
      <sbr/>
 
98
      <group rep="repeat">
 
99
        <arg choice="plain"><option>--global-options=<replaceable
 
100
        >OPTIONS</replaceable></option></arg>
 
101
        <arg choice="plain"><option>-g<replaceable>
 
102
        OPTIONS</replaceable> </option></arg>
 
103
      </group>
 
104
      <sbr/>
 
105
      <group rep="repeat">
 
106
        <arg choice="plain"><option>--options-for=<replaceable
 
107
        >PLUGIN</replaceable><literal>:</literal><replaceable
 
108
        >OPTIONS</replaceable></option></arg>
 
109
        <arg choice="plain"><option>-f<replaceable>
 
110
        PLUGIN</replaceable><literal>:</literal><replaceable
 
111
        >OPTIONS</replaceable> </option></arg>
 
112
      </group>
 
113
      <sbr/>
 
114
      <group rep="repeat">
 
115
        <arg choice="plain"><option>--disable=<replaceable
 
116
        >PLUGIN</replaceable></option></arg>
 
117
        <arg choice="plain"><option>-d
 
118
        <replaceable>PLUGIN</replaceable> </option></arg>
 
119
      </group>
 
120
      <sbr/>
 
121
      <arg><option>--groupid=<replaceable
 
122
      >ID</replaceable></option></arg>
 
123
      <sbr/>
 
124
      <arg><option>--userid=<replaceable
 
125
      >ID</replaceable></option></arg>
 
126
      <sbr/>
 
127
      <arg><option>--plugin-dir=<replaceable
 
128
      >DIRECTORY</replaceable></option></arg>
 
129
      <sbr/>
 
130
      <arg><option>--debug</option></arg>
 
131
    </cmdsynopsis>
 
132
    <cmdsynopsis>
 
133
      <command>&COMMANDNAME;</command>
 
134
      <group choice="req">
 
135
        <arg choice='plain'><option>--help</option></arg>
 
136
        <arg choice='plain'><option>-?</option></arg>
 
137
      </group>
 
138
    </cmdsynopsis>
 
139
    <cmdsynopsis>
 
140
      <command>&COMMANDNAME;</command>
 
141
      <arg choice='plain'><option>--usage</option></arg>
 
142
    </cmdsynopsis>
 
143
    <cmdsynopsis>
 
144
      <command>&COMMANDNAME;</command>
 
145
      <group choice="req">
 
146
        <arg choice='plain'><option>--version</option></arg>
 
147
        <arg choice='plain'><option>-V</option></arg>
 
148
      </group>
 
149
    </cmdsynopsis>
 
150
  </refsynopsisdiv>
 
151
 
 
152
  <refsect1 id="description">
 
153
    <title>DESCRIPTION</title>
 
154
    <para>
 
155
      <command>&COMMANDNAME;</command> is a plugin runner that waits
 
156
      for any of its plugins to return sucessfull with a password, and
 
157
      passes it to cryptsetup as stdout message. This command is not
 
158
      meant to be invoked directly, but is instead meant to be run by
 
159
      cryptsetup by being specified in /etc/crypttab as a keyscript
 
160
      and subsequlently started in the initrd environment. See
 
161
      <citerefentry><refentrytitle>crypttab</refentrytitle>
 
162
      <manvolnum>5</manvolnum></citerefentry> for more information on
 
163
      keyscripts.
 
164
    </para>
 
165
 
 
166
    <para>
 
167
      plugins is looked for in the plugins directory which by default will be
 
168
      /conf/conf.d/mandos/plugins.d if not changed by option --plugin-dir.
 
169
    </para>
 
170
  </refsect1>
 
171
  <refsect1>
 
172
    <title>OPTIONS</title>
 
173
    <variablelist>
 
174
      <varlistentry>
 
175
        <term><literal>-g</literal>,<literal>--global-options
 
176
        <replaceable>OPTIONS</replaceable></literal></term>
 
177
        <listitem>
 
178
          <para>
 
179
            Global options given to all plugins as additional start
 
180
            arguments.  Options are specified with a -o flag followed
 
181
            by a comma separated string of options.
 
182
          </para>       
 
183
        </listitem>
 
184
      </varlistentry>
 
185
 
 
186
      <varlistentry>
 
187
        <term><literal>-o</literal>,<literal> --options-for
 
188
        <replaceable>PLUGIN</replaceable>:<replaceable>OPTION</replaceable>
 
189
        </literal></term>
 
190
        <listitem>
 
191
          <para>
 
192
            Plugin specific options given to the plugin as additional
 
193
            start arguments.  Options are specified with a -o flag
 
194
            followed by a comma separated string of options.
 
195
          </para>       
 
196
        </listitem>
 
197
      </varlistentry>
 
198
 
 
199
      <varlistentry>
 
200
        <term><literal>-d</literal>,<literal> --disable
 
201
        <replaceable>PLUGIN</replaceable>
 
202
        </literal></term>
 
203
        <listitem>
 
204
          <para>
 
205
            Disable a specific plugin
 
206
          </para>       
 
207
        </listitem>
 
208
      </varlistentry>
 
209
 
 
210
      <varlistentry>
 
211
        <term><literal>--groupid <replaceable>ID</replaceable>
 
212
        </literal></term>
 
213
        <listitem>
 
214
          <para>
 
215
            Group ID the plugins will run as
 
216
          </para>
 
217
        </listitem>
 
218
      </varlistentry>
 
219
 
 
220
      <varlistentry>
 
221
        <term><literal>--userid <replaceable>ID</replaceable>
 
222
        </literal></term>
 
223
        <listitem>
 
224
          <para>
 
225
            User ID the plugins will run as
 
226
          </para>
 
227
        </listitem>
 
228
      </varlistentry>
 
229
 
 
230
      <varlistentry>
 
231
        <term><literal>--plugin-dir <replaceable>DIRECTORY</replaceable>
 
232
        </literal></term>
 
233
        <listitem>
 
234
          <para>
 
235
            Specify a different plugin directory
 
236
          </para>
 
237
        </listitem>
 
238
      </varlistentry>
 
239
      
 
240
      <varlistentry>
 
241
        <term><literal>--debug</literal></term>
 
242
        <listitem>
 
243
          <para>
 
244
            Debug mode
 
245
          </para>
 
246
        </listitem>
 
247
      </varlistentry>
 
248
      
 
249
      <varlistentry>
 
250
        <term><literal>-?</literal>, <literal>--help</literal></term>
 
251
        <listitem>
 
252
          <para>
 
253
            Gives a help message
 
254
          </para>
 
255
        </listitem>
 
256
      </varlistentry>
 
257
      
 
258
      <varlistentry>
 
259
        <term><literal>--usage</literal></term>
 
260
        <listitem>
 
261
          <para>
 
262
            Gives a short usage message
 
263
          </para>
 
264
        </listitem>
 
265
      </varlistentry>
 
266
 
 
267
      <varlistentry>
 
268
        <term><literal>-V</literal>, <literal>--version</literal></term>
 
269
        <listitem>
 
270
          <para>
 
271
            Prints the program version
 
272
          </para>
 
273
        </listitem>
 
274
      </varlistentry>
 
275
    </variablelist>
 
276
  </refsect1>
 
277
 
 
278
  <refsect1 id="exit_status">
 
279
    <title>EXIT STATUS</title>
 
280
    <para>
 
281
    </para>
 
282
  </refsect1>
 
283
 
 
284
  <refsect1 id="file">
 
285
    <title>FILES</title>
 
286
    <para>
 
287
    </para>
 
288
  </refsect1>
 
289
 
 
290
  <refsect1 id="notes">
 
291
    <title>NOTES</title>
 
292
    <para>
 
293
    </para>
 
294
  </refsect1>
 
295
  
 
296
  <refsect1 id="bugs">
 
297
    <title>BUGS</title>
 
298
    <para>
 
299
    </para>
 
300
  </refsect1>
 
301
 
 
302
  <refsect1 id="examples">
 
303
    <title>EXAMPLE</title>
 
304
    <para>
 
305
    </para>
 
306
  </refsect1>
 
307
 
 
308
  <refsect1 id="security">
 
309
    <title>SECURITY</title>
 
310
    <para>
 
311
    </para>
 
312
  </refsect1>
 
313
 
 
314
  <refsect1 id="see_also">
 
315
    <title>SEE ALSO</title>
 
316
    <para>
 
317
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
 
318
      <manvolnum>8</manvolnum></citerefentry>,
 
319
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
320
      <manvolnum>8</manvolnum></citerefentry>,
 
321
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
 
322
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
323
      <citerefentry><refentrytitle>password-request</refentrytitle>
 
324
      <manvolnum>8mandos</manvolnum></citerefentry>
 
325
    </para>
 
326
  </refsect1>
 
327
 
 
328
</refentry>
 
329
<!-- Local Variables: -->
 
330
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
331
<!-- time-stamp-end: "[\"']>" -->
 
332
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
333
<!-- End: -->