/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release
24.1.23 by Björn Påhlsson
Added manual pages for:
1
<?xml version='1.0' encoding='UTF-8'?>
2
<?xml-stylesheet type="text/xsl"
3
	href="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"?>
4
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
5
	"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
6
<!ENTITY VERSION "1.0">
74 by Teddy Hogeborn
* Makefile (PREFIX, CONFDIR): New.
7
<!ENTITY COMMANDNAME "plugin-runner">
24.1.23 by Björn Påhlsson
Added manual pages for:
8
]>
9
10
<refentry>
11
  <refentryinfo>
12
    <title>&COMMANDNAME;</title>
13
    <!-- NWalsh's docbook scripts use this to generate the footer: -->
14
    <productname>&COMMANDNAME;</productname>
15
    <productnumber>&VERSION;</productnumber>
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>
34
      <holder>Teddy Hogeborn &amp; Björn Påhlsson</holder>
35
    </copyright>
36
    <legalnotice>
37
      <para>
38
	This manual page is free software: you can redistribute it
39
	and/or modify it under the terms of the GNU General Public
40
	License as published by the Free Software Foundation,
41
	either version 3 of the License, or (at your option) any
42
	later version.
43
      </para>
44
45
      <para>
46
	This manual page is distributed in the hope that it will
47
	be useful, but WITHOUT ANY WARRANTY; without even the
48
	implied warranty of MERCHANTABILITY or FITNESS FOR A
49
	PARTICULAR PURPOSE.  See the GNU General Public License
50
	for more details.
51
      </para>
52
53
      <para>
54
	You should have received a copy of the GNU General Public
55
	License along with this program; If not, see
56
	<ulink url="http://www.gnu.org/licenses/"/>.
57
      </para>
58
    </legalnotice>
59
  </refentryinfo>
60
61
  <refmeta>
62
    <refentrytitle>&COMMANDNAME;</refentrytitle>
63
    <manvolnum>8mandos</manvolnum>
64
  </refmeta>
65
  
66
  <refnamediv>
67
    <refname><command>&COMMANDNAME;</command></refname>
68
    <refpurpose>
69
      get password for encrypted rootdisk
70
    </refpurpose>
71
  </refnamediv>
72
73
  <refsynopsisdiv>
74
    <cmdsynopsis>
75
      <command>&COMMANDNAME;</command>
24.1.33 by Björn Påhlsson
synopsis changed
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>
24.1.35 by Björn Påhlsson
version 1.0
80
      <arg choice='opt'>--userid<arg choice='plain'>ID</arg></arg>
24.1.33 by Björn Påhlsson
synopsis changed
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>    
24.1.23 by Björn Påhlsson
Added manual pages for:
96
  </refsynopsisdiv>
97
98
  <refsect1 id="description">
99
    <title>DESCRIPTION</title>
100
    <para>
101
      <command>&COMMANDNAME;</command> is a plugin runner that waits
102
      for any of its plugins to return sucessfull with a password, and
24.1.38 by Björn Påhlsson
changed description to better fit role
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.    
24.1.23 by Björn Påhlsson
Added manual pages for:
110
    </para>
111
24.1.38 by Björn Påhlsson
changed description to better fit role
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>
24.1.23 by Björn Påhlsson
Added manual pages for:
119
    <variablelist>
120
      <varlistentry>
121
	<term><literal>-g</literal>,<literal>--global-options
122
	<replaceable>OPTIONS</replaceable></literal></term>
123
	<listitem>
124
	  <para>
125
	    Global options given to all plugins as additional start
126
	    arguments.  Options are specified with a -o flag followed
127
	    by a comma separated string of options.
128
	  </para>	  
129
	</listitem>
130
      </varlistentry>
131
132
      <varlistentry>
133
	<term><literal>-o</literal>,<literal> --options-for
134
	<replaceable>PLUGIN</replaceable>:<replaceable>OPTION</replaceable>
135
	</literal></term>
136
	<listitem>
137
	  <para>
138
	    Plugin specific options given to the plugin as additional
139
	    start arguments.  Options are specified with a -o flag
140
	    followed by a comma separated string of options.
141
	  </para>	  
142
	</listitem>
143
      </varlistentry>      
144
145
      <varlistentry>
146
	<term><literal>-d</literal>,<literal> --disable
147
	<replaceable>PLUGIN</replaceable>
148
	</literal></term>
149
	<listitem>
150
	  <para>
151
	    Disable a specific plugin
152
	  </para>	  
153
	</listitem>
154
      </varlistentry>
155
156
      <varlistentry>
157
	<term><literal>--groupid <replaceable>ID</replaceable>
158
	</literal></term>
159
	<listitem>
160
	  <para>
161
	    Group ID the plugins will run as
162
	  </para>
163
	</listitem>
164
      </varlistentry>      
165
166
      <varlistentry>
167
	<term><literal>--userid <replaceable>ID</replaceable>
168
	</literal></term>
169
	<listitem>
170
	  <para>
171
	    User ID the plugins will run as
172
	  </para>
173
	</listitem>
174
      </varlistentry>      
175
176
      <varlistentry>
177
	<term><literal>--plugin-dir <replaceable>DIRECTORY</replaceable>
178
	</literal></term>
179
	<listitem>
180
	  <para>
181
	    Specify a different plugin directory
182
	  </para>
183
	</listitem>
184
      </varlistentry>       
185
      
186
      <varlistentry>
187
	<term><literal>--debug</literal></term>
188
	<listitem>
189
	  <para>
190
	    Debug mode
191
	  </para>
192
	</listitem>
193
      </varlistentry>
194
      
195
      <varlistentry>
196
	<term><literal>-?</literal>, <literal>--help</literal></term>
197
	<listitem>
198
	  <para>
199
	    Gives a help message
200
	  </para>
201
	</listitem>
202
      </varlistentry>
203
      
204
      <varlistentry>
205
	<term><literal>--usage</literal></term>
206
	<listitem>
207
	  <para>
208
	    Gives a short usage message
209
	  </para>
210
	</listitem>
211
      </varlistentry>
212
213
      <varlistentry>
214
	<term><literal>-V</literal>, <literal>--version</literal></term>
215
	<listitem>
216
	  <para>
217
	    Prints the program version
218
	  </para>
219
	</listitem>
220
      </varlistentry>            
221
    </variablelist>
222
  </refsect1>
24.1.39 by Björn Påhlsson
Added all sections needed for mandos-client manual page
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>
24.1.41 by Björn Påhlsson
updated mandos-client sections and added see also stuff
263
      <citerefentry><refentrytitle>mandos</refentrytitle>
264
      <manvolnum>8</manvolnum></citerefentry>, <citerefentry>
265
      <refentrytitle>password-request</refentrytitle>
266
      <manvolnum>8mandos</manvolnum></citerefentry> and <citerefentry>
267
      <refentrytitle>password-prompt</refentrytitle>
268
      <manvolnum>8mandos</manvolnum></citerefentry>
269
    </para>
24.1.39 by Björn Påhlsson
Added all sections needed for mandos-client manual page
270
  </refsect1>
271
24.1.23 by Björn Påhlsson
Added manual pages for:
272
</refentry>