/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 19:05:15 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080830190515-l7e6vu81yyw5kcku
* mandos.xml (SYNOPSIS): Use <option> and <replaceable> tags.  Unify
                         short and long 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>
73
75
  <refsynopsisdiv>
74
76
    <cmdsynopsis>
75
77
      <command>&COMMANDNAME;</command>
76
 
      <arg choice='opt' rep='repeat'>OPTION</arg>
 
78
      <arg choice='opt'>--global-options<arg choice='plain'>OPTIONS</arg></arg>
 
79
      <arg choice='opt'>--options-for<arg choice='plain'>PLUGIN:OPTIONS</arg></arg>
 
80
      <arg choice='opt'>--disable<arg choice='plain'>PLUGIN</arg></arg>
 
81
      <arg choice='opt'>--groupid<arg choice='plain'>ID</arg></arg>
 
82
      <arg choice='opt'>--userid<arg choice='plain'>ID</arg></arg>
 
83
      <arg choice='opt'>--plugin-dir<arg choice='plain'>DIRECTORY</arg></arg>
 
84
      <arg choice='opt'>--debug</arg>
 
85
    </cmdsynopsis>
 
86
    <cmdsynopsis>
 
87
      <command>&COMMANDNAME;</command>
 
88
      <arg choice='plain'>--help</arg>
 
89
    </cmdsynopsis>
 
90
    <cmdsynopsis>
 
91
      <command>&COMMANDNAME;</command>
 
92
      <arg choice='plain'>--usage</arg>
 
93
    </cmdsynopsis>
 
94
    <cmdsynopsis>
 
95
      <command>&COMMANDNAME;</command>
 
96
      <arg choice='plain'>--version</arg>
77
97
    </cmdsynopsis>
78
98
  </refsynopsisdiv>
79
99
 
82
102
    <para>
83
103
      <command>&COMMANDNAME;</command> is a plugin runner that waits
84
104
      for any of its plugins to return sucessfull with a password, and
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.
 
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.
88
112
    </para>
89
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>
90
121
    <variablelist>
91
122
      <varlistentry>
92
123
        <term><literal>-g</literal>,<literal>--global-options
96
127
            Global options given to all plugins as additional start
97
128
            arguments.  Options are specified with a -o flag followed
98
129
            by a comma separated string of options.
99
 
          </para>         
 
130
          </para>       
100
131
        </listitem>
101
132
      </varlistentry>
102
133
 
109
140
            Plugin specific options given to the plugin as additional
110
141
            start arguments.  Options are specified with a -o flag
111
142
            followed by a comma separated string of options.
112
 
          </para>         
 
143
          </para>       
113
144
        </listitem>
114
 
      </varlistentry>      
 
145
      </varlistentry>
115
146
 
116
147
      <varlistentry>
117
148
        <term><literal>-d</literal>,<literal> --disable
120
151
        <listitem>
121
152
          <para>
122
153
            Disable a specific plugin
123
 
          </para>         
 
154
          </para>       
124
155
        </listitem>
125
156
      </varlistentry>
126
157
 
132
163
            Group ID the plugins will run as
133
164
          </para>
134
165
        </listitem>
135
 
      </varlistentry>      
 
166
      </varlistentry>
136
167
 
137
168
      <varlistentry>
138
169
        <term><literal>--userid <replaceable>ID</replaceable>
142
173
            User ID the plugins will run as
143
174
          </para>
144
175
        </listitem>
145
 
      </varlistentry>      
 
176
      </varlistentry>
146
177
 
147
178
      <varlistentry>
148
179
        <term><literal>--plugin-dir <replaceable>DIRECTORY</replaceable>
152
183
            Specify a different plugin directory
153
184
          </para>
154
185
        </listitem>
155
 
      </varlistentry>       
 
186
      </varlistentry>
156
187
      
157
188
      <varlistentry>
158
189
        <term><literal>--debug</literal></term>
188
219
            Prints the program version
189
220
          </para>
190
221
        </listitem>
191
 
      </varlistentry>            
 
222
      </varlistentry>
192
223
    </variablelist>
193
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
 
194
276
</refentry>
 
277
<!-- Local Variables: -->
 
278
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
 
279
<!-- time-stamp-end: "[\"']>" -->
 
280
<!-- time-stamp-format: "%:y-%02m-%02d" -->
 
281
<!-- End: -->