modernized declarations (use WRAPPER_DECL)
[util-vserver.git] / util-vserver / doc / configuration.xml
1 <?xml version="1.0"?>
2 <!DOCTYPE cfgdirdoc SYSTEM "cfgdirdoc.dtd" [
3 <!ENTITY init-scriptlet-params
4           "<params>
5             <param id='vserver-dir'>
6               <description>The configuration directory of the current vserver</description>
7             </param>
8             <param id='vserver-name'>
9               <description>The name of the current vserver</description>
10             </param>
11             <param id='action'>
12               <description>The fixed value of the current action (e.g. 'prepre-start', 'post-stop', ...).</description>
13             </param>
14           </params>">
15 <!ENTITY init-script-text     "The scriptlet">
16 <!ENTITY init-dir-text        "A directory with scriptlets">
17 <!ENTITY init-dir-script-text "A scriptlet">
18
19 <!ENTITY init-prepre-start "which will be executed before the network-interfaces are enabled
20                             and the directories are mounted.">
21 <!ENTITY init-pre-start  "which will be executed after network-interfaces were enabled and
22                           the directories mounted, but before the vserver itself has been
23                           started.">
24 <!ENTITY init-post-start "which will be executed after the vserver has been started.">
25 <!ENTITY init-pre-stop   "which will be executed before the vserver will be stopped.">
26 <!ENTITY init-post-stop  "which will be executed after the vserver has been stopped, but
27                           before the directories will be umounted and the the interfaces
28                           disabled.">
29 <!ENTITY init-postpost-stop "which will be executed after the vserver has been stopped
30                              completely.">
31 ]>
32
33
34 <cfgdirdoc>
35   <topleveldir path="@CONFDIR@">
36     <description>The base configuration directory.</description>
37
38     <dir name=".defaults" type="fixed" optional="yes">
39       <dir name="init" type="fixed">
40         <file name="mtab">
41           <description>Default mtab-file</description>
42         </file>
43       </dir>
44
45       <symlink name="vdirbase">
46         <description></description>
47         <default>/vservers</default>
48       </symlink>
49
50       <dir name="apps" type="fixed">
51         <dir name="pkgmgmt" type="fixed">
52           <symlink name="base">
53             <description></description>
54             <default>/vservers/.pkg</default>
55           </symlink>
56
57           <file name="apt.conf">
58             <description>The default apt.conf which is going to be used. It is overridden by
59             distribution specific configuration file.</description>
60           </file>
61         </dir>
62
63         <dir name="debootstrap" type="fixed">
64           <file name="mirror">
65             <description>The Debian mirror which is used for 'debootstrap'.</description>
66           </file>
67
68           <file name="uri">
69             <description>When the 'debootstrap' package is not installed; fetch it from this uri and
70             install it at a temporary place.</description>
71           </file>
72         </dir>
73       </dir>
74     </dir>
75
76     <dir name=".distributions" type="fixed" optional="yes">
77       <dir name="dist" type="symbolic">
78         <file name="dev">
79           <description></description>
80         </file>
81
82         <file name="apt.conf">
83           <description>The default apt.conf which is going to be used .It overrides the apt.conf
84           from @CONFDIR@/.defaults/apps/pkgmgmt.</description>
85         </file>
86
87         <script name="initpre">
88           <description>Script which will be executed before packages will be installed.</description>
89           <params>
90             <param id="confdir">
91               <description>The configuration directory of the vserver which is going to be set
92               up.</description>
93             </param>
94
95             <param id="vserver">
96               <description>The pathname of the vserver binary.</description>
97             </param>
98           </params>
99         </script>
100
101         <script name="initpost">
102           <description>Script which will be executed after packages are installed.</description>
103           <params>
104             <param id="confdir">
105               <description>The configuration directory of the vserver which is going to be set
106               up.</description>
107             </param>
108
109             <param id="vserver">
110               <description>The pathname of the vserver binary.</description>
111             </param>
112           </params>
113         </script>
114
115         <dir name="pkgs" type="fixed">
116           <description>Contains files with packages.</description>
117           <file name="list" type="symbolic">
118             <description>File which contains the name of packages. On top of file the special
119             keywords '--reinstall' and '--can-fail' are possible.</description>
120           </file>
121         </dir>
122
123         <dir name="pubkeys" type="fixed">
124           <description>Directory with GPG pubkeys which are used to sign the packages of this
125           distribution.</description>
126         </dir>
127
128         <dir name="apt" type="fixed">
129           <description>Default content of the /etc/apt/ directory.</description>
130         </dir>
131
132         <dir name="rpm" type="fixed">
133           <description>Default content of the /etc/rpm directory.</description>
134         </dir>
135
136         <symlink name="rpmlib">
137           <description>Directory which overrides /usr/lib/rpm.</description>
138         </symlink>
139         
140         <symlink name="execdir">
141           <description>Directory with all executables and libraries which are required for this
142           distribution.</description>
143         </symlink>
144       </dir>
145     </dir> <!-- .distributions -->
146
147     <dir name="vserver-name" type="symbolic">
148       <description>The configuration directory for the vserver vserver-name.</description>
149
150       <file name="hostname">
151         <description>Contains the hostname of the vserver.</description>
152       </file>
153
154       <file name="name">
155         <description>Contains the name of the vserver. When not given, the basename of the directory
156         will be assumed as this name.</description>
157       </file>
158
159       <file name="domainname">
160         <description>The domainname of the vserver.</description>
161       </file>
162
163       <file name="nice">
164         <description>The nice-level on which the vserver will be started.</description>
165       </file>
166
167       <file name="capabilities">
168         <description>Contains per line a capability.</description>
169       </file>
170
171       <file name="shell">
172         <description>Contains the pathname of the shell which will be used by the "vserver ... enter"
173         command.</description>
174       </file>
175
176       <file name="flags">
177         <description>Contains per line a flag.</description>
178       </file>
179
180       <file name="context">
181         <description>Contains the context which shall be used for the vserver.</description>
182       </file>
183
184       <file name="fstab">
185         <description>The fstab file for the vserver.</description>
186       </file>
187       
188       <dir name="apps" type="fixed">
189         <dir name="init" type="fixed">
190           <file name="mtab">
191             <description>The initial-mtab which will be used for the vserver.</description>
192           </file>
193
194           <file name="style">
195             <description>Contains the init-style; possible values are 'sysv', 'plain' and
196             'minit'.</description>
197           </file>
198
199           <file name="runlevel">
200             <description>The start runlevel.</description>
201           </file>
202
203           <file name="runlevel.start">
204             <description>The start runlevel.</description>
205           </file>
206
207           <file name="runlevel.stop">
208             <description>The stop runlevel.</description>
209           </file>
210
211           <file name="killseq">
212             <description>Contains the 'signal [wait signal]*' sequence which is used to stop the
213             vserver.</description>
214           </file>
215
216           <file name="cmd.start">
217             <description>The command which is used to start the vserver. Each option must be on a
218             separate line.</description>
219           </file>
220
221           <file name="cmd.start-sync">
222             <description>The command which is used to wait on the vserver after it has been
223             started. Each option must be on a separate line. This file will be ignored when the
224             'sync' does not exist and the '--sync' option was not used.</description>
225           </file>
226           
227           <file name="cmd.stop">
228             <description>The command which is used to stop the vserver. Each option must be on a
229             separate line.</description>
230           </file>
231
232           <file name="cmd.stop-sync">
233             <description>The command which is used to wait on the vserver after it has been
234             stopped. Each option must be on a separate line. This file will be ignored when the
235             'sync' does not exist and the '--sync' option was not used.</description>
236           </file>
237
238           <file name="cmd.prepare">
239             <description>The command which is used to setup the init-system (e.g. to set the runlevel
240             in the utmp-file). Each option must be on a separate line.</description>
241           </file>
242
243           <file name="sync">
244             <description>Without this file, the 'cmd.*-sync' files will be ignored.</description>
245           </file>
246         </dir>
247       </dir>
248
249       <dir name="scripts" type="fixed">
250         <script name="prepre-start">
251           <description>&init-script-text; &init-prepre-start;</description>
252           &init-scriptlet-params;
253         </script>
254         <dir name="prepre-start.d" type="fixed">
255           <description>&init-dir-text; &init-prepre-start;</description>
256
257           <script name="script">
258             <description>&init-dir-script-text; &init-prepre-start;</description>
259             &init-scriptlet-params;
260           </script>
261         </dir>
262
263         <script name="pre-start">
264           <description>&init-script-text; &init-pre-start;</description>
265           &init-scriptlet-params;
266         </script>
267
268         <dir name="pre-start.d">
269           <description>&init-dir-text; &init-pre-start;</description>
270           
271           <script name="script">
272             <description>&init-dir-script-text; &init-pre-start;</description>
273             &init-scriptlet-params;
274           </script>
275           
276         </dir>
277
278         <script name="post-start">
279           <description>&init-script-text; &init-post-start;</description>
280           &init-scriptlet-params;
281         </script>
282
283         <dir name="post-start.d">
284           <description>&init-dir-text; &init-post-start;</description>
285           
286           <script name="script">
287             <description>&init-dir-script-text; &init-post-start;</description>
288             &init-scriptlet-params;
289           </script>
290         </dir>
291
292         <script name="pre-stop">
293           <description>&init-script-text; &init-pre-stop;</description>
294           &init-scriptlet-params;
295         </script>
296
297         <dir name="pre-stop.d" type="fixed">
298           <description>&init-dir-text; &init-pre-stop;</description>
299           <script name="script">
300             <description>&init-dir-script-text; &init-pre-stop;</description>
301             &init-scriptlet-params;
302           </script>
303         </dir>
304
305         <script name="post-stop">
306           <description>&init-script-text; &init-post-stop;</description>
307           &init-scriptlet-params;
308         </script>
309
310         <dir name="post-stop.d" type="fixed">
311           <description>&init-dir-text; &init-post-stop;</description>
312           <script name="script">
313             <description>&init-dir-script-text; &init-post-stop;</description>
314             &init-scriptlet-params;
315           </script>
316         </dir>
317
318         <script name="postpost-stop">
319           <description>&init-script-text; &init-postpost-stop;</description>
320           &init-scriptlet-params;
321         </script>
322
323         <dir name="postpost-stop.d" type="fixed">
324           <description>&init-dir-text; &init-postpost-stop;</description>
325           <script name="script">
326             <description>&init-dir-script-text; &init-postpost-stop;</description>
327             &init-scriptlet-params;
328           </script>
329         </dir>
330       </dir>
331
332
333       
334       <dir name="interfaces" type="fixed">
335         <file name="bcast">
336           <description>The deafult broadcast address.</description>
337         </file>
338         <file name="dev">
339           <description>The default network-device.</description>
340         </file>
341         <file name="prefix">
342           <description>The default network-prefix.</description>
343         </file>
344         <file name="mask">
345           <description>The default network-mask.</description>
346         </file>
347         <file name="scope">
348           <description>The default scope of the network interfaces.</description>
349         </file>
350
351         <dir name="iface" type="symbolic">
352           <file name="disabled">
353             <description>When this file exists, this interface will be ignored.</description>
354           </file>
355           
356           <file name="ip">
357             <description>The ip which will be assigned to this interface.</description>
358           </file>
359           <file name="bcast">
360             <description>The broadcast address.</description>
361           </file>
362           <file name="dev">
363             <description>The network-device.</description>
364           </file>
365           <file name="prefix">
366             <description>The network-prefix.</description>
367           </file>
368           <file name="mask">
369             <description>The network-mask.</description>
370           </file>
371           <file name="scope">
372             <description>The scope of the network interfaces.</description>
373           </file>
374           <file name="name">
375             <description>When this file exists, the interface will be named.</description>
376           </file>
377         </dir>
378       </dir>
379
380       <dir name="ulimits" type="fixed">
381         <description>A directory with ulimits. Possible resources are cpu, data, fsize, locks,
382         memlock, nofile, nproc, rss and/or stack.</description>
383
384         <file name="resource" type="symbolic">
385           <description>A file which contains the hard- and soft-limit of the given resource in the
386           first line. The special keyword 'inf' is recognized.</description>
387         </file>
388
389         <file name="resource.hard" type="symbolic">
390           <description>A file which contains the hard- of the given resource in the first line. The
391           special keyword 'inf' is recognized.</description>
392         </file>
393
394         <file name="resource.soft" type="symbolic">
395           <description>A file which contains the soft- of the given resource in the first line. The
396           special keyword 'inf' is recognized.</description>
397         </file>
398       </dir>
399     </dir>
400   </topleveldir>
401 </cfgdirdoc>
402
403
404 <!--
405 !! Local Variables:
406 !! fill-column: 100
407 !! End:
408 -->