/mandos/trunk

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos-client.xml

removed * [[http://en.tldp.org/HOWTO/Software-Release-Practice-HOWTO/][Software Release Practice HOWTO]]

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>
68
66
  <refnamediv>
69
67
    <refname><command>&COMMANDNAME;</command></refname>
70
68
    <refpurpose>
71
 
      Run Mandos plugins.  Pass data from first succesful one.
 
69
      get password for encrypted rootdisk
72
70
    </refpurpose>
73
71
  </refnamediv>
74
72
 
75
73
  <refsynopsisdiv>
76
74
    <cmdsynopsis>
77
75
      <command>&COMMANDNAME;</command>
78
 
      <group rep="repeat">
79
 
        <arg choice="plain"><option>--global-envs=<replaceable
80
 
        >VAR</replaceable><literal>=</literal><replaceable
81
 
        >value</replaceable></option></arg>
82
 
        <arg choice="plain"><option>-e
83
 
        <replaceable>VAR</replaceable><literal>=</literal><replaceable
84
 
        >value</replaceable> </option></arg>
85
 
      </group>
86
 
      <sbr/>
87
 
      <group rep="repeat">
88
 
        <arg choice="plain"><option>--envs-for=<replaceable
89
 
        >PLUGIN</replaceable><literal>:</literal><replaceable
90
 
        >ENV</replaceable><literal>=</literal><replaceable
91
 
        >value</replaceable></option></arg>
92
 
        <arg choice="plain"><option>-f<replaceable>
93
 
        PLUGIN</replaceable><literal>:</literal><replaceable
94
 
        >ENV</replaceable><literal>=</literal><replaceable
95
 
        >value</replaceable> </option></arg>
96
 
      </group>
97
 
      <sbr/>
98
 
      <group rep="repeat">
99
 
        <arg choice="plain"><option>--global-options=<replaceable
100
 
        >OPTIONS</replaceable></option></arg>
101
 
        <arg choice="plain"><option>-g<replaceable>
102
 
        OPTIONS</replaceable> </option></arg>
103
 
      </group>
104
 
      <sbr/>
105
 
      <group rep="repeat">
106
 
        <arg choice="plain"><option>--options-for=<replaceable
107
 
        >PLUGIN</replaceable><literal>:</literal><replaceable
108
 
        >OPTIONS</replaceable></option></arg>
109
 
        <arg choice="plain"><option>-f<replaceable>
110
 
        PLUGIN</replaceable><literal>:</literal><replaceable
111
 
        >OPTIONS</replaceable> </option></arg>
112
 
      </group>
113
 
      <sbr/>
114
 
      <group rep="repeat">
115
 
        <arg choice="plain"><option>--disable=<replaceable
116
 
        >PLUGIN</replaceable></option></arg>
117
 
        <arg choice="plain"><option>-d
118
 
        <replaceable>PLUGIN</replaceable> </option></arg>
119
 
      </group>
120
 
      <sbr/>
121
 
      <arg><option>--groupid=<replaceable
122
 
      >ID</replaceable></option></arg>
123
 
      <sbr/>
124
 
      <arg><option>--userid=<replaceable
125
 
      >ID</replaceable></option></arg>
126
 
      <sbr/>
127
 
      <arg><option>--plugin-dir=<replaceable
128
 
      >DIRECTORY</replaceable></option></arg>
129
 
      <sbr/>
130
 
      <arg><option>--debug</option></arg>
131
 
    </cmdsynopsis>
132
 
    <cmdsynopsis>
133
 
      <command>&COMMANDNAME;</command>
134
 
      <group choice="req">
135
 
        <arg choice='plain'><option>--help</option></arg>
136
 
        <arg choice='plain'><option>-?</option></arg>
137
 
      </group>
138
 
    </cmdsynopsis>
139
 
    <cmdsynopsis>
140
 
      <command>&COMMANDNAME;</command>
141
 
      <arg choice='plain'><option>--usage</option></arg>
142
 
    </cmdsynopsis>
143
 
    <cmdsynopsis>
144
 
      <command>&COMMANDNAME;</command>
145
 
      <group choice="req">
146
 
        <arg choice='plain'><option>--version</option></arg>
147
 
        <arg choice='plain'><option>-V</option></arg>
148
 
      </group>
 
76
      <arg choice='opt' rep='repeat'>OPTION</arg>
149
77
    </cmdsynopsis>
150
78
  </refsynopsisdiv>
151
79
 
154
82
    <para>
155
83
      <command>&COMMANDNAME;</command> is a plugin runner that waits
156
84
      for any of its plugins to return sucessfull with a password, and
157
 
      passes it to cryptsetup as stdout message. This command is not
158
 
      meant to be invoked directly, but is instead meant to be run by
159
 
      cryptsetup by being specified in /etc/crypttab as a keyscript
160
 
      and subsequlently started in the initrd environment. See
161
 
      <citerefentry><refentrytitle>crypttab</refentrytitle>
162
 
      <manvolnum>5</manvolnum></citerefentry> for more information on
163
 
      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.
164
88
    </para>
165
89
 
166
 
    <para>
167
 
      plugins is looked for in the plugins directory which by default will be
168
 
      /conf/conf.d/mandos/plugins.d if not changed by option --plugin-dir.
169
 
    </para>
170
 
  </refsect1>
171
 
  <refsect1>
172
 
    <title>OPTIONS</title>
173
90
    <variablelist>
174
91
      <varlistentry>
175
92
        <term><literal>-g</literal>,<literal>--global-options
179
96
            Global options given to all plugins as additional start
180
97
            arguments.  Options are specified with a -o flag followed
181
98
            by a comma separated string of options.
182
 
          </para>       
 
99
          </para>         
183
100
        </listitem>
184
101
      </varlistentry>
185
102
 
192
109
            Plugin specific options given to the plugin as additional
193
110
            start arguments.  Options are specified with a -o flag
194
111
            followed by a comma separated string of options.
195
 
          </para>       
 
112
          </para>         
196
113
        </listitem>
197
 
      </varlistentry>
 
114
      </varlistentry>      
198
115
 
199
116
      <varlistentry>
200
117
        <term><literal>-d</literal>,<literal> --disable
203
120
        <listitem>
204
121
          <para>
205
122
            Disable a specific plugin
206
 
          </para>       
 
123
          </para>         
207
124
        </listitem>
208
125
      </varlistentry>
209
126
 
215
132
            Group ID the plugins will run as
216
133
          </para>
217
134
        </listitem>
218
 
      </varlistentry>
 
135
      </varlistentry>      
219
136
 
220
137
      <varlistentry>
221
138
        <term><literal>--userid <replaceable>ID</replaceable>
225
142
            User ID the plugins will run as
226
143
          </para>
227
144
        </listitem>
228
 
      </varlistentry>
 
145
      </varlistentry>      
229
146
 
230
147
      <varlistentry>
231
148
        <term><literal>--plugin-dir <replaceable>DIRECTORY</replaceable>
235
152
            Specify a different plugin directory
236
153
          </para>
237
154
        </listitem>
238
 
      </varlistentry>
 
155
      </varlistentry>       
239
156
      
240
157
      <varlistentry>
241
158
        <term><literal>--debug</literal></term>
271
188
            Prints the program version
272
189
          </para>
273
190
        </listitem>
274
 
      </varlistentry>
 
191
      </varlistentry>            
275
192
    </variablelist>
276
193
  </refsect1>
277
 
 
278
 
  <refsect1 id="exit_status">
279
 
    <title>EXIT STATUS</title>
280
 
    <para>
281
 
    </para>
282
 
  </refsect1>
283
 
 
284
 
  <refsect1 id="file">
285
 
    <title>FILES</title>
286
 
    <para>
287
 
    </para>
288
 
  </refsect1>
289
 
 
290
 
  <refsect1 id="notes">
291
 
    <title>NOTES</title>
292
 
    <para>
293
 
    </para>
294
 
  </refsect1>
295
 
  
296
 
  <refsect1 id="bugs">
297
 
    <title>BUGS</title>
298
 
    <para>
299
 
    </para>
300
 
  </refsect1>
301
 
 
302
 
  <refsect1 id="examples">
303
 
    <title>EXAMPLE</title>
304
 
    <para>
305
 
    </para>
306
 
  </refsect1>
307
 
 
308
 
  <refsect1 id="security">
309
 
    <title>SECURITY</title>
310
 
    <para>
311
 
    </para>
312
 
  </refsect1>
313
 
 
314
 
  <refsect1 id="see_also">
315
 
    <title>SEE ALSO</title>
316
 
    <para>
317
 
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
318
 
      <manvolnum>8</manvolnum></citerefentry>,
319
 
      <citerefentry><refentrytitle>mandos</refentrytitle>
320
 
      <manvolnum>8</manvolnum></citerefentry>,
321
 
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
322
 
      <manvolnum>8mandos</manvolnum></citerefentry>,
323
 
      <citerefentry><refentrytitle>password-request</refentrytitle>
324
 
      <manvolnum>8mandos</manvolnum></citerefentry>
325
 
    </para>
326
 
  </refsect1>
327
 
 
328
194
</refentry>
329
 
<!-- Local Variables: -->
330
 
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
331
 
<!-- time-stamp-end: "[\"']>" -->
332
 
<!-- time-stamp-format: "%:y-%02m-%02d" -->
333
 
<!-- End: -->