2 <!DOCTYPE cfgdirdoc SYSTEM "configuration.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
34 <topleveldir type="confdir">
35 <description>The base configuration directory.</description>
37 <dir name=".defaults" type="fixed" optional="yes">
38 <dir name="init" type="fixed">
40 <description>Default mtab-file</description>
44 <symlink name="vdirbase">
45 <description></description>
46 <default>/vservers</default>
49 <dir name="apps" type="fixed">
50 <dir name="pkgmgmt" type="fixed">
52 <description></description>
53 <default>/vservers/.pkg</default>
56 <file name="apt.conf">
57 <description>The default apt.conf which is going to be used. It is overridden by
58 distribution specific configuration file.</description>
62 <dir name="debootstrap" type="fixed">
64 <description>The Debian mirror which is used for 'debootstrap'.</description>
68 <description>When the 'debootstrap' package is not installed; fetch it from this uri and
69 install it at a temporary place.</description>
73 <dir name="vprocunhide" type="fixed">
75 <description>A list of files which will be made visibly by vprocunhide. Wildcards are
76 allowed and anything ending in '/' will be processed recursively. When this file exists,
77 it overrides the defaults in SYSDEFAULTDIR/vprocunhide-files.</description>
81 <dir name="init" type="fixed">
83 <description>A symlink to the TTY device where input/output will be redirected from/to
84 at startup via initscript.</description>
90 <dir name=".distributions" type="fixed" optional="yes">
91 <dir name="dist" type="symbolic">
93 <description></description>
96 <file name="apt.conf">
97 <description>The default apt.conf which is going to be used. It overrides the apt.conf
98 from CONFDIR/.defaults/apps/pkgmgmt.</description>
101 <script name="initpre">
102 <description>Script which will be executed before packages will be installed.</description>
105 <description>The configuration directory of the vserver which is going to be set
110 <description>The pathname of the vserver binary.</description>
115 <script name="initpost">
116 <description>Script which will be executed after packages are installed.</description>
119 <description>The configuration directory of the vserver which is going to be set
124 <description>The pathname of the vserver binary.</description>
129 <dir name="pkgs" type="fixed">
130 <description>Contains files with packages.</description>
131 <file name="list" type="symbolic">
132 <description>File which contains the name of packages. On top of file the special
133 keywords '--reinstall' and '--can-fail' are possible.</description>
137 <dir name="pubkeys" type="fixed">
138 <description>Directory with GPG pubkeys which are used to sign the packages of this
139 distribution.</description>
142 <dir name="apt" type="fixed">
143 <description>Default content of the /etc/apt/ directory.</description>
146 <dir name="rpm" type="fixed">
147 <description>Default content of the /etc/rpm directory.</description>
150 <symlink name="rpmlib">
151 <description>Directory which overrides /usr/lib/rpm.</description>
154 <symlink name="execdir">
155 <description>Directory with all executables and libraries which are required for this
156 distribution.</description>
159 </dir> <!-- .distributions -->
161 <dir name="vserver-name" type="symbolic">
162 <description>The configuration directory for the vserver vserver-name.</description>
164 <file name="hostname">
165 <description>Contains the hostname of the vserver.</description>
169 <description>Contains the name of the vserver. When not given, the basename of the directory
170 will be assumed as this name.</description>
173 <file name="domainname">
174 <description>The domainname of the vserver.</description>
178 <description>The nice-level on which the vserver will be started.</description>
181 <file name="capabilities">
182 <description>Contains per line a capability.</description>
186 <description>Contains the pathname of the shell which will be used by the "vserver ... enter"
187 command.</description>
191 <description>Contains per line a flag.</description>
194 <file name="context">
195 <description>Contains the context which shall be used for the vserver.</description>
199 <description>The fstab file for the vserver.</description>
202 <dir name="apps" type="fixed">
203 <dir name="init" type="fixed">
205 <description>The initial-mtab which will be used for the vserver.</description>
209 <description>Contains the init-style; possible values are 'sysv', 'plain' and
210 'minit'.</description>
213 <file name="runlevel">
214 <description>The start runlevel.</description>
217 <file name="runlevel.start">
218 <description>The start runlevel.</description>
221 <file name="runlevel.stop">
222 <description>The stop runlevel.</description>
225 <file name="killseq">
226 <description>Contains the 'signal [wait signal]*' sequence which is used to stop the
227 vserver.</description>
230 <file name="cmd.start">
231 <description>The command which is used to start the vserver. Each option must be on a
232 separate line.</description>
235 <file name="cmd.start-sync">
236 <description>The command which is used to wait on the vserver after it has been
237 started. Each option must be on a separate line. This file will be ignored when the
238 'sync' does not exist and the '--sync' option was not used.</description>
241 <file name="cmd.stop">
242 <description>The command which is used to stop the vserver. Each option must be on a
243 separate line.</description>
246 <file name="cmd.stop-sync">
247 <description>The command which is used to wait on the vserver after it has been
248 stopped. Each option must be on a separate line. This file will be ignored when the
249 'sync' does not exist and the '--sync' option was not used.</description>
252 <file name="cmd.prepare">
253 <description>The command which is used to setup the init-system (e.g. to set the runlevel
254 in the utmp-file). Each option must be on a separate line.</description>
258 <description>Without this file, the 'cmd.*-sync' files will be ignored.</description>
262 <description>A symlink to the TTY device where input/output will be redirected from/to
263 at startup via initscript.</description>
268 <dir name="scripts" type="fixed">
269 <script name="prepre-start">
270 <description>&init-script-text; &init-prepre-start;</description>
271 &init-scriptlet-params;
273 <dir name="prepre-start.d" type="fixed">
274 <description>&init-dir-text; &init-prepre-start;</description>
276 <script name="script">
277 <description>&init-dir-script-text; &init-prepre-start;</description>
278 &init-scriptlet-params;
282 <script name="pre-start">
283 <description>&init-script-text; &init-pre-start;</description>
284 &init-scriptlet-params;
287 <dir name="pre-start.d">
288 <description>&init-dir-text; &init-pre-start;</description>
290 <script name="script">
291 <description>&init-dir-script-text; &init-pre-start;</description>
292 &init-scriptlet-params;
296 <script name="post-start">
297 <description>&init-script-text; &init-post-start;</description>
298 &init-scriptlet-params;
301 <dir name="post-start.d">
302 <description>&init-dir-text; &init-post-start;</description>
304 <script name="script">
305 <description>&init-dir-script-text; &init-post-start;</description>
306 &init-scriptlet-params;
310 <script name="pre-stop">
311 <description>&init-script-text; &init-pre-stop;</description>
312 &init-scriptlet-params;
315 <dir name="pre-stop.d" type="fixed">
316 <description>&init-dir-text; &init-pre-stop;</description>
317 <script name="script">
318 <description>&init-dir-script-text; &init-pre-stop;</description>
319 &init-scriptlet-params;
323 <script name="post-stop">
324 <description>&init-script-text; &init-post-stop;</description>
325 &init-scriptlet-params;
328 <dir name="post-stop.d" type="fixed">
329 <description>&init-dir-text; &init-post-stop;</description>
330 <script name="script">
331 <description>&init-dir-script-text; &init-post-stop;</description>
332 &init-scriptlet-params;
336 <script name="postpost-stop">
337 <description>&init-script-text; &init-postpost-stop;</description>
338 &init-scriptlet-params;
341 <dir name="postpost-stop.d" type="fixed">
342 <description>&init-dir-text; &init-postpost-stop;</description>
343 <script name="script">
344 <description>&init-dir-script-text; &init-postpost-stop;</description>
345 &init-scriptlet-params;
352 <dir name="interfaces" type="fixed">
354 <description>The deafult broadcast address.</description>
357 <description>The default network-device.</description>
360 <description>The default network-prefix.</description>
363 <description>The default network-mask.</description>
366 <description>The default scope of the network interfaces.</description>
369 <dir name="iface" type="symbolic">
370 <file name="disabled">
371 <description>When this file exists, this interface will be ignored.</description>
375 <description>The ip which will be assigned to this interface.</description>
378 <description>The broadcast address.</description>
381 <description>The network-device.</description>
384 <description>The network-prefix.</description>
387 <description>The network-mask.</description>
390 <description>The scope of the network interfaces.</description>
393 <description>When this file exists, the interface will be named with the text in this file.</description>
396 <description>When this file exists, the interface will be assumed to exist already. A
397 former name for this flag was 'only_ip' which is deprecated now.</description>
402 <dir name="ulimits" type="fixed">
403 <description>A directory with ulimits. Possible resources are cpu, data, fsize, locks,
404 memlock, nofile, nproc, rss and/or stack.</description>
406 <file name="resource" type="symbolic">
407 <description>A file which contains the hard- and soft-limit of the given resource in the
408 first line. The special keyword 'inf' is recognized.</description>
411 <file name="resource.hard" type="symbolic">
412 <description>A file which contains the hard- of the given resource in the first line. The
413 special keyword 'inf' is recognized.</description>
416 <file name="resource.soft" type="symbolic">
417 <description>A file which contains the soft- of the given resource in the first line. The
418 special keyword 'inf' is recognized.</description>
422 <dir name="rlimits" type="fixed">
423 <description>see ulimits</description>
426 <dir name="uts" type="fixed">
427 <file name="context">
428 <description>The context-name of the vserver</description>
430 <file name="sysname">
431 <description>The sysname of the vserver</description>
433 <file name="nodename">
434 <description>The node-/hostname of the vserver</description>
436 <file name="release">
437 <description>The OS-release of the vserver</description>
439 <file name="version">
440 <description>The OS-version of the vserver</description>
442 <file name="machine">
443 <description>The machine-type of the vserver</description>
445 <file name="domainname">
446 <description>The NIS domainname of the vserver</description>