/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: Björn Påhlsson
  • Date: 2008-08-08 01:31:58 UTC
  • mto: (237.7.1 mandos) (24.1.154 mandos)
  • mto: This revision was merged to the branch mainline in revision 50.
  • Revision ID: belorn@braxen-20080808013158-weqgqkxni7du1ke5
Added manual pages for:
      clients.conf
      mandos.conf
      mandos
      mandos-client
      password-prompt
      password-request

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-29">
 
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>
97
 
    </cmdsynopsis>    
 
76
      <arg choice='opt' rep='repeat'>OPTION</arg>
 
77
    </cmdsynopsis>
98
78
  </refsynopsisdiv>
99
79
 
100
80
  <refsect1 id="description">
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
222
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: -->