use official HTML 4 colornames
[util-vserver.git] / util-vserver / doc / configuration.html
1 <?xml version="1.0"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
3 <html xmlns="http://www.w3.org/TR/xhtml1/strict">
4   <head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>The /etc/vservers directory</title><link rel="stylesheet" title="LSD" type="text/css" href="configuration-lsd.css"></link></head><body><h1>The content of the /etc/vservers directory</h1><ul><li><span class="directory">/etc/vservers/<span class="fixed">.defaults</span></span><br></br><span class="description"></span><ul><li><span class="symlink" title="/etc/vservers/.defaults/vdirbase">vdirbase</span><br></br><span class="description"></span></li><li><span class="directory">/etc/vservers/<span class="fixed">.defaults</span>/<span class="fixed">apps</span></span><br></br><span class="description"></span><ul><li><span class="directory">/etc/vservers/<span class="fixed">.defaults</span>/<span class="fixed">apps</span>/<span class="fixed">debootstrap</span></span><br></br><span class="description"></span><ul><li><span class="file" title="/etc/vservers/.defaults/apps/debootstrap/mirror">mirror</span><br></br><span class="description">The Debian mirror which is used for 'debootstrap'.</span></li><li><span class="file" title="/etc/vservers/.defaults/apps/debootstrap/uri">uri</span><br></br><span class="description">When the 'debootstrap' package is not installed; fetch it from this uri and
5             install it at a temporary place.</span></li></ul></li><li><span class="directory">/etc/vservers/<span class="fixed">.defaults</span>/<span class="fixed">apps</span>/<span class="fixed">init</span></span><br></br><span class="description"></span><ul><li><span class="symlink" title="/etc/vservers/.defaults/apps/init/tty">tty</span><br></br><span class="description">A symlink to the TTY device where input/output will be redirected from/to
6             at startup via initscript.</span></li></ul></li><li><span class="directory">/etc/vservers/<span class="fixed">.defaults</span>/<span class="fixed">apps</span>/<span class="fixed">pkgmgmt</span></span><br></br><span class="description"></span><ul><li><span class="file" title="/etc/vservers/.defaults/apps/pkgmgmt/apt.conf">apt.conf</span><br></br><span class="description">The default apt.conf which is going to be used. It is overridden by
7             distribution specific configuration file.</span></li><li><span class="symlink" title="/etc/vservers/.defaults/apps/pkgmgmt/base">base</span><br></br><span class="description"></span></li></ul></li><li><span class="directory">/etc/vservers/<span class="fixed">.defaults</span>/<span class="fixed">apps</span>/<span class="fixed">vprocunhide</span></span><br></br><span class="description"></span><ul><li><span class="file" title="/etc/vservers/.defaults/apps/vprocunhide/files">files</span><br></br><span class="description">A list of files which will be made visibly by vprocunhide. Wildcards are
8             allowed and anything ending in '/' will be processed recursively. When this file exists,
9             it overrides the defaults in SYSDEFAULTDIR/vprocunhide-files.</span></li></ul></li></ul></li><li><span class="directory">/etc/vservers/<span class="fixed">.defaults</span>/<span class="fixed">init</span></span><br></br><span class="description"></span><ul><li><span class="file" title="/etc/vservers/.defaults/init/mtab">mtab</span><br></br><span class="description">Default mtab-file</span></li></ul></li></ul></li><li><span class="directory">/etc/vservers/<span class="fixed">.distributions</span></span><br></br><span class="description"></span><ul><li><span class="directory">/etc/vservers/<span class="fixed">.distributions</span>/<span class="symbolic">dist</span></span><br></br><span class="description"></span><ul><li><span class="file" title="/etc/vservers/.distributions/dist/apt.conf">apt.conf</span><br></br><span class="description">The default apt.conf which is going to be used. It overrides the apt.conf
10           from CONFDIR/.defaults/apps/pkgmgmt.</span></li><li><span class="file" title="/etc/vservers/.distributions/dist/dev">dev</span><br></br><span class="description"></span></li><li><span class="symlink" title="/etc/vservers/.distributions/dist/execdir">execdir</span><br></br><span class="description">Directory with all executables and libraries which are required for this
11           distribution.</span></li><li><span class="script" title="/etc/vservers/.distributions/dist/initpost">initpost</span><br></br><span class="description">Script which will be executed after packages are installed.</span></li><li><span class="script" title="/etc/vservers/.distributions/dist/initpre">initpre</span><br></br><span class="description">Script which will be executed before packages will be installed.</span></li><li><span class="symlink" title="/etc/vservers/.distributions/dist/rpmlib">rpmlib</span><br></br><span class="description">Directory which overrides /usr/lib/rpm.</span></li><li><span class="directory">/etc/vservers/<span class="fixed">.distributions</span>/<span class="symbolic">dist</span>/<span class="fixed">apt</span></span><br></br><span class="description">Default content of the /etc/apt/ directory.</span></li><li><span class="directory">/etc/vservers/<span class="fixed">.distributions</span>/<span class="symbolic">dist</span>/<span class="fixed">pkgs</span></span><br></br><span class="description">Contains files with packages.</span><ul><li><span class="file" title="/etc/vservers/.distributions/dist/pkgs/list">list</span><br></br><span class="description">File which contains the name of packages. On top of file the special
12             keywords '--reinstall' and '--can-fail' are possible.</span></li></ul></li><li><span class="directory">/etc/vservers/<span class="fixed">.distributions</span>/<span class="symbolic">dist</span>/<span class="fixed">pubkeys</span></span><br></br><span class="description">Directory with GPG pubkeys which are used to sign the packages of this
13           distribution.</span></li><li><span class="directory">/etc/vservers/<span class="fixed">.distributions</span>/<span class="symbolic">dist</span>/<span class="fixed">rpm</span></span><br></br><span class="description">Default content of the /etc/rpm directory.</span></li></ul></li></ul></li><li><span class="directory">/etc/vservers/<span class="symbolic">vserver-name</span></span><br></br><span class="description">The configuration directory for the vserver vserver-name.</span><ul><li><span class="file" title="/etc/vservers/vserver-name/capabilities">capabilities</span><br></br><span class="description">Contains per line a capability.</span></li><li><span class="file" title="/etc/vservers/vserver-name/context">context</span><br></br><span class="description">Contains the context which shall be used for the vserver.</span></li><li><span class="file" title="/etc/vservers/vserver-name/domainname">domainname</span><br></br><span class="description">The domainname of the vserver.</span></li><li><span class="file" title="/etc/vservers/vserver-name/flags">flags</span><br></br><span class="description">Contains per line a flag.</span></li><li><span class="file" title="/etc/vservers/vserver-name/fstab">fstab</span><br></br><span class="description">The fstab file for the vserver.</span></li><li><span class="file" title="/etc/vservers/vserver-name/hostname">hostname</span><br></br><span class="description">Contains the hostname of the vserver.</span></li><li><span class="file" title="/etc/vservers/vserver-name/name">name</span><br></br><span class="description">Contains the name of the vserver. When not given, the basename of the directory
14         will be assumed as this name.</span></li><li><span class="file" title="/etc/vservers/vserver-name/nice">nice</span><br></br><span class="description">The nice-level on which the vserver will be started.</span></li><li><span class="file" title="/etc/vservers/vserver-name/shell">shell</span><br></br><span class="description">Contains the pathname of the shell which will be used by the "vserver ... enter"
15         command.</span></li><li><span class="directory">/etc/vservers/<span class="symbolic">vserver-name</span>/<span class="fixed">apps</span></span><br></br><span class="description"></span><ul><li><span class="directory">/etc/vservers/<span class="symbolic">vserver-name</span>/<span class="fixed">apps</span>/<span class="fixed">init</span></span><br></br><span class="description"></span><ul><li><span class="file" title="/etc/vservers/vserver-name/apps/init/cmd.prepare">cmd.prepare</span><br></br><span class="description">The command which is used to setup the init-system (e.g. to set the runlevel
16             in the utmp-file). Each option must be on a separate line.</span></li><li><span class="file" title="/etc/vservers/vserver-name/apps/init/cmd.start">cmd.start</span><br></br><span class="description">The command which is used to start the vserver. Each option must be on a
17             separate line.</span></li><li><span class="file" title="/etc/vservers/vserver-name/apps/init/cmd.start-sync">cmd.start-sync</span><br></br><span class="description">The command which is used to wait on the vserver after it has been
18             started. Each option must be on a separate line. This file will be ignored when the
19             'sync' does not exist and the '--sync' option was not used.</span></li><li><span class="file" title="/etc/vservers/vserver-name/apps/init/cmd.stop">cmd.stop</span><br></br><span class="description">The command which is used to stop the vserver. Each option must be on a
20             separate line.</span></li><li><span class="file" title="/etc/vservers/vserver-name/apps/init/cmd.stop-sync">cmd.stop-sync</span><br></br><span class="description">The command which is used to wait on the vserver after it has been
21             stopped. Each option must be on a separate line. This file will be ignored when the
22             'sync' does not exist and the '--sync' option was not used.</span></li><li><span class="file" title="/etc/vservers/vserver-name/apps/init/killseq">killseq</span><br></br><span class="description">Contains the 'signal [wait signal]*' sequence which is used to stop the
23             vserver.</span></li><li><span class="file" title="/etc/vservers/vserver-name/apps/init/mtab">mtab</span><br></br><span class="description">The initial-mtab which will be used for the vserver.</span></li><li><span class="file" title="/etc/vservers/vserver-name/apps/init/runlevel">runlevel</span><br></br><span class="description">The start runlevel.</span></li><li><span class="file" title="/etc/vservers/vserver-name/apps/init/runlevel.start">runlevel.start</span><br></br><span class="description">The start runlevel.</span></li><li><span class="file" title="/etc/vservers/vserver-name/apps/init/runlevel.stop">runlevel.stop</span><br></br><span class="description">The stop runlevel.</span></li><li><span class="file" title="/etc/vservers/vserver-name/apps/init/style">style</span><br></br><span class="description">Contains the init-style; possible values are 'sysv', 'plain' and
24             'minit'.</span></li><li><span class="file" title="/etc/vservers/vserver-name/apps/init/sync">sync</span><br></br><span class="description">Without this file, the 'cmd.*-sync' files will be ignored.</span></li><li><span class="symlink" title="/etc/vservers/vserver-name/apps/init/tty">tty</span><br></br><span class="description">A symlink to the TTY device where input/output will be redirected from/to
25             at startup via initscript.</span></li></ul></li></ul></li><li><span class="directory">/etc/vservers/<span class="symbolic">vserver-name</span>/<span class="fixed">interfaces</span></span><br></br><span class="description"></span><ul><li><span class="file" title="/etc/vservers/vserver-name/interfaces/bcast">bcast</span><br></br><span class="description">The deafult broadcast address.</span></li><li><span class="file" title="/etc/vservers/vserver-name/interfaces/dev">dev</span><br></br><span class="description">The default network-device.</span></li><li><span class="file" title="/etc/vservers/vserver-name/interfaces/mask">mask</span><br></br><span class="description">The default network-mask.</span></li><li><span class="file" title="/etc/vservers/vserver-name/interfaces/prefix">prefix</span><br></br><span class="description">The default network-prefix.</span></li><li><span class="file" title="/etc/vservers/vserver-name/interfaces/scope">scope</span><br></br><span class="description">The default scope of the network interfaces.</span></li><li><span class="directory">/etc/vservers/<span class="symbolic">vserver-name</span>/<span class="fixed">interfaces</span>/<span class="symbolic">iface</span></span><br></br><span class="description"></span><ul><li><span class="file" title="/etc/vservers/vserver-name/interfaces/iface/bcast">bcast</span><br></br><span class="description">The broadcast address.</span></li><li><span class="file" title="/etc/vservers/vserver-name/interfaces/iface/dev">dev</span><br></br><span class="description">The network-device.</span></li><li><span class="file" title="/etc/vservers/vserver-name/interfaces/iface/disabled">disabled</span><br></br><span class="description">When this file exists, this interface will be ignored.</span></li><li><span class="file" title="/etc/vservers/vserver-name/interfaces/iface/ip">ip</span><br></br><span class="description">The ip which will be assigned to this interface.</span></li><li><span class="file" title="/etc/vservers/vserver-name/interfaces/iface/mask">mask</span><br></br><span class="description">The network-mask.</span></li><li><span class="file" title="/etc/vservers/vserver-name/interfaces/iface/name">name</span><br></br><span class="description">When this file exists, the interface will be named with the text in this file.</span></li><li><span class="file" title="/etc/vservers/vserver-name/interfaces/iface/nodev">nodev</span><br></br><span class="description">When this file exists, the interface will be assumed to exist already. A
26             former name for this flag was 'only_ip' which is deprecated now.</span></li><li><span class="file" title="/etc/vservers/vserver-name/interfaces/iface/prefix">prefix</span><br></br><span class="description">The network-prefix.</span></li><li><span class="file" title="/etc/vservers/vserver-name/interfaces/iface/scope">scope</span><br></br><span class="description">The scope of the network interfaces.</span></li></ul></li></ul></li><li><span class="directory">/etc/vservers/<span class="symbolic">vserver-name</span>/<span class="fixed">rlimits</span></span><br></br><span class="description">see ulimits</span></li><li><span class="directory">/etc/vservers/<span class="symbolic">vserver-name</span>/<span class="fixed">scripts</span></span><br></br><span class="description"></span><ul><li><span class="script" title="/etc/vservers/vserver-name/scripts/post-start">post-start</span><br></br><span class="description">The scriptlet which will be executed after the vserver has been started.</span></li><li><span class="script" title="/etc/vservers/vserver-name/scripts/post-stop">post-stop</span><br></br><span class="description">The scriptlet which will be executed after the vserver has been stopped, but
27                           before the directories will be umounted and the the interfaces
28                           disabled.</span></li><li><span class="script" title="/etc/vservers/vserver-name/scripts/postpost-stop">postpost-stop</span><br></br><span class="description">The scriptlet which will be executed after the vserver has been stopped
29                              completely.</span></li><li><span class="script" title="/etc/vservers/vserver-name/scripts/pre-start">pre-start</span><br></br><span class="description">The scriptlet which will be executed after network-interfaces were enabled and
30                           the directories mounted, but before the vserver itself has been
31                           started.</span></li><li><span class="script" title="/etc/vservers/vserver-name/scripts/pre-stop">pre-stop</span><br></br><span class="description">The scriptlet which will be executed before the vserver will be stopped.</span></li><li><span class="script" title="/etc/vservers/vserver-name/scripts/prepre-start">prepre-start</span><br></br><span class="description">The scriptlet which will be executed before the network-interfaces are enabled
32                             and the directories are mounted.</span></li><li><span class="directory">/etc/vservers/<span class="symbolic">vserver-name</span>/<span class="fixed">scripts</span>/<span class="">post-start.d</span></span><br></br><span class="description">A directory with scriptlets which will be executed after the vserver has been started.</span><ul><li><span class="script" title="/etc/vservers/vserver-name/scripts/post-start.d/script">script</span><br></br><span class="description">A scriptlet which will be executed after the vserver has been started.</span></li></ul></li><li><span class="directory">/etc/vservers/<span class="symbolic">vserver-name</span>/<span class="fixed">scripts</span>/<span class="fixed">post-stop.d</span></span><br></br><span class="description">A directory with scriptlets which will be executed after the vserver has been stopped, but
33                           before the directories will be umounted and the the interfaces
34                           disabled.</span><ul><li><span class="script" title="/etc/vservers/vserver-name/scripts/post-stop.d/script">script</span><br></br><span class="description">A scriptlet which will be executed after the vserver has been stopped, but
35                           before the directories will be umounted and the the interfaces
36                           disabled.</span></li></ul></li><li><span class="directory">/etc/vservers/<span class="symbolic">vserver-name</span>/<span class="fixed">scripts</span>/<span class="fixed">postpost-stop.d</span></span><br></br><span class="description">A directory with scriptlets which will be executed after the vserver has been stopped
37                              completely.</span><ul><li><span class="script" title="/etc/vservers/vserver-name/scripts/postpost-stop.d/script">script</span><br></br><span class="description">A scriptlet which will be executed after the vserver has been stopped
38                              completely.</span></li></ul></li><li><span class="directory">/etc/vservers/<span class="symbolic">vserver-name</span>/<span class="fixed">scripts</span>/<span class="">pre-start.d</span></span><br></br><span class="description">A directory with scriptlets which will be executed after network-interfaces were enabled and
39                           the directories mounted, but before the vserver itself has been
40                           started.</span><ul><li><span class="script" title="/etc/vservers/vserver-name/scripts/pre-start.d/script">script</span><br></br><span class="description">A scriptlet which will be executed after network-interfaces were enabled and
41                           the directories mounted, but before the vserver itself has been
42                           started.</span></li></ul></li><li><span class="directory">/etc/vservers/<span class="symbolic">vserver-name</span>/<span class="fixed">scripts</span>/<span class="fixed">pre-stop.d</span></span><br></br><span class="description">A directory with scriptlets which will be executed before the vserver will be stopped.</span><ul><li><span class="script" title="/etc/vservers/vserver-name/scripts/pre-stop.d/script">script</span><br></br><span class="description">A scriptlet which will be executed before the vserver will be stopped.</span></li></ul></li><li><span class="directory">/etc/vservers/<span class="symbolic">vserver-name</span>/<span class="fixed">scripts</span>/<span class="fixed">prepre-start.d</span></span><br></br><span class="description">A directory with scriptlets which will be executed before the network-interfaces are enabled
43                             and the directories are mounted.</span><ul><li><span class="script" title="/etc/vservers/vserver-name/scripts/prepre-start.d/script">script</span><br></br><span class="description">A scriptlet which will be executed before the network-interfaces are enabled
44                             and the directories are mounted.</span></li></ul></li></ul></li><li><span class="directory">/etc/vservers/<span class="symbolic">vserver-name</span>/<span class="fixed">ulimits</span></span><br></br><span class="description">A directory with ulimits. Possible resources are cpu, data, fsize, locks,
45         memlock, nofile, nproc, rss and/or stack.</span><ul><li><span class="file" title="/etc/vservers/vserver-name/ulimits/resource">resource</span><br></br><span class="description">A file which contains the hard- and soft-limit of the given resource in the
46           first line. The special keyword 'inf' is recognized.</span></li><li><span class="file" title="/etc/vservers/vserver-name/ulimits/resource.hard">resource.hard</span><br></br><span class="description">A file which contains the hard- of the given resource in the first line. The
47           special keyword 'inf' is recognized.</span></li><li><span class="file" title="/etc/vservers/vserver-name/ulimits/resource.soft">resource.soft</span><br></br><span class="description">A file which contains the soft- of the given resource in the first line. The
48           special keyword 'inf' is recognized.</span></li></ul></li><li><span class="directory">/etc/vservers/<span class="symbolic">vserver-name</span>/<span class="fixed">uts</span></span><br></br><span class="description"></span><ul><li><span class="file" title="/etc/vservers/vserver-name/uts/context">context</span><br></br><span class="description">The context-name of the vserver</span></li><li><span class="file" title="/etc/vservers/vserver-name/uts/domainname">domainname</span><br></br><span class="description">The NIS domainname of the vserver</span></li><li><span class="file" title="/etc/vservers/vserver-name/uts/machine">machine</span><br></br><span class="description">The machine-type of the vserver</span></li><li><span class="file" title="/etc/vservers/vserver-name/uts/nodename">nodename</span><br></br><span class="description">The node-/hostname of the vserver</span></li><li><span class="file" title="/etc/vservers/vserver-name/uts/release">release</span><br></br><span class="description">The OS-release of the vserver</span></li><li><span class="file" title="/etc/vservers/vserver-name/uts/sysname">sysname</span><br></br><span class="description">The sysname of the vserver</span></li><li><span class="file" title="/etc/vservers/vserver-name/uts/version">version</span><br></br><span class="description">The OS-version of the vserver</span></li></ul></li></ul></li></ul></body>
49 </html>