/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 plugin-runner.xml

  • Committer: Teddy Hogeborn
  • Date: 2008-08-30 17:16:33 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080830171633-rjyuhsemikw6lg2w
* mandos-keygen.xml (SYNOPSIS): Fixed tags.  Unify short and long
                                options.
* plugins.d/password-request.xml (SYNOPSIS): - '' -

* mandos-clients.conf.xml: Removed extra white space.
* plugin-runner.xml: - '' -
* plugins.d/password-prompt.xml: - '' -
* mandos-keygen.xml: - '' -
* plugins.d/password-request.xml: - '' -

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>
77
79
      <arg choice='opt'>--options-for<arg choice='plain'>PLUGIN:OPTIONS</arg></arg>
78
80
      <arg choice='opt'>--disable<arg choice='plain'>PLUGIN</arg></arg>
79
81
      <arg choice='opt'>--groupid<arg choice='plain'>ID</arg></arg>
80
 
      <arg choice='opt'>--userpid<arg choice='plain'>ID</arg></arg>
 
82
      <arg choice='opt'>--userid<arg choice='plain'>ID</arg></arg>
81
83
      <arg choice='opt'>--plugin-dir<arg choice='plain'>DIRECTORY</arg></arg>
82
84
      <arg choice='opt'>--debug</arg>
83
85
    </cmdsynopsis>
92
94
    <cmdsynopsis>
93
95
      <command>&COMMANDNAME;</command>
94
96
      <arg choice='plain'>--version</arg>
95
 
    </cmdsynopsis>    
 
97
    </cmdsynopsis>
96
98
  </refsynopsisdiv>
97
99
 
98
100
  <refsect1 id="description">
100
102
    <para>
101
103
      <command>&COMMANDNAME;</command> is a plugin runner that waits
102
104
      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.
 
105
      passes it to cryptsetup as stdout message. This command is not
 
106
      meant to be invoked directly, but is instead meant to be run by
 
107
      cryptsetup by being specified in /etc/crypttab as a keyscript
 
108
      and subsequlently started in the initrd environment. See
 
109
      <citerefentry><refentrytitle>crypttab</refentrytitle>
 
110
      <manvolnum>5</manvolnum></citerefentry> for more information on
 
111
      keyscripts.
106
112
    </para>
107
113
 
 
114
    <para>
 
115
      plugins is looked for in the plugins directory which by default will be
 
116
      /conf/conf.d/mandos/plugins.d if not changed by option --plugin-dir.
 
117
    </para>
 
118
  </refsect1>
 
119
  <refsect1>
 
120
    <title>OPTIONS</title>
108
121
    <variablelist>
109
122
      <varlistentry>
110
123
        <term><literal>-g</literal>,<literal>--global-options
114
127
            Global options given to all plugins as additional start
115
128
            arguments.  Options are specified with a -o flag followed
116
129
            by a comma separated string of options.
117
 
          </para>         
 
130
          </para>       
118
131
        </listitem>
119
132
      </varlistentry>
120
133
 
127
140
            Plugin specific options given to the plugin as additional
128
141
            start arguments.  Options are specified with a -o flag
129
142
            followed by a comma separated string of options.
130
 
          </para>         
 
143
          </para>       
131
144
        </listitem>
132
 
      </varlistentry>      
 
145
      </varlistentry>
133
146
 
134
147
      <varlistentry>
135
148
        <term><literal>-d</literal>,<literal> --disable
138
151
        <listitem>
139
152
          <para>
140
153
            Disable a specific plugin
141
 
          </para>         
 
154
          </para>       
142
155
        </listitem>
143
156
      </varlistentry>
144
157
 
150
163
            Group ID the plugins will run as
151
164
          </para>
152
165
        </listitem>
153
 
      </varlistentry>      
 
166
      </varlistentry>
154
167
 
155
168
      <varlistentry>
156
169
        <term><literal>--userid <replaceable>ID</replaceable>
160
173
            User ID the plugins will run as
161
174
          </para>
162
175
        </listitem>
163
 
      </varlistentry>      
 
176
      </varlistentry>
164
177
 
165
178
      <varlistentry>
166
179
        <term><literal>--plugin-dir <replaceable>DIRECTORY</replaceable>
170
183
            Specify a different plugin directory
171
184
          </para>
172
185
        </listitem>
173
 
      </varlistentry>       
 
186
      </varlistentry>
174
187
      
175
188
      <varlistentry>
176
189
        <term><literal>--debug</literal></term>
206
219
            Prints the program version
207
220
          </para>
208
221
        </listitem>
209
 
      </varlistentry>            
 
222
      </varlistentry>
210
223
    </variablelist>
211
224
  </refsect1>
 
225
 
 
226
  <refsect1 id="exit_status">
 
227
    <title>EXIT STATUS</title>
 
228
    <para>
 
229
    </para>
 
230
  </refsect1>
 
231
 
 
232
  <refsect1 id="file">
 
233
    <title>FILES</title>
 
234
    <para>
 
235
    </para>
 
236
  </refsect1>
 
237
 
 
238
  <refsect1 id="notes">
 
239
    <title>NOTES</title>
 
240
    <para>
 
241
    </para>
 
242
  </refsect1>
 
243
  
 
244
  <refsect1 id="bugs">
 
245
    <title>BUGS</title>
 
246
    <para>
 
247
    </para>
 
248
  </refsect1>
 
249
 
 
250
  <refsect1 id="examples">
 
251
    <title>EXAMPLE</title>
 
252
    <para>
 
253
    </para>
 
254
  </refsect1>
 
255
 
 
256
  <refsect1 id="security">
 
257
    <title>SECURITY</title>
 
258
    <para>
 
259
    </para>
 
260
  </refsect1>
 
261
 
 
262
  <refsect1 id="see_also">
 
263
    <title>SEE ALSO</title>
 
264
    <para>
 
265
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
 
266
      <manvolnum>8</manvolnum></citerefentry>,
 
267
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
268
      <manvolnum>8</manvolnum></citerefentry>,
 
269
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
 
270
      <manvolnum>8mandos</manvolnum></citerefentry>,
 
271
      <citerefentry><refentrytitle>password-request</refentrytitle>
 
272
      <manvolnum>8mandos</manvolnum></citerefentry>
 
273
    </para>
 
274
  </refsect1>
 
275
 
212
276
</refentry>
 
277
<!-- Local Variables: -->
 
278
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
279
<!-- time-stamp-end: "[\"']>" -->
 
280
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
281
<!-- End: -->