/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-30 19:49:24 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080830194924-f4liqq8wxajlbshn
* plugin-runner.xml (NAME): Improved wording.
  (SYNOPSIS): Use <option> and <replaceable> tags.  Unify short and
              long options.  Add "--global-envs" and "--envs-for"
              options.

Show diffs side-by-side

added added

removed removed

Lines of Context:
plugin-runner.xml
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 "mandos-client">
 
7
<!ENTITY COMMANDNAME "plugin-runner">
 
8
<!ENTITY TIMESTAMP "2008-08-30">
8
9
]>
9
10
 
10
11
<refentry>
11
12
  <refentryinfo>
12
 
    <title>&COMMANDNAME;</title>
 
13
    <title>Mandos Manual</title>
13
14
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
14
 
    <productname>&COMMANDNAME;</productname>
 
15
    <productname>Mandos</productname>
15
16
    <productnumber>&VERSION;</productnumber>
 
17
    <date>&TIMESTAMP;</date>
16
18
    <authorgroup>
17
19
      <author>
18
20
        <firstname>Björn</firstname>
66
68
  <refnamediv>
67
69
    <refname><command>&COMMANDNAME;</command></refname>
68
70
    <refpurpose>
69
 
      get password for encrypted rootdisk
 
71
      Run Mandos plugins.  Pass data from first succesful one.
70
72
    </refpurpose>
71
73
  </refnamediv>
72
74
 
73
75
  <refsynopsisdiv>
74
76
    <cmdsynopsis>
75
77
      <command>&COMMANDNAME;</command>
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>    
 
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>
96
150
  </refsynopsisdiv>
97
151
 
98
152
  <refsect1 id="description">
100
154
    <para>
101
155
      <command>&COMMANDNAME;</command> is a plugin runner that waits
102
156
      for any of its plugins to return sucessfull with a password, and
103
 
      passes it to cryptsetup. plugins is defined as any executables
104
 
      in the plugins directory will by default will be
105
 
      /conf/conf.d/mandos/plugins.d.  to stdout.
 
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.
106
164
    </para>
107
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>
108
173
    <variablelist>
109
174
      <varlistentry>
110
175
        <term><literal>-g</literal>,<literal>--global-options
114
179
            Global options given to all plugins as additional start
115
180
            arguments.  Options are specified with a -o flag followed
116
181
            by a comma separated string of options.
117
 
          </para>         
 
182
          </para>       
118
183
        </listitem>
119
184
      </varlistentry>
120
185
 
127
192
            Plugin specific options given to the plugin as additional
128
193
            start arguments.  Options are specified with a -o flag
129
194
            followed by a comma separated string of options.
130
 
          </para>         
 
195
          </para>       
131
196
        </listitem>
132
 
      </varlistentry>      
 
197
      </varlistentry>
133
198
 
134
199
      <varlistentry>
135
200
        <term><literal>-d</literal>,<literal> --disable
138
203
        <listitem>
139
204
          <para>
140
205
            Disable a specific plugin
141
 
          </para>         
 
206
          </para>       
142
207
        </listitem>
143
208
      </varlistentry>
144
209
 
150
215
            Group ID the plugins will run as
151
216
          </para>
152
217
        </listitem>
153
 
      </varlistentry>      
 
218
      </varlistentry>
154
219
 
155
220
      <varlistentry>
156
221
        <term><literal>--userid <replaceable>ID</replaceable>
160
225
            User ID the plugins will run as
161
226
          </para>
162
227
        </listitem>
163
 
      </varlistentry>      
 
228
      </varlistentry>
164
229
 
165
230
      <varlistentry>
166
231
        <term><literal>--plugin-dir <replaceable>DIRECTORY</replaceable>
170
235
            Specify a different plugin directory
171
236
          </para>
172
237
        </listitem>
173
 
      </varlistentry>       
 
238
      </varlistentry>
174
239
      
175
240
      <varlistentry>
176
241
        <term><literal>--debug</literal></term>
206
271
            Prints the program version
207
272
          </para>
208
273
        </listitem>
209
 
      </varlistentry>            
 
274
      </varlistentry>
210
275
    </variablelist>
211
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
 
212
328
</refentry>
 
329
<!-- Local Variables: -->
 
330
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
331
<!-- time-stamp-end: "[\"']>" -->
 
332
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
333
<!-- End: -->