/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release
129 by Teddy Hogeborn
* mandos-clients.conf.xml: Changed all single quotes to double quotes
1
<?xml version="1.0" encoding="UTF-8"?>
24.1.23 by Björn Påhlsson
Added manual pages for:
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
	"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4
<!ENTITY VERSION "1.0">
74 by Teddy Hogeborn
* Makefile (PREFIX, CONFDIR): New.
5
<!ENTITY COMMANDNAME "plugin-runner">
134 by Teddy Hogeborn
* mandos.xml: Enclose "RAM" with <acronym>.
6
<!ENTITY TIMESTAMP "2008-09-01">
24.1.23 by Björn Påhlsson
Added manual pages for:
7
]>
8
131 by Teddy Hogeborn
* Makefile: Make all DocBook rules include legalnotice.xml as a
9
<refentry xmlns:xi="http://www.w3.org/2001/XInclude">
24.1.23 by Björn Påhlsson
Added manual pages for:
10
  <refentryinfo>
112 by Teddy Hogeborn
* mandos-clients.conf.xml (/refentry/refentryinfo/title): Changed to
11
    <title>Mandos Manual</title>
129 by Teddy Hogeborn
* mandos-clients.conf.xml: Changed all single quotes to double quotes
12
    <!-- Nwalsh’s docbook scripts use this to generate the footer: -->
112 by Teddy Hogeborn
* mandos-clients.conf.xml (/refentry/refentryinfo/title): Changed to
13
    <productname>Mandos</productname>
24.1.23 by Björn Påhlsson
Added manual pages for:
14
    <productnumber>&VERSION;</productnumber>
111 by Teddy Hogeborn
* mandos-clients.conf.xml (ENTITY TIMESTAMP): New. Automatically
15
    <date>&TIMESTAMP;</date>
24.1.23 by Björn Påhlsson
Added manual pages for:
16
    <authorgroup>
17
      <author>
18
	<firstname>Björn</firstname>
19
	<surname>Påhlsson</surname>
20
	<address>
21
	  <email>belorn@fukt.bsnet.se</email>
22
	</address>
23
      </author>
24
      <author>
25
	<firstname>Teddy</firstname>
26
	<surname>Hogeborn</surname>
27
	<address>
28
	  <email>teddy@fukt.bsnet.se</email>
29
	</address>
30
      </author>
31
    </authorgroup>
32
    <copyright>
33
      <year>2008</year>
128 by Teddy Hogeborn
* plugin-runner.xml (/refentry/refentryinfo/copyright): Split
34
      <holder>Teddy Hogeborn</holder>
35
      <holder>Björn Påhlsson</holder>
24.1.23 by Björn Påhlsson
Added manual pages for:
36
    </copyright>
131 by Teddy Hogeborn
* Makefile: Make all DocBook rules include legalnotice.xml as a
37
    <xi:include href="legalnotice.xml"/>
24.1.23 by Björn Påhlsson
Added manual pages for:
38
  </refentryinfo>
39
40
  <refmeta>
41
    <refentrytitle>&COMMANDNAME;</refentrytitle>
42
    <manvolnum>8mandos</manvolnum>
43
  </refmeta>
44
  
45
  <refnamediv>
46
    <refname><command>&COMMANDNAME;</command></refname>
47
    <refpurpose>
121 by Teddy Hogeborn
* plugin-runner.xml (NAME): Improved wording.
48
      Run Mandos plugins.  Pass data from first succesful one.
24.1.23 by Björn Påhlsson
Added manual pages for:
49
    </refpurpose>
50
  </refnamediv>
51
52
  <refsynopsisdiv>
53
    <cmdsynopsis>
54
      <command>&COMMANDNAME;</command>
121 by Teddy Hogeborn
* plugin-runner.xml (NAME): Improved wording.
55
      <group rep="repeat">
56
	<arg choice="plain"><option>--global-envs=<replaceable
57
	>VAR</replaceable><literal>=</literal><replaceable
58
	>value</replaceable></option></arg>
59
	<arg choice="plain"><option>-e
60
	<replaceable>VAR</replaceable><literal>=</literal><replaceable
61
	>value</replaceable> </option></arg>
62
      </group>
63
      <sbr/>
64
      <group rep="repeat">
65
	<arg choice="plain"><option>--envs-for=<replaceable
66
	>PLUGIN</replaceable><literal>:</literal><replaceable
67
	>ENV</replaceable><literal>=</literal><replaceable
68
	>value</replaceable></option></arg>
69
	<arg choice="plain"><option>-f<replaceable>
70
	PLUGIN</replaceable><literal>:</literal><replaceable
71
	>ENV</replaceable><literal>=</literal><replaceable
72
	>value</replaceable> </option></arg>
73
      </group>
74
      <sbr/>
75
      <group rep="repeat">
76
	<arg choice="plain"><option>--global-options=<replaceable
77
	>OPTIONS</replaceable></option></arg>
78
	<arg choice="plain"><option>-g<replaceable>
79
	OPTIONS</replaceable> </option></arg>
80
      </group>
81
      <sbr/>
82
      <group rep="repeat">
83
	<arg choice="plain"><option>--options-for=<replaceable
84
	>PLUGIN</replaceable><literal>:</literal><replaceable
85
	>OPTIONS</replaceable></option></arg>
86
	<arg choice="plain"><option>-f<replaceable>
87
	PLUGIN</replaceable><literal>:</literal><replaceable
88
	>OPTIONS</replaceable> </option></arg>
89
      </group>
90
      <sbr/>
91
      <group rep="repeat">
92
	<arg choice="plain"><option>--disable=<replaceable
93
	>PLUGIN</replaceable></option></arg>
94
	<arg choice="plain"><option>-d
95
	<replaceable>PLUGIN</replaceable> </option></arg>
96
      </group>
97
      <sbr/>
98
      <arg><option>--groupid=<replaceable
99
      >ID</replaceable></option></arg>
100
      <sbr/>
101
      <arg><option>--userid=<replaceable
102
      >ID</replaceable></option></arg>
103
      <sbr/>
104
      <arg><option>--plugin-dir=<replaceable
105
      >DIRECTORY</replaceable></option></arg>
106
      <sbr/>
107
      <arg><option>--debug</option></arg>
108
    </cmdsynopsis>
109
    <cmdsynopsis>
110
      <command>&COMMANDNAME;</command>
111
      <group choice="req">
129 by Teddy Hogeborn
* mandos-clients.conf.xml: Changed all single quotes to double quotes
112
	<arg choice="plain"><option>--help</option></arg>
113
	<arg choice="plain"><option>-?</option></arg>
121 by Teddy Hogeborn
* plugin-runner.xml (NAME): Improved wording.
114
      </group>
115
    </cmdsynopsis>
116
    <cmdsynopsis>
117
      <command>&COMMANDNAME;</command>
129 by Teddy Hogeborn
* mandos-clients.conf.xml: Changed all single quotes to double quotes
118
      <arg choice="plain"><option>--usage</option></arg>
121 by Teddy Hogeborn
* plugin-runner.xml (NAME): Improved wording.
119
    </cmdsynopsis>
120
    <cmdsynopsis>
121
      <command>&COMMANDNAME;</command>
122
      <group choice="req">
129 by Teddy Hogeborn
* mandos-clients.conf.xml: Changed all single quotes to double quotes
123
	<arg choice="plain"><option>--version</option></arg>
124
	<arg choice="plain"><option>-V</option></arg>
121 by Teddy Hogeborn
* plugin-runner.xml (NAME): Improved wording.
125
      </group>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
126
    </cmdsynopsis>
24.1.23 by Björn Påhlsson
Added manual pages for:
127
  </refsynopsisdiv>
134 by Teddy Hogeborn
* mandos.xml: Enclose "RAM" with <acronym>.
128
  
24.1.23 by Björn Påhlsson
Added manual pages for:
129
  <refsect1 id="description">
130
    <title>DESCRIPTION</title>
131
    <para>
134 by Teddy Hogeborn
* mandos.xml: Enclose "RAM" with <acronym>.
132
      <command>&COMMANDNAME;</command> is a program which is meant to
133
      be specified as <quote>keyscript</quote> in <citerefentry>
134
      <refentrytitle>crypttab</refentrytitle>
135
      <manvolnum>5</manvolnum></citerefentry> for the root disk.  The
136
      aim of this program is therefore to output a password, which
137
      then <citerefentry><refentrytitle>cryptsetup</refentrytitle>
138
      <manvolnum>8</manvolnum></citerefentry> will use to try and
139
      unlock the root disk.
140
    </para>
141
    <para>
142
      This program is not meant to be invoked directly, but can be in
143
      order to test it.  Note that any password obtained will simply
144
      be output on standard output.
145
    </para>
146
  </refsect1>
147
  
148
  <refsect1 id="purpose">
149
    <title>PURPOSE</title>
150
    <para>
151
      The purpose of this is to enable <emphasis>remote and unattended
152
      rebooting</emphasis> of client host computer with an
153
      <emphasis>encrypted root file system</emphasis>.  See <xref
154
      linkend="overview"/> for details.
155
    </para>
156
  </refsect1>
157
  
24.1.38 by Björn Påhlsson
changed description to better fit role
158
  <refsect1>
159
    <title>OPTIONS</title>
24.1.23 by Björn Påhlsson
Added manual pages for:
160
    <variablelist>
161
      <varlistentry>
125 by Teddy Hogeborn
* plugin-runner.xml (OPTIONS): Use <option> tags instead of
162
	<term><option>--global-options
163
	<replaceable>OPTIONS</replaceable></option></term>
164
	<term><option>-g
165
	<replaceable>OPTIONS</replaceable></option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
166
	<listitem>
167
	  <para>
134 by Teddy Hogeborn
* mandos.xml: Enclose "RAM" with <acronym>.
168
	    Pass some options to <emphasis>all</emphasis> plugins.
169
	    <replaceable>OPTIONS</replaceable> is a comma separated
170
	    list of options.  This is not a very useful option, except
171
	    for specifying the <quote><option>--debug</option></quote>
172
	    for all plugins.
173
	  </para>
24.1.23 by Björn Påhlsson
Added manual pages for:
174
	</listitem>
175
      </varlistentry>
134 by Teddy Hogeborn
* mandos.xml: Enclose "RAM" with <acronym>.
176
      
24.1.23 by Björn Påhlsson
Added manual pages for:
177
      <varlistentry>
125 by Teddy Hogeborn
* plugin-runner.xml (OPTIONS): Use <option> tags instead of
178
	<term><option>--options-for
179
	<replaceable>PLUGIN</replaceable><literal>:</literal
180
	><replaceable>OPTION</replaceable></option></term>
181
	<term><option>-o
182
	<replaceable>PLUGIN</replaceable><literal>:</literal
183
	><replaceable>OPTION</replaceable></option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
184
	<listitem>
185
	  <para>
134 by Teddy Hogeborn
* mandos.xml: Enclose "RAM" with <acronym>.
186
	    Pass some options to a specific plugin.  <replaceable
187
	    >PLUGIN</replaceable> is the name (file basename) of a
188
	    plugin, and <replaceable>OPTIONS</replaceable> is a comma
189
	    separated list of options.
190
	  </para>
191
	  <para>
192
	    Note that since options are not split on whitespace, the
193
	    way to pass, to the plugin
194
	    <quote><filename>foo</filename></quote>, the option
195
	    <option>--bar</option> with the option argument
196
	    <quote>baz</quote> is either
197
	    <userinput>--options-for=foo:--bar=baz</userinput> or
198
	    <userinput>--options-for=foo:--bar,baz</userinput>, but
199
	    <emphasis>not</emphasis>
200
	    <userinput>--options-for="foo:--bar baz"</userinput>.
201
	  </para>
24.1.23 by Björn Påhlsson
Added manual pages for:
202
	</listitem>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
203
      </varlistentry>
24.1.23 by Björn Påhlsson
Added manual pages for:
204
205
      <varlistentry>
125 by Teddy Hogeborn
* plugin-runner.xml (OPTIONS): Use <option> tags instead of
206
	<term><option> --disable
207
	<replaceable>PLUGIN</replaceable></option></term>
208
	<term><option>-d
209
	<replaceable>PLUGIN</replaceable></option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
210
	<listitem>
211
	  <para>
134 by Teddy Hogeborn
* mandos.xml: Enclose "RAM" with <acronym>.
212
	    Disable the plugin named
213
	    <replaceable>PLUGIN</replaceable>.  The plugin will not be
214
	    started.
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
215
	  </para>	
24.1.23 by Björn Påhlsson
Added manual pages for:
216
	</listitem>
217
      </varlistentry>
218
219
      <varlistentry>
125 by Teddy Hogeborn
* plugin-runner.xml (OPTIONS): Use <option> tags instead of
220
	<term><option>--groupid
221
	<replaceable>ID</replaceable></option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
222
	<listitem>
223
	  <para>
134 by Teddy Hogeborn
* mandos.xml: Enclose "RAM" with <acronym>.
224
	    Change to group ID <replaceable>ID</replaceable> on
225
	    startup.  The default is 65534.  All plugins will be
226
	    started using this group ID.  <emphasis>Note:</emphasis>
227
	    This must be a number, not a name.
24.1.23 by Björn Påhlsson
Added manual pages for:
228
	  </para>
229
	</listitem>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
230
      </varlistentry>
24.1.23 by Björn Påhlsson
Added manual pages for:
231
232
      <varlistentry>
125 by Teddy Hogeborn
* plugin-runner.xml (OPTIONS): Use <option> tags instead of
233
	<term><option>--userid
234
	<replaceable>ID</replaceable></option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
235
	<listitem>
236
	  <para>
134 by Teddy Hogeborn
* mandos.xml: Enclose "RAM" with <acronym>.
237
	    Change to user ID <replaceable>ID</replaceable> on
238
	    startup.  The default is 65534.  All plugins will be
239
	    started using this user ID.  <emphasis>Note:</emphasis>
240
	    This must be a number, not a name.
24.1.23 by Björn Påhlsson
Added manual pages for:
241
	  </para>
242
	</listitem>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
243
      </varlistentry>
24.1.23 by Björn Påhlsson
Added manual pages for:
244
245
      <varlistentry>
125 by Teddy Hogeborn
* plugin-runner.xml (OPTIONS): Use <option> tags instead of
246
	<term><option>--plugin-dir
247
	<replaceable>DIRECTORY</replaceable></option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
248
	<listitem>
249
	  <para>
134 by Teddy Hogeborn
* mandos.xml: Enclose "RAM" with <acronym>.
250
	    Specify a different plugin directory.  The default is
251
	    <filename>/lib/mandos/plugins.d</filename>, which will
252
	    exist in the initial <acronym>RAM</acronym> disk
253
	    environment.
24.1.23 by Björn Påhlsson
Added manual pages for:
254
	  </para>
255
	</listitem>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
256
      </varlistentry>
24.1.23 by Björn Påhlsson
Added manual pages for:
257
      
258
      <varlistentry>
125 by Teddy Hogeborn
* plugin-runner.xml (OPTIONS): Use <option> tags instead of
259
	<term><option>--debug</option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
260
	<listitem>
261
	  <para>
134 by Teddy Hogeborn
* mandos.xml: Enclose "RAM" with <acronym>.
262
	    Enable debug mode.  This will enable a lot of output to
263
	    standard error about what the program is doing.  The
264
	    program will still perform all other functions normally.
265
	    The default is to <emphasis>not</emphasis> run in debug
266
	    mode.
267
	  </para>
268
	  <para>
269
	    The plugins will <emphasis>not</emphasis> be affected by
270
	    this option.  Use
271
	    <userinput><option>--global-options=--debug</option></userinput>
272
	    if complete debugging eruption is desired.
24.1.23 by Björn Påhlsson
Added manual pages for:
273
	  </para>
274
	</listitem>
275
      </varlistentry>
276
      
277
      <varlistentry>
125 by Teddy Hogeborn
* plugin-runner.xml (OPTIONS): Use <option> tags instead of
278
	<term><option>--help</option></term>
279
	<term><option>-?</option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
280
	<listitem>
281
	  <para>
134 by Teddy Hogeborn
* mandos.xml: Enclose "RAM" with <acronym>.
282
	    Gives a help message about options and their meanings.
24.1.23 by Björn Påhlsson
Added manual pages for:
283
	  </para>
284
	</listitem>
285
      </varlistentry>
286
      
287
      <varlistentry>
125 by Teddy Hogeborn
* plugin-runner.xml (OPTIONS): Use <option> tags instead of
288
	<term><option>--usage</option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
289
	<listitem>
290
	  <para>
134 by Teddy Hogeborn
* mandos.xml: Enclose "RAM" with <acronym>.
291
	    Gives a short usage message.
24.1.23 by Björn Påhlsson
Added manual pages for:
292
	  </para>
293
	</listitem>
294
      </varlistentry>
295
296
      <varlistentry>
125 by Teddy Hogeborn
* plugin-runner.xml (OPTIONS): Use <option> tags instead of
297
	<term><option>--version</option></term>
298
	<term><option>-V</option></term>
24.1.23 by Björn Påhlsson
Added manual pages for:
299
	<listitem>
300
	  <para>
134 by Teddy Hogeborn
* mandos.xml: Enclose "RAM" with <acronym>.
301
	    Prints the program version.
24.1.23 by Björn Påhlsson
Added manual pages for:
302
	  </para>
303
	</listitem>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
304
      </varlistentry>
24.1.23 by Björn Påhlsson
Added manual pages for:
305
    </variablelist>
306
  </refsect1>
24.1.39 by Björn Påhlsson
Added all sections needed for mandos-client manual page
307
134 by Teddy Hogeborn
* mandos.xml: Enclose "RAM" with <acronym>.
308
  <refsect1 id="overview">
309
    <title>OVERVIEW</title>
310
    <xi:include href="overview.xml"/>
311
    <para>
312
      This program will run on the client side in the initial
313
      <acronym>RAM</acronym> disk environment, and is responsible for
314
      getting a password.  It does this by running plugins, one of
315
      which will normally be the actual client program communicating
316
      with the server.
317
    </para>
318
  </refsect1>
319
  <refsect1 id="plugins">
320
    <title>PLUGINS</title>
321
    <para>
322
      This program will get a password by running a number of
323
      <firstterm>plugins</firstterm>, which are simply executable
324
      programs in a directory in the initial <acronym>RAM</acronym>
325
      disk environment.  The default directory is
326
      <filename>/lib/mandos/plugins.d</filename>, but this can be
327
      changed with the <option>--plugin-dir</option> option.  The
328
      plugins are started in parallel, and the first plugin to output
329
      a password and exit with a successful exit code will make this
330
      plugin-runner output that password, stop any other plugins, and
331
      exit.
332
    </para>
333
  </refsect1>
334
  
335
  <refsect1>
336
    <title>FALLBACK</title>
337
    <para>
338
    </para>
339
  </refsect1>
24.1.39 by Björn Påhlsson
Added all sections needed for mandos-client manual page
340
  <refsect1 id="exit_status">
341
    <title>EXIT STATUS</title>
342
    <para>
343
    </para>
344
  </refsect1>
345
346
  <refsect1 id="file">
347
    <title>FILES</title>
348
    <para>
24.1.55 by Björn Påhlsson
updated some partial manual pages
349
    </para>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
350
  </refsect1>
24.1.39 by Björn Påhlsson
Added all sections needed for mandos-client manual page
351
352
  <refsect1 id="notes">
353
    <title>NOTES</title>
354
    <para>
24.1.55 by Björn Påhlsson
updated some partial manual pages
355
    </para>
24.1.39 by Björn Påhlsson
Added all sections needed for mandos-client manual page
356
  </refsect1>
357
  
358
  <refsect1 id="bugs">
359
    <title>BUGS</title>
360
    <para>
24.1.55 by Björn Påhlsson
updated some partial manual pages
361
    </para>
118 by Teddy Hogeborn
* mandos-keygen.xml (SYNOPSIS): Fixed tags. Unify short and long
362
  </refsect1>
24.1.39 by Björn Påhlsson
Added all sections needed for mandos-client manual page
363
364
  <refsect1 id="examples">
113 by Teddy Hogeborn
* mandos-keygen.xml (EXAMPLE): Replaced all occurrences of command
365
    <title>EXAMPLE</title>
24.1.39 by Björn Påhlsson
Added all sections needed for mandos-client manual page
366
    <para>
24.1.55 by Björn Påhlsson
updated some partial manual pages
367
    </para>
24.1.39 by Björn Påhlsson
Added all sections needed for mandos-client manual page
368
  </refsect1>
369
370
  <refsect1 id="security">
371
    <title>SECURITY</title>
372
    <para>
24.1.55 by Björn Påhlsson
updated some partial manual pages
373
    </para>
24.1.39 by Björn Påhlsson
Added all sections needed for mandos-client manual page
374
  </refsect1>
375
376
  <refsect1 id="see_also">
377
    <title>SEE ALSO</title>
378
    <para>
114 by Teddy Hogeborn
* mandos-clients.conf.xml (SEE ALSO): Alphabetized, as per
379
      <citerefentry><refentrytitle>cryptsetup</refentrytitle>
380
      <manvolnum>8</manvolnum></citerefentry>,
24.1.41 by Björn Påhlsson
updated mandos-client sections and added see also stuff
381
      <citerefentry><refentrytitle>mandos</refentrytitle>
114 by Teddy Hogeborn
* mandos-clients.conf.xml (SEE ALSO): Alphabetized, as per
382
      <manvolnum>8</manvolnum></citerefentry>,
383
      <citerefentry><refentrytitle>password-prompt</refentrytitle>
113 by Teddy Hogeborn
* mandos-keygen.xml (EXAMPLE): Replaced all occurrences of command
384
      <manvolnum>8mandos</manvolnum></citerefentry>,
114 by Teddy Hogeborn
* mandos-clients.conf.xml (SEE ALSO): Alphabetized, as per
385
      <citerefentry><refentrytitle>password-request</refentrytitle>
386
      <manvolnum>8mandos</manvolnum></citerefentry>
24.1.41 by Björn Påhlsson
updated mandos-client sections and added see also stuff
387
    </para>
24.1.39 by Björn Påhlsson
Added all sections needed for mandos-client manual page
388
  </refsect1>
389
24.1.23 by Björn Påhlsson
Added manual pages for:
390
</refentry>
111 by Teddy Hogeborn
* mandos-clients.conf.xml (ENTITY TIMESTAMP): New. Automatically
391
<!-- Local Variables: -->
392
<!-- time-stamp-start: "<!ENTITY TIMESTAMP [\"']" -->
393
<!-- time-stamp-end: "[\"']>" -->
394
<!-- time-stamp-format: "%:y-%02m-%02d" -->
395
<!-- End: -->