/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-27 01:18:25 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080827011825-ka3ni6xvy2ehi1y8
* .bzrignore: New.

* clients.conf ([foo]): Remove Radix-64 checksum.

* mandos (AvahiService.rename, server_state_changed,
          entry_group_state_changed): Make Avahi log messages more
                                      clear that they are about
                                      Zeroconf.
  (fingerprint): Use plain "0" instead of "ctypes.c_uint(0)".

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
8
]>
9
9
 
10
10
<refentry>
73
73
  <refsynopsisdiv>
74
74
    <cmdsynopsis>
75
75
      <command>&COMMANDNAME;</command>
76
 
      <arg choice='opt' rep='repeat'>OPTION</arg>
77
 
    </cmdsynopsis>
 
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
96
  </refsynopsisdiv>
79
97
 
80
98
  <refsect1 id="description">
82
100
    <para>
83
101
      <command>&COMMANDNAME;</command> is a plugin runner that waits
84
102
      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.
 
103
      passes it to cryptsetup as stdout message. This command is not
 
104
      meant to be invoked directly, but is instead meant to be run by
 
105
      cryptsetup by being specified in /etc/crypttab as a keyscript
 
106
      and subsequlently started in the initrd environment. See
 
107
      <citerefentry><refentrytitle>crypttab</refentrytitle>
 
108
      <manvolnum>5</manvolnum></citerefentry> for more information on
 
109
      keyscripts.    
88
110
    </para>
89
111
 
 
112
    <para>
 
113
      plugins is looked for in the plugins directory which by default will be
 
114
      /conf/conf.d/mandos/plugins.d if not changed by option --plugin-dir.
 
115
    </para>
 
116
  </refsect1>
 
117
  <refsect1>
 
118
    <title>OPTIONS</title>
90
119
    <variablelist>
91
120
      <varlistentry>
92
121
        <term><literal>-g</literal>,<literal>--global-options
191
220
      </varlistentry>            
192
221
    </variablelist>
193
222
  </refsect1>
 
223
 
 
224
  <refsect1 id="exit_status">
 
225
    <title>EXIT STATUS</title>
 
226
    <para>
 
227
    </para>
 
228
  </refsect1>
 
229
 
 
230
  <refsect1 id="file">
 
231
    <title>FILES</title>
 
232
    <para>
 
233
    </para>
 
234
  </refsect1>  
 
235
 
 
236
  <refsect1 id="notes">
 
237
    <title>NOTES</title>
 
238
    <para>
 
239
    </para>
 
240
  </refsect1>
 
241
  
 
242
  <refsect1 id="bugs">
 
243
    <title>BUGS</title>
 
244
    <para>
 
245
    </para>
 
246
  </refsect1>  
 
247
 
 
248
  <refsect1 id="examples">
 
249
    <title>EXAMPLES</title>
 
250
    <para>
 
251
    </para>
 
252
  </refsect1>
 
253
 
 
254
  <refsect1 id="security">
 
255
    <title>SECURITY</title>
 
256
    <para>
 
257
    </para>
 
258
  </refsect1>
 
259
 
 
260
  <refsect1 id="see_also">
 
261
    <title>SEE ALSO</title>
 
262
    <para>
 
263
      <citerefentry><refentrytitle>mandos</refentrytitle>
 
264
      <manvolnum>8</manvolnum></citerefentry>, <citerefentry>
 
265
      <refentrytitle>password-request</refentrytitle>
 
266
      <manvolnum>8mandos</manvolnum></citerefentry>, <citerefentry>
 
267
      <refentrytitle>password-prompt</refentrytitle>
 
268
      <manvolnum>8mandos</manvolnum></citerefentry>, and
 
269
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
 
270
      <manvolnum>8</manvolnum></citerefentry>
 
271
    </para>
 
272
  </refsect1>
 
273
 
194
274
</refentry>