2 <!DOCTYPE cfgdirdoc SYSTEM "cfgdirdoc.dtd" [
3 <!ENTITY init-scriptlet-params
5 <param id='vserver-dir'>
6 <description>The configuration directory of the current vserver</description>
8 <param id='vserver-name'>
9 <description>The name of the current vserver</description>
12 <description>The fixed value of the current action (e.g. 'prepre-start', 'post-stop', ...).</description>
15 <!ENTITY init-script-text "The scriptlet">
16 <!ENTITY init-dir-text "A directory with scriptlets">
17 <!ENTITY init-dir-script-text "A scriptlet">
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
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
29 <!ENTITY init-postpost-stop "which will be executed after the vserver has been stopped
35 <topleveldir path="@CONFDIR@">
36 <description>The base configuration directory.</description>
38 <dir name=".defaults" type="fixed" optional="yes">
39 <dir name="init" type="fixed">
41 <description>Default mtab-file</description>
45 <symlink name="vdirbase">
46 <description></description>
47 <default>/vservers</default>
50 <dir name="apps" type="fixed">
51 <dir name="pkgmgmt" type="fixed">
53 <description></description>
54 <default>/vservers/.pkg</default>
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>
63 <dir name="debootstrap" type="fixed">
65 <description>The Debian mirror which is used for 'debootstrap'.</description>
69 <description>When the 'debootstrap' package is not installed; fetch it from this uri and
70 install it at a temporary place.</description>
74 <dir name="vprocunhide" type="fixed">
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>
84 <dir name=".distributions" type="fixed" optional="yes">
85 <dir name="dist" type="symbolic">
87 <description></description>
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>
95 <script name="initpre">
96 <description>Script which will be executed before packages will be installed.</description>
99 <description>The configuration directory of the vserver which is going to be set
104 <description>The pathname of the vserver binary.</description>
109 <script name="initpost">
110 <description>Script which will be executed after packages are installed.</description>
113 <description>The configuration directory of the vserver which is going to be set
118 <description>The pathname of the vserver binary.</description>
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>
131 <dir name="pubkeys" type="fixed">
132 <description>Directory with GPG pubkeys which are used to sign the packages of this
133 distribution.</description>
136 <dir name="apt" type="fixed">
137 <description>Default content of the /etc/apt/ directory.</description>
140 <dir name="rpm" type="fixed">
141 <description>Default content of the /etc/rpm directory.</description>
144 <symlink name="rpmlib">
145 <description>Directory which overrides /usr/lib/rpm.</description>
148 <symlink name="execdir">
149 <description>Directory with all executables and libraries which are required for this
150 distribution.</description>
153 </dir> <!-- .distributions -->
155 <dir name="vserver-name" type="symbolic">
156 <description>The configuration directory for the vserver vserver-name.</description>
158 <file name="hostname">
159 <description>Contains the hostname of the vserver.</description>
163 <description>Contains the name of the vserver. When not given, the basename of the directory
164 will be assumed as this name.</description>
167 <file name="domainname">
168 <description>The domainname of the vserver.</description>
172 <description>The nice-level on which the vserver will be started.</description>
175 <file name="capabilities">
176 <description>Contains per line a capability.</description>
180 <description>Contains the pathname of the shell which will be used by the "vserver ... enter"
181 command.</description>
185 <description>Contains per line a flag.</description>
188 <file name="context">
189 <description>Contains the context which shall be used for the vserver.</description>
193 <description>The fstab file for the vserver.</description>
196 <dir name="apps" type="fixed">
197 <dir name="init" type="fixed">
199 <description>The initial-mtab which will be used for the vserver.</description>
203 <description>Contains the init-style; possible values are 'sysv', 'plain' and
204 'minit'.</description>
207 <file name="runlevel">
208 <description>The start runlevel.</description>
211 <file name="runlevel.start">
212 <description>The start runlevel.</description>
215 <file name="runlevel.stop">
216 <description>The stop runlevel.</description>
219 <file name="killseq">
220 <description>Contains the 'signal [wait signal]*' sequence which is used to stop the
221 vserver.</description>
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>
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>
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>
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>
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>
252 <description>Without this file, the 'cmd.*-sync' files will be ignored.</description>
257 <dir name="scripts" type="fixed">
258 <script name="prepre-start">
259 <description>&init-script-text; &init-prepre-start;</description>
260 &init-scriptlet-params;
262 <dir name="prepre-start.d" type="fixed">
263 <description>&init-dir-text; &init-prepre-start;</description>
265 <script name="script">
266 <description>&init-dir-script-text; &init-prepre-start;</description>
267 &init-scriptlet-params;
271 <script name="pre-start">
272 <description>&init-script-text; &init-pre-start;</description>
273 &init-scriptlet-params;
276 <dir name="pre-start.d">
277 <description>&init-dir-text; &init-pre-start;</description>
279 <script name="script">
280 <description>&init-dir-script-text; &init-pre-start;</description>
281 &init-scriptlet-params;
286 <script name="post-start">
287 <description>&init-script-text; &init-post-start;</description>
288 &init-scriptlet-params;
291 <dir name="post-start.d">
292 <description>&init-dir-text; &init-post-start;</description>
294 <script name="script">
295 <description>&init-dir-script-text; &init-post-start;</description>
296 &init-scriptlet-params;
300 <script name="pre-stop">
301 <description>&init-script-text; &init-pre-stop;</description>
302 &init-scriptlet-params;
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;
313 <script name="post-stop">
314 <description>&init-script-text; &init-post-stop;</description>
315 &init-scriptlet-params;
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;
326 <script name="postpost-stop">
327 <description>&init-script-text; &init-postpost-stop;</description>
328 &init-scriptlet-params;
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;
342 <dir name="interfaces" type="fixed">
344 <description>The deafult broadcast address.</description>
347 <description>The default network-device.</description>
350 <description>The default network-prefix.</description>
353 <description>The default network-mask.</description>
356 <description>The default scope of the network interfaces.</description>
359 <dir name="iface" type="symbolic">
360 <file name="disabled">
361 <description>When this file exists, this interface will be ignored.</description>
365 <description>The ip which will be assigned to this interface.</description>
368 <description>The broadcast address.</description>
371 <description>The network-device.</description>
374 <description>The network-prefix.</description>
377 <description>The network-mask.</description>
380 <description>The scope of the network interfaces.</description>
383 <description>When this file exists, the interface will be named with the text in this file.</description>
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>
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>
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>
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>
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>
412 <dir name="rlimits" type="fixed">
413 <description>see ulimits</description>
416 <dir name="uts" type="fixed">
417 <file name="context">
418 <description>The context-name of the vserver</description>
420 <file name="sysname">
421 <description>The sysname of the vserver</description>
423 <file name="nodename">
424 <description>The node-/hostname of the vserver</description>
426 <file name="release">
427 <description>The OS-release of the vserver</description>
429 <file name="version">
430 <description>The OS-version of the vserver</description>
432 <file name="machine">
433 <description>The machine-type of the vserver</description>
435 <file name="domainname">
436 <description>The NIS domainname of the vserver</description>