/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 mandos-client.xml

  • Committer: Teddy Hogeborn
  • Date: 2008-08-09 04:56:00 UTC
  • mfrom: (24.1.27 mandos)
  • Revision ID: teddy@fukt.bsnet.se-20080809045600-m7jx3tj4wwunaffa
Merge.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos-client.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 "plugin-runner">
8
 
<!ENTITY TIMESTAMP "2008-08-30">
 
7
<!ENTITY COMMANDNAME "mandos-client">
9
8
]>
10
9
 
11
10
<refentry>
12
11
  <refentryinfo>
13
 
    <title>Mandos Manual</title>
 
12
    <title>&COMMANDNAME;</title>
14
13
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
15
 
    <productname>Mandos</productname>
 
14
    <productname>&COMMANDNAME;</productname>
16
15
    <productnumber>&VERSION;</productnumber>
17
 
    <date>&TIMESTAMP;</date>
18
16
    <authorgroup>
19
17
      <author>
20
18
        <firstname>Björn</firstname>
75
73
  <refsynopsisdiv>
76
74
    <cmdsynopsis>
77
75
      <command>&COMMANDNAME;</command>
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>
 
76
      <arg choice='opt' rep='repeat'>OPTION</arg>
97
77
    </cmdsynopsis>
98
78
  </refsynopsisdiv>
99
79
 
102
82
    <para>
103
83
      <command>&COMMANDNAME;</command> is a plugin runner that waits
104
84
      for any of its plugins to return sucessfull with a password, and
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.
 
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.
112
88
    </para>
113
89
 
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>
121
90
    <variablelist>
122
91
      <varlistentry>
123
92
        <term><literal>-g</literal>,<literal>--global-options
127
96
            Global options given to all plugins as additional start
128
97
            arguments.  Options are specified with a -o flag followed
129
98
            by a comma separated string of options.
130
 
          </para>       
 
99
          </para>         
131
100
        </listitem>
132
101
      </varlistentry>
133
102
 
140
109
            Plugin specific options given to the plugin as additional
141
110
            start arguments.  Options are specified with a -o flag
142
111
            followed by a comma separated string of options.
143
 
          </para>       
 
112
          </para>         
144
113
        </listitem>
145
 
      </varlistentry>
 
114
      </varlistentry>      
146
115
 
147
116
      <varlistentry>
148
117
        <term><literal>-d</literal>,<literal> --disable
151
120
        <listitem>
152
121
          <para>
153
122
            Disable a specific plugin
154
 
          </para>       
 
123
          </para>         
155
124
        </listitem>
156
125
      </varlistentry>
157
126
 
163
132
            Group ID the plugins will run as
164
133
          </para>
165
134
        </listitem>
166
 
      </varlistentry>
 
135
      </varlistentry>      
167
136
 
168
137
      <varlistentry>
169
138
        <term><literal>--userid <replaceable>ID</replaceable>
173
142
            User ID the plugins will run as
174
143
          </para>
175
144
        </listitem>
176
 
      </varlistentry>
 
145
      </varlistentry>      
177
146
 
178
147
      <varlistentry>
179
148
        <term><literal>--plugin-dir <replaceable>DIRECTORY</replaceable>
183
152
            Specify a different plugin directory
184
153
          </para>
185
154
        </listitem>
186
 
      </varlistentry>
 
155
      </varlistentry>       
187
156
      
188
157
      <varlistentry>
189
158
        <term><literal>--debug</literal></term>
219
188
            Prints the program version
220
189
          </para>
221
190
        </listitem>
222
 
      </varlistentry>
 
191
      </varlistentry>            
223
192
    </variablelist>
224
193
  </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
 
 
276
194
</refentry>
277
 
<!-- Local Variables: -->
278
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
279
 
<!-- time-stamp-end: "[\"']>" -->
280
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
281
 
<!-- End: -->