documented '.../interfaces/.../nodev'
[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
74         <dir name="vprocunhide" type="fixed">
75           <file name="files">
76             <description>A list of files which will be made visibly by vprocunhide. Wildcards are
77             allowed and anything ending in '/' will be processed recursively. When this file exists,
78             it overrides the defaults in SYSDEFAULTDIR/vprocunhide-files.</description>
79           </file>
80         </dir>
81       </dir>
82     </dir>
83
84     <dir name=".distributions" type="fixed" optional="yes">
85       <dir name="dist" type="symbolic">
86         <file name="dev">
87           <description></description>
88         </file>
89
90         <file name="apt.conf">
91           <description>The default apt.conf which is going to be used .It overrides the apt.conf
92           from @CONFDIR@/.defaults/apps/pkgmgmt.</description>
93         </file>
94
95         <script name="initpre">
96           <description>Script which will be executed before packages will be installed.</description>
97           <params>
98             <param id="confdir">
99               <description>The configuration directory of the vserver which is going to be set
100               up.</description>
101             </param>
102
103             <param id="vserver">
104               <description>The pathname of the vserver binary.</description>
105             </param>
106           </params>
107         </script>
108
109         <script name="initpost">
110           <description>Script which will be executed after packages are installed.</description>
111           <params>
112             <param id="confdir">
113               <description>The configuration directory of the vserver which is going to be set
114               up.</description>
115             </param>
116
117             <param id="vserver">
118               <description>The pathname of the vserver binary.</description>
119             </param>
120           </params>
121         </script>
122
123         <dir name="pkgs" type="fixed">
124           <description>Contains files with packages.</description>
125           <file name="list" type="symbolic">
126             <description>File which contains the name of packages. On top of file the special
127             keywords '--reinstall' and '--can-fail' are possible.</description>
128           </file>
129         </dir>
130
131         <dir name="pubkeys" type="fixed">
132           <description>Directory with GPG pubkeys which are used to sign the packages of this
133           distribution.</description>
134         </dir>
135
136         <dir name="apt" type="fixed">
137           <description>Default content of the /etc/apt/ directory.</description>
138         </dir>
139
140         <dir name="rpm" type="fixed">
141           <description>Default content of the /etc/rpm directory.</description>
142         </dir>
143
144         <symlink name="rpmlib">
145           <description>Directory which overrides /usr/lib/rpm.</description>
146         </symlink>
147         
148         <symlink name="execdir">
149           <description>Directory with all executables and libraries which are required for this
150           distribution.</description>
151         </symlink>
152       </dir>
153     </dir> <!-- .distributions -->
154
155     <dir name="vserver-name" type="symbolic">
156       <description>The configuration directory for the vserver vserver-name.</description>
157
158       <file name="hostname">
159         <description>Contains the hostname of the vserver.</description>
160       </file>
161
162       <file name="name">
163         <description>Contains the name of the vserver. When not given, the basename of the directory
164         will be assumed as this name.</description>
165       </file>
166
167       <file name="domainname">
168         <description>The domainname of the vserver.</description>
169       </file>
170
171       <file name="nice">
172         <description>The nice-level on which the vserver will be started.</description>
173       </file>
174
175       <file name="capabilities">
176         <description>Contains per line a capability.</description>
177       </file>
178
179       <file name="shell">
180         <description>Contains the pathname of the shell which will be used by the "vserver ... enter"
181         command.</description>
182       </file>
183
184       <file name="flags">
185         <description>Contains per line a flag.</description>
186       </file>
187
188       <file name="context">
189         <description>Contains the context which shall be used for the vserver.</description>
190       </file>
191
192       <file name="fstab">
193         <description>The fstab file for the vserver.</description>
194       </file>
195       
196       <dir name="apps" type="fixed">
197         <dir name="init" type="fixed">
198           <file name="mtab">
199             <description>The initial-mtab which will be used for the vserver.</description>
200           </file>
201
202           <file name="style">
203             <description>Contains the init-style; possible values are 'sysv', 'plain' and
204             'minit'.</description>
205           </file>
206
207           <file name="runlevel">
208             <description>The start runlevel.</description>
209           </file>
210
211           <file name="runlevel.start">
212             <description>The start runlevel.</description>
213           </file>
214
215           <file name="runlevel.stop">
216             <description>The stop runlevel.</description>
217           </file>
218
219           <file name="killseq">
220             <description>Contains the 'signal [wait signal]*' sequence which is used to stop the
221             vserver.</description>
222           </file>
223
224           <file name="cmd.start">
225             <description>The command which is used to start the vserver. Each option must be on a
226             separate line.</description>
227           </file>
228
229           <file name="cmd.start-sync">
230             <description>The command which is used to wait on the vserver after it has been
231             started. Each option must be on a separate line. This file will be ignored when the
232             'sync' does not exist and the '--sync' option was not used.</description>
233           </file>
234           
235           <file name="cmd.stop">
236             <description>The command which is used to stop the vserver. Each option must be on a
237             separate line.</description>
238           </file>
239
240           <file name="cmd.stop-sync">
241             <description>The command which is used to wait on the vserver after it has been
242             stopped. Each option must be on a separate line. This file will be ignored when the
243             'sync' does not exist and the '--sync' option was not used.</description>
244           </file>
245
246           <file name="cmd.prepare">
247             <description>The command which is used to setup the init-system (e.g. to set the runlevel
248             in the utmp-file). Each option must be on a separate line.</description>
249           </file>
250
251           <file name="sync">
252             <description>Without this file, the 'cmd.*-sync' files will be ignored.</description>
253           </file>
254         </dir>
255       </dir>
256
257       <dir name="scripts" type="fixed">
258         <script name="prepre-start">
259           <description>&init-script-text; &init-prepre-start;</description>
260           &init-scriptlet-params;
261         </script>
262         <dir name="prepre-start.d" type="fixed">
263           <description>&init-dir-text; &init-prepre-start;</description>
264
265           <script name="script">
266             <description>&init-dir-script-text; &init-prepre-start;</description>
267             &init-scriptlet-params;
268           </script>
269         </dir>
270
271         <script name="pre-start">
272           <description>&init-script-text; &init-pre-start;</description>
273           &init-scriptlet-params;
274         </script>
275
276         <dir name="pre-start.d">
277           <description>&init-dir-text; &init-pre-start;</description>
278           
279           <script name="script">
280             <description>&init-dir-script-text; &init-pre-start;</description>
281             &init-scriptlet-params;
282           </script>
283           
284         </dir>
285
286         <script name="post-start">
287           <description>&init-script-text; &init-post-start;</description>
288           &init-scriptlet-params;
289         </script>
290
291         <dir name="post-start.d">
292           <description>&init-dir-text; &init-post-start;</description>
293           
294           <script name="script">
295             <description>&init-dir-script-text; &init-post-start;</description>
296             &init-scriptlet-params;
297           </script>
298         </dir>
299
300         <script name="pre-stop">
301           <description>&init-script-text; &init-pre-stop;</description>
302           &init-scriptlet-params;
303         </script>
304
305         <dir name="pre-stop.d" type="fixed">
306           <description>&init-dir-text; &init-pre-stop;</description>
307           <script name="script">
308             <description>&init-dir-script-text; &init-pre-stop;</description>
309             &init-scriptlet-params;
310           </script>
311         </dir>
312
313         <script name="post-stop">
314           <description>&init-script-text; &init-post-stop;</description>
315           &init-scriptlet-params;
316         </script>
317
318         <dir name="post-stop.d" type="fixed">
319           <description>&init-dir-text; &init-post-stop;</description>
320           <script name="script">
321             <description>&init-dir-script-text; &init-post-stop;</description>
322             &init-scriptlet-params;
323           </script>
324         </dir>
325
326         <script name="postpost-stop">
327           <description>&init-script-text; &init-postpost-stop;</description>
328           &init-scriptlet-params;
329         </script>
330
331         <dir name="postpost-stop.d" type="fixed">
332           <description>&init-dir-text; &init-postpost-stop;</description>
333           <script name="script">
334             <description>&init-dir-script-text; &init-postpost-stop;</description>
335             &init-scriptlet-params;
336           </script>
337         </dir>
338       </dir>
339
340
341       
342       <dir name="interfaces" type="fixed">
343         <file name="bcast">
344           <description>The deafult broadcast address.</description>
345         </file>
346         <file name="dev">
347           <description>The default network-device.</description>
348         </file>
349         <file name="prefix">
350           <description>The default network-prefix.</description>
351         </file>
352         <file name="mask">
353           <description>The default network-mask.</description>
354         </file>
355         <file name="scope">
356           <description>The default scope of the network interfaces.</description>
357         </file>
358
359         <dir name="iface" type="symbolic">
360           <file name="disabled">
361             <description>When this file exists, this interface will be ignored.</description>
362           </file>
363           
364           <file name="ip">
365             <description>The ip which will be assigned to this interface.</description>
366           </file>
367           <file name="bcast">
368             <description>The broadcast address.</description>
369           </file>
370           <file name="dev">
371             <description>The network-device.</description>
372           </file>
373           <file name="prefix">
374             <description>The network-prefix.</description>
375           </file>
376           <file name="mask">
377             <description>The network-mask.</description>
378           </file>
379           <file name="scope">
380             <description>The scope of the network interfaces.</description>
381           </file>
382           <file name="name">
383             <description>When this file exists, the interface will be named with the text in this file.</description>
384           </file>
385           <file name="nodev">
386             <description>When this file exists, the interface will be assumed to exist already. A
387             former name for this flag was 'only_ip' which is deprecated now.</description>
388           </file>
389         </dir>
390       </dir>
391
392       <dir name="ulimits" type="fixed">
393         <description>A directory with ulimits. Possible resources are cpu, data, fsize, locks,
394         memlock, nofile, nproc, rss and/or stack.</description>
395
396         <file name="resource" type="symbolic">
397           <description>A file which contains the hard- and soft-limit of the given resource in the
398           first line. The special keyword 'inf' is recognized.</description>
399         </file>
400
401         <file name="resource.hard" type="symbolic">
402           <description>A file which contains the hard- of the given resource in the first line. The
403           special keyword 'inf' is recognized.</description>
404         </file>
405
406         <file name="resource.soft" type="symbolic">
407           <description>A file which contains the soft- of the given resource in the first line. The
408           special keyword 'inf' is recognized.</description>
409         </file>
410       </dir>
411
412       <dir name="rlimits" type="fixed">
413         <description>see ulimits</description>
414       </dir>
415
416       <dir name="uts" type="fixed">
417         <file name="context">
418           <description>The context-name of the vserver</description>
419         </file>
420         <file name="sysname">
421           <description>The sysname of the vserver</description>
422         </file>
423         <file name="nodename">
424           <description>The node-/hostname of the vserver</description>
425         </file>
426         <file name="release">
427           <description>The OS-release of the vserver</description>
428         </file>
429         <file name="version">
430           <description>The OS-version of the vserver</description>
431         </file>
432         <file name="machine">
433           <description>The machine-type of the vserver</description>
434         </file>
435         <file name="domainname">
436           <description>The NIS domainname of the vserver</description>
437         </file>
438       </dir>
439     </dir>
440   </topleveldir>
441 </cfgdirdoc>
442
443
444 <!--
445 !! Local Variables:
446 !! fill-column: 100
447 !! End:
448 -->