util-vserver-0.30.208
[util-vserver.git] / doc / configuration.html
diff --git a/doc/configuration.html b/doc/configuration.html
new file mode 100644 (file)
index 0000000..e82d9e8
--- /dev/null
@@ -0,0 +1,1211 @@
+<?xml version="1.0"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+    <title>The /etc/vservers directory</title>
+    <link rel="stylesheet" title="gras" type="text/css" href="css/configuration-lsd.css" />
+    <link rel="alternate stylesheet" title="gras1" type="text/css" href="css/configuration-lsd1.css" />
+    <link rel="alternate stylesheet" title="flower" type="text/css" href="css/configuration-flower.css" />
+    <link rel="alternate stylesheet" title="boring" type="text/css" href="configuration.css" />
+    <link rel="alternate stylesheet" title="weedpage" type="text/css" href="css/WeedPageStyle.css" />
+  </head>
+  <body>
+    <h1>The content of the /etc/vservers directory</h1>
+    <ul>
+      <li>
+        <span class="directory">/etc/vservers/<span class="">.defaults</span></span>
+        <br />
+        <ul>
+          <li id="global-nonamespace">
+            <span class="boolean" title="/etc/vservers/.defaults/nonamespace">nonamespace</span>
+            <br />
+            <div class="description">
+Disable namespace usage globally. It can be overridden for a single vserver
+by setting the <a class="optionref" href="#global-namespace">namespace</a> flag
+there.
+
+In this mode the <span class="directoryname">/vservers</span> directory must have
+the 'barrier' attribute. Else, common chroot(2) exploits are possible.
+      </div>
+          </li>
+          <li>
+            <span class="symlink" title="/etc/vservers/.defaults/run.rev">run.rev</span>
+            <br />
+            <div class="description">
+Path of the vserver run reverse directory. This directory contains
+symlinks named with XID numbers which point back to the configuration
+directory of vservers. Under kernel 2.4 this is required for the XID
+to VSERVER mapping; Under kernel 2.6 it is unused.
+
+NOTE: this link exists in 0.30.202+ only; in previous versions it was
+a vserver specific setting.
+      </div>
+          </li>
+          <li>
+            <span class="symlink" title="/etc/vservers/.defaults/vdirbase">vdirbase</span>
+            <br />
+            <div class="description">A link to the default vserver rootdirectory.</div>
+          </li>
+          <li>
+            <span class="directory">/etc/vservers/<span class="">.defaults</span>/<span class="">apps</span></span>
+            <br />
+            <ul>
+              <li>
+                <span class="directory">/etc/vservers/<span class="">.defaults</span>/<span class="">apps</span>/<span class="">debootstrap</span></span>
+                <br />
+                <ul>
+                  <li>
+                    <span class="file" title="/etc/vservers/.defaults/apps/debootstrap/mirror">mirror</span>
+                    <br />
+                    <div class="description">
+The Debian mirror to use with the <code class="tool">debootstrap</code> program
+          </div>
+                  </li>
+                  <li>
+                    <span class="file" title="/etc/vservers/.defaults/apps/debootstrap/uri">uri</span>
+                    <br />
+                    <div class="description">
+When the <code class="tool">debootstrap</code> package is not installed; fetch it
+from this uri and install it at a temporary place.
+          </div>
+                  </li>
+                </ul>
+              </li>
+              <li>
+                <span class="directory">/etc/vservers/<span class="">.defaults</span>/<span class="">apps</span>/<span class="">init</span></span>
+                <br />
+                <ul>
+                  <li>
+                    <span class="symlink" title="/etc/vservers/.defaults/apps/init/tty">tty</span>
+                    <br />
+                    <div class="description">
+A symlink to the TTY device where input/output will be redirected from/to
+at startup via initscript.
+          </div>
+                  </li>
+                </ul>
+              </li>
+              <li>
+                <span class="directory">/etc/vservers/<span class="">.defaults</span>/<span class="">apps</span>/<span class="">pkgmgmt</span></span>
+                <br />
+                <ul>
+                  <li>
+                    <span class="data" title="/etc/vservers/.defaults/apps/pkgmgmt/apt.conf">apt.conf</span>
+                    <br />
+                    <div class="description">The default apt.conf which is going to be used. It is overridden by
+distribution specific configuration file.
+          </div>
+                  </li>
+                  <li>
+                    <span class="symlink" title="/etc/vservers/.defaults/apps/pkgmgmt/base">base</span>
+                    <br />
+                  </li>
+                </ul>
+              </li>
+              <li>
+                <span class="directory">/etc/vservers/<span class="">.defaults</span>/<span class="">apps</span>/<span class="">vprocunhide</span></span>
+                <br />
+                <ul>
+                  <li>
+                    <span class="list" title="/etc/vservers/.defaults/apps/vprocunhide/files">files</span>
+                    <br />
+                    <div class="description">
+A list of files which will be made visibly by vprocunhide. Wildcards are
+allowed and anything ending in '/' will be processed recursively. When this file exists,
+it overrides the defaults in SYSDEFAULTDIR/vprocunhide-files. The entries there must be
+absolute filenames inclusive the leading '/proc'.
+          </div>
+                  </li>
+                </ul>
+              </li>
+              <li>
+                <span class="directory">/etc/vservers/<span class="">.defaults</span>/<span class="">apps</span>/<span class="">vshelper</span></span>
+                <br />
+                <ul>
+                  <li>
+                    <span class="boolean" title="/etc/vservers/.defaults/apps/vshelper/debug">debug</span>
+                    <br />
+                    <div class="description">
+When existing, the vshelper execution will be traced.
+          </div>
+                  </li>
+                  <li>
+                    <span class="boolean" title="/etc/vservers/.defaults/apps/vshelper/disabled">disabled</span>
+                    <br />
+                    <div class="description">
+When existing, the vshelper functionality will be disabled for all
+vservers.
+          </div>
+                  </li>
+                  <li>
+                    <span class="symlink" title="/etc/vservers/.defaults/apps/vshelper/logfile">logfile</span>
+                    <br />
+                    <div class="description">
+The file where output will be logged to when <code class="tool">vshelper</code>
+is invoked from the kernel. This should point somewhere e.g. into
+<span class="directoryname">/var/log</span>.
+          </div>
+                  </li>
+                  <li>
+                    <span class="boolean" title="/etc/vservers/.defaults/apps/vshelper/warning-disabled">warning-disabled</span>
+                    <br />
+                    <div class="description">
+When existing, sanity checks for the vshelper functionality will be
+skipped.
+          </div>
+                  </li>
+                  <li>
+                    <span class="directory">/etc/vservers/<span class="">.defaults</span>/<span class="">apps</span>/<span class="">vshelper</span>/<span class="">vshelper-methods</span></span>
+                    <br />
+                    <ul>
+                      <li>
+                        <span class="script" title="/etc/vservers/.defaults/apps/vshelper/vshelper-methods/$handler">handler</span>
+                        <br />
+                        <div class="description">
+See vshelper/action.
+            </div>
+                      </li>
+                    </ul>
+                  </li>
+                </ul>
+              </li>
+              <li>
+                <span class="directory">/etc/vservers/<span class="">.defaults</span>/<span class="">apps</span>/<span class="">vunify</span></span>
+                <br />
+                <ul>
+                  <li>
+                    <span class="list" title="/etc/vservers/.defaults/apps/vunify/exclude">exclude</span>
+                    <br />
+                    <div class="description">Static list of excluded files.</div>
+                  </li>
+                  <li>
+                    <span class="boolean" title="/etc/vservers/.defaults/apps/vunify/pgkmgmt-force">pgkmgmt-force</span>
+                    <br />
+                    <div class="description">
+When existing, information from packagemanagement will be used to
+create dynamic exclude-lists. This option requires that (a known)
+packagemanagement is configured for the vserver; else the requested
+operation will fail. Most tools assume 'on' as the default value.
+          </div>
+                  </li>
+                  <li>
+                    <span class="boolean" title="/etc/vservers/.defaults/apps/vunify/pkgmgmt-ignore">pkgmgmt-ignore</span>
+                    <br />
+                    <div class="description">
+When existing, information from packagemanagement will not be used to
+create dynamic exclude-lists.
+          </div>
+                  </li>
+                  <li>
+                    <span class="directory">/etc/vservers/<span class="">.defaults</span>/<span class="">apps</span>/<span class="">vunify</span>/<span class="">hash</span></span>
+                    <br />
+                    <div class="description">
+A directory which will be used as the storage place for the
+<code class="tool">vhashify</code> command.
+          </div>
+                    <ul>
+                      <li>
+                        <span class="symlink" title="/etc/vservers/.defaults/apps/vunify/hash/$id">id</span>
+                        <br />
+                        <div class="description">
+Points to a directory within the filesystems which are used for the
+vservers. There must be not more than one of such a directory per
+filesystem.
+            </div>
+                      </li>
+                      <li>
+                        <span class="file" title="/etc/vservers/.defaults/apps/vunify/hash/method">method</span>
+                        <br />
+                        <div class="description">The used hash method.</div>
+                      </li>
+                    </ul>
+                  </li>
+                </ul>
+              </li>
+            </ul>
+          </li>
+          <li>
+            <span class="directory">/etc/vservers/<span class="">.defaults</span>/<span class="fixed">init</span></span>
+            <br />
+            <ul>
+              <li>
+                <span class="data" title="/etc/vservers/.defaults/init/mtab">mtab</span>
+                <br />
+                <div class="description">Default mtab file</div>
+              </li>
+            </ul>
+          </li>
+        </ul>
+      </li>
+      <li>
+        <span class="directory">/etc/vservers/<span class="">.distributions</span></span>
+        <br />
+        <ul>
+          <li>
+            <span class="directory">/etc/vservers/<span class="">.distributions</span>/<span class="symbolic">dist</span></span>
+            <br />
+            <ul>
+              <li>
+                <span class="data" title="/etc/vservers/.distributions/$dist/apt.conf">apt.conf</span>
+                <br />
+                <div class="description">
+The default apt.conf which is going to be used. It overrides the
+apt.conf from CONFDIR/.defaults/apps/pkgmgmt.
+        </div>
+              </li>
+              <li>
+                <span class="file" title="/etc/vservers/.distributions/$dist/dev">dev</span>
+                <br />
+                <div class="description"></div>
+              </li>
+              <li>
+                <span class="symlink" title="/etc/vservers/.distributions/$dist/execdir">execdir</span>
+                <br />
+                <div class="description">
+Directory with all executables and libraries which are required for
+this distribution.
+        </div>
+              </li>
+              <li>
+                <span class="script" title="/etc/vservers/.distributions/$dist/initpost">initpost</span>
+                <br />
+                <div class="description">
+Script which will be executed after packages are installed.
+          </div>
+              </li>
+              <li>
+                <span class="script" title="/etc/vservers/.distributions/$dist/initpre">initpre</span>
+                <br />
+                <div class="description">
+Script which will be executed before packages will be installed.
+          </div>
+              </li>
+              <li>
+                <span class="symlink" title="/etc/vservers/.distributions/$dist/rpmlib">rpmlib</span>
+                <br />
+                <div class="description">
+Directory which overrides <span class="directoryname">/usr/lib/rpm</span>.
+        </div>
+              </li>
+              <li>
+                <span class="directory">/etc/vservers/<span class="">.distributions</span>/<span class="symbolic">dist</span>/<span class="">apt</span></span>
+                <br />
+                <div class="description">
+Default content of the <span class="directoryname">/etc/apt/</span> directory.
+        </div>
+              </li>
+              <li>
+                <span class="directory">/etc/vservers/<span class="">.distributions</span>/<span class="symbolic">dist</span>/<span class="">pkgs</span></span>
+                <br />
+                <div class="description">
+Contains files with packagenames.
+        </div>
+                <ul>
+                  <li>
+                    <span class="list" title="/etc/vservers/.distributions/$dist/pkgs/list">list</span>
+                    <br />
+                    <div class="description">
+File which contains the name of packages. On top of file the special
+keywords '--reinstall' and '--can-fail' are possible.
+          </div>
+                  </li>
+                </ul>
+              </li>
+              <li>
+                <span class="directory">/etc/vservers/<span class="">.distributions</span>/<span class="symbolic">dist</span>/<span class="">pubkeys</span></span>
+                <br />
+                <div class="description">
+Directory with GPG pubkeys which are used to sign the packages of this
+distribution.
+        </div>
+              </li>
+              <li>
+                <span class="directory">/etc/vservers/<span class="">.distributions</span>/<span class="symbolic">dist</span>/<span class="">rpm</span></span>
+                <br />
+                <div class="description">
+Default content of the <span class="directoryname">/etc/rpm</span> directory.
+        </div>
+              </li>
+              <li>
+                <span class="directory">/etc/vservers/<span class="">.distributions</span>/<span class="symbolic">dist</span>/<span class="">yum</span></span>
+                <br />
+                <div class="description">
+The default, yum-related content of the <span class="directoryname">/etc</span>
+directory.
+        </div>
+                <ul>
+                  <li>
+                    <span class="file" title="/etc/vservers/.distributions/$dist/yum/yum.conf">yum.conf</span>
+                    <br />
+                    <div class="description">
+The master yum configuration file. It supports the @YUMETCDIR@,
+@YUMCACHEDIR@ and @YUMLOGDIR@ placeholder which will be replaced at
+<code class="command">vserver ... build</code> time.
+          </div>
+                  </li>
+                </ul>
+              </li>
+              <li>
+                <span class="directory">/etc/vservers/<span class="">.distributions</span>/<span class="symbolic">dist</span>/<span class="">yum.repos.d</span></span>
+                <br />
+                <div class="description">A directory with yum repositories.</div>
+              </li>
+            </ul>
+          </li>
+        </ul>
+      </li>
+      <li>
+        <span class="directory">/etc/vservers/<span class="symbolic">vserver-name</span></span>
+        <br />
+        <div class="description">
+The configuration directory for the vserver vserver-name.
+    </div>
+        <ul>
+          <li id="bcapabilities">
+            <span class="list" title="/etc/vservers/$vserver-name/bcapabilities">bcapabilities</span>
+            <br />
+            <div class="description">
+[experimental; name is subject of possible change] Contains the system capabilities. See
+<a href="http://savannah.nongnu.org/cgi-bin/viewcvs/util-vserver/util-vserver/lib/bcaps-v13.c?rev=HEAD">lib/bcaps-v13.c</a>
+for possible values.
+      </div>
+          </li>
+          <li>
+            <span class="list" title="/etc/vservers/$vserver-name/capabilities">capabilities</span>
+            <br />
+            <div class="description">
+Contains per line a capability. This file is used for the 2.4 kernel
+only; for 2.6 use <a class="optionref" href="#bcapabilities">bcapabilities</a>.
+      </div>
+          </li>
+          <li>
+            <span class="list" title="/etc/vservers/$vserver-name/ccapabilities">ccapabilities</span>
+            <br />
+            <div class="description">
+[experimental; name is subject of possible change] Contains the
+context capabilities. See <a href="http://savannah.nongnu.org/cgi-bin/viewcvs/util-vserver/util-vserver/lib/ccaps-v13.c?rev=HEAD">lib/ccaps-v13.c</a>
+for possible values.
+      </div>
+          </li>
+          <li>
+            <span class="file" title="/etc/vservers/$vserver-name/context">context</span>
+            <br />
+            <div class="description">
+Contains the context which shall be used for the vserver.
+        </div>
+          </li>
+          <li>
+            <span class="list" title="/etc/vservers/$vserver-name/flags">flags</span>
+            <br />
+            <div class="description">
+Contains per line a flag. See <a href="http://savannah.nongnu.org/cgi-bin/viewcvs/util-vserver/util-vserver/lib/cflags-v13.c?rev=HEAD">lib/cflags-v13.c</a>
+for possible values.
+      </div>
+            <div class="elements">
+              <dl>
+                <dt class="elements">fakeinit</dt>
+                <dd class="elements">
+                  <div class="description">
+The new process will believe it is process number 1. Useful to run a
+real /sbin/init in a vserver. Warning: this flag should not be used
+unless you know what you are doing. Often, it is better to use the
+'plain' initstyle.
+          </div>
+                </dd>
+                <dt class="elements">lock</dt>
+                <dd class="elements">
+                  <div class="description">
+The new process is trapped and can't use chcontext anymore.
+          </div>
+                </dd>
+                <dt class="elements">nproc</dt>
+                <dd class="elements">
+                  <div class="description">
+Limit the number of process in the vserver according to
+ulimit setting. Normally, ulimit is a per user thing.
+With this flag, it becomes a per vserver thing.  
+          </div>
+                </dd>
+                <dt class="elements">private</dt>
+                <dd class="elements">
+                  <div class="description">
+No one can join this security context once created.
+          </div>
+                </dd>
+                <dt class="elements">sched</dt>
+                <dd class="elements">
+                  <div class="description">
+The new process and its children will share a common
+          </div>
+                </dd>
+                <dt class="elements">ulimit</dt>
+                <dd class="elements">
+                  <div class="description">
+Apply the current ulimit to the whole context
+          </div>
+                </dd>
+              </dl>
+            </div>
+          </li>
+          <li id="fstab">
+            <span class="data" title="/etc/vservers/$vserver-name/fstab">fstab</span>
+            <br />
+            <div class="description">
+The fstab file for the vserver. Entries in this file will be mounted
+within the network context of the host. Use the
+<a class="optionref" href="#fstab.remote">fstab.remote</a> file when you want that the
+mounting happens in the network context of the vserver. In most cases
+the 'fstab' file should be used.
+      </div>
+          </li>
+          <li id="fstab.remote">
+            <span class="data" title="/etc/vservers/$vserver-name/fstab.remote">fstab.remote</span>
+            <br />
+            <div class="description">
+The fstab file for the vserver. Entries in this file will be mounted
+within the network context of the host; this means that mount will be
+called as <code class="command">chbind &lt;options&gt; mount ...</code>. See
+<a class="optionref" href="#fstab">fstab</a> also.
+      </div>
+          </li>
+          <li>
+            <span class="file" title="/etc/vservers/$vserver-name/name">name</span>
+            <br />
+            <div class="description">
+Contains the name of the vserver. When not given, the basename of the directory
+will be assumed as this name.
+      </div>
+          </li>
+          <li id="global-namespace">
+            <span class="boolean" title="/etc/vservers/$vserver-name/namespace">namespace</span>
+            <br />
+            <div class="description">
+Overrides the global <a class="optionref" href="#global-nonamespace">nonamespace</a> flag and enables
+namespace usage for the current vserver.
+      </div>
+          </li>
+          <li>
+            <span class="file" title="/etc/vservers/$vserver-name/nice">nice</span>
+            <br />
+            <div class="description">
+The nice-level on which the vserver will be started.
+      </div>
+          </li>
+          <li>
+            <span class="boolean" title="/etc/vservers/$vserver-name/nonamespace">nonamespace</span>
+            <br />
+            <div class="description">
+Disables namespace usage for the current vserver.
+
+In this mode the <span class="directoryname">/vservers</span> directory must have
+the 'barrier' attribute. Else, common chroot(2) exploits are possible.
+      </div>
+          </li>
+          <li>
+            <span class="list" title="/etc/vservers/$vserver-name/personality">personality</span>
+            <br />
+            <div class="description">
+Used to set the personality of the vserver. First line in the file
+is the personality-type followed by flags (one item per line). See
+<a class="filename" href="file:///usr/include/linux/personality.h">/usr/include/linux/personality.h</a> for possible
+values.
+      </div>
+          </li>
+          <li>
+            <span class="symlink" title="/etc/vservers/$vserver-name/run">run</span>
+            <br />
+            <div class="description">
+Points to a file which will contain the XID of the running vserver. When
+the vserver is stopped, this can be a dangling symlink.
+      </div>
+          </li>
+          <li>
+            <span class="hash" title="/etc/vservers/$vserver-name/schedule">schedule</span>
+            <br />
+            <div class="description">
+[experimental; name is subject of possible change] Contains the
+scheduler parameters, one per line.
+
+The Hard CPU limit uses a mechanism called a Token Bucket.  the
+concept is simple: you have a bucket of a certain size which is
+filled with a specified amount R of tokens each interval T until the
+maximum is reached (excess tokens are spilled). At each timer tick,
+a running process consumes one token from the bucket, unless the
+bucket is empty. If the bucket is empty the process is put in the
+hold queue. When the bucket has been refilled to at least M tokens,
+all on hold processes are rescheduled.
+      </div>
+          </li>
+          <li>
+            <span class="file" title="/etc/vservers/$vserver-name/shell">shell</span>
+            <br />
+            <div class="description">
+Contains the pathname of the shell which will be used by the "vserver
+... enter" command.
+      </div>
+          </li>
+          <li>
+            <span class="symlink" title="/etc/vservers/$vserver-name/vdir">vdir</span>
+            <br />
+            <div class="description">
+Path of the vserver root directory
+      </div>
+          </li>
+          <li>
+            <span class="directory">/etc/vservers/<span class="symbolic">vserver-name</span>/<span class="">apps</span></span>
+            <br />
+            <ul>
+              <li>
+                <span class="directory">/etc/vservers/<span class="symbolic">vserver-name</span>/<span class="">apps</span>/<span class="">init</span></span>
+                <br />
+                <ul>
+                  <li>
+                    <span class="list" title="/etc/vservers/$vserver-name/apps/init/cmd.prepare">cmd.prepare</span>
+                    <br />
+                    <div class="description">
+The command which is used to setup the init-system (e.g. to set the
+runlevel in the utmp-file). Each option must be on a separate line.
+         </div>
+                  </li>
+                  <li>
+                    <span class="list" title="/etc/vservers/$vserver-name/apps/init/cmd.start">cmd.start</span>
+                    <br />
+                    <div class="description">
+The command which is used to start the vserver. Each option must be on
+a separate line.
+          </div>
+                  </li>
+                  <li>
+                    <span class="list" title="/etc/vservers/$vserver-name/apps/init/cmd.start-sync">cmd.start-sync</span>
+                    <br />
+                    <div class="description">
+The command which is used to wait on the vserver after it has been
+started. Each option must be on a separate line. This file will be
+ignored when the <a class="optionref" href="#sync">sync</a> flag does not exist and the
+'--sync' option was not used.
+         </div>
+                  </li>
+                  <li>
+                    <span class="list" title="/etc/vservers/$vserver-name/apps/init/cmd.stop">cmd.stop</span>
+                    <br />
+                    <div class="description">
+The command which is used to stop the vserver. Each option must be on
+a separate line.
+          </div>
+                  </li>
+                  <li>
+                    <span class="list" title="/etc/vservers/$vserver-name/apps/init/cmd.stop-sync">cmd.stop-sync</span>
+                    <br />
+                    <div class="description">
+The command which is used to wait on the vserver after it has been
+stopped. Each option must be on a separate line. This file will be
+ignored when the <a class="optionref" href="#sync">sync</a> flag does not exist and the
+'--sync' option was not used.
+          </div>
+                  </li>
+                  <li>
+                    <span class="list" title="/etc/vservers/$vserver-name/apps/init/depends">depends</span>
+                    <br />
+                    <div class="description">
+This file is used to configure vservers which must be running before
+the current vserver can be started. At shutdown, the current vserver
+will be stopped before its dependencies. Content of this file are
+vserver ids (one name per line).
+          </div>
+                  </li>
+                  <li>
+                    <span class="file" title="/etc/vservers/$vserver-name/apps/init/killseq">killseq</span>
+                    <br />
+                    <div class="description">
+Contains the 'signal [wait signal]*' sequence which is used to stop
+the vserver.
+          </div>
+                  </li>
+                  <li>
+                    <span class="file" title="/etc/vservers/$vserver-name/apps/init/mark">mark</span>
+                    <br />
+                    <div class="description">
+This file is used to mark group of vservers which shall be started/stopped
+together by the initscript. Content is a simple string like 'default'.
+         </div>
+                  </li>
+                  <li>
+                    <span class="data" title="/etc/vservers/$vserver-name/apps/init/mtab">mtab</span>
+                    <br />
+                    <div class="description">
+The initial-mtab which will be used for the vserver.
+          </div>
+                  </li>
+                  <li>
+                    <span class="file" title="/etc/vservers/$vserver-name/apps/init/runlevel">runlevel</span>
+                    <br />
+                    <div class="description">The start runlevel.</div>
+                  </li>
+                  <li>
+                    <span class="file" title="/etc/vservers/$vserver-name/apps/init/runlevel.start">runlevel.start</span>
+                    <br />
+                    <div class="description">The start runlevel.</div>
+                  </li>
+                  <li>
+                    <span class="file" title="/etc/vservers/$vserver-name/apps/init/runlevel.stop">runlevel.stop</span>
+                    <br />
+                    <div class="description">The stop runlevel.</div>
+                  </li>
+                  <li>
+                    <span class="file" title="/etc/vservers/$vserver-name/apps/init/style">style</span>
+                    <br />
+                    <div class="description">
+Contains the init-style.
+          </div>
+                  </li>
+                  <li id="sync">
+                    <span class="boolean" title="/etc/vservers/$vserver-name/apps/init/sync">sync</span>
+                    <br />
+                    <div class="description">
+If this file is not present, all 'cmd.*-sync files will be ignored.
+           </div>
+                  </li>
+                  <li>
+                    <span class="symlink" title="/etc/vservers/$vserver-name/apps/init/tty">tty</span>
+                    <br />
+                    <div class="description">
+A symlink to the TTY device where input/output will be redirected
+from/to at startup via initscript.
+         </div>
+                  </li>
+                </ul>
+              </li>
+              <li>
+                <span class="directory">/etc/vservers/<span class="symbolic">vserver-name</span>/<span class="">apps</span>/<span class="">vshelper</span></span>
+                <br />
+                <ul>
+                  <li>
+                    <span class="file" title="/etc/vservers/$vserver-name/apps/vshelper/action">action</span>
+                    <br />
+                    <div class="description">
+The action which is going to be executed when a vshelper event
+occurs. The default value is 'restart', but there can be defined own
+methods by placing scripts into the
+<a class="optionref" href="#vshelper-methods">vshelper-methods</a> directories. These scripts are
+fed with the same arguments as the <code class="tool">vshelper</code> script.
+          </div>
+                  </li>
+                  <li>
+                    <span class="boolean" title="/etc/vservers/$vserver-name/apps/vshelper/debug">debug</span>
+                    <br />
+                    <div class="description">
+When existing, the vshelper execution will be traced for this vserver.
+          </div>
+                  </li>
+                  <li>
+                    <span class="boolean" title="/etc/vservers/$vserver-name/apps/vshelper/disabled">disabled</span>
+                    <br />
+                    <div class="description">
+When existing, the vshelper functionality will be disabled for this
+vserver.
+          </div>
+                  </li>
+                  <li>
+                    <span class="script" title="/etc/vservers/$vserver-name/apps/vshelper/$event">event</span>
+                    <br />
+                    <div class="description">
+When existing, these scripts will be executed *instead* of the default
+handler defined in 'action'. Their name must match the event which caused
+the execution of <code class="tool">vshelper</code>; e.g. 'restart' or 'poweroff'. See
+the vs_reboot() function in the kernel for more details.
+          </div>
+                  </li>
+                  <li>
+                    <span class="file" title="/etc/vservers/$vserver-name/apps/vshelper/sync-timeout">sync-timeout</span>
+                    <br />
+                    <div class="description">
+The timeout in seconds which is used when synchronising vserver
+startup/shutdown with the vshelper. When no set, 30 seconds will be
+assumed.
+         </div>
+                  </li>
+                  <li>
+                    <span class="boolean" title="/etc/vservers/$vserver-name/apps/vshelper/warning-disabled">warning-disabled</span>
+                    <br />
+                    <div class="description">
+When existing, sanity checks for the vshelper functionality will be
+skipped.
+          </div>
+                  </li>
+                </ul>
+              </li>
+              <li id="vshelper-methods">
+                <span class="directory">/etc/vservers/<span class="symbolic">vserver-name</span>/<span class="">apps</span>/<span class="">vshelper-methods</span></span>
+                <br />
+                <ul id="vshelper-methods">
+                  <li>
+                    <span class="script" title="/etc/vservers/$vserver-name/apps/vshelper-methods/$handler">handler</span>
+                    <br />
+                    <div class="description">
+See vshelper/action.
+          </div>
+                  </li>
+                </ul>
+              </li>
+              <li>
+                <span class="directory">/etc/vservers/<span class="symbolic">vserver-name</span>/<span class="">apps</span>/<span class="">vunify</span></span>
+                <br />
+                <div class="description">
+This directory contains configuration data required for vserver
+unification.
+        </div>
+                <ul>
+                  <li>
+                    <span class="list" title="/etc/vservers/$vserver-name/apps/vunify/exclude">exclude</span>
+                    <br />
+                    <div class="description">
+<div>Static list of files which are excluded for unification. This list
+supports an rsync-like syntax: when a file is prefixed by '+', it is a
+candidate for unification; when there is no prefix or a '-' or a '~' it
+will be excluded. Shell-wildcards are allowed for the filenames.</div>
+<div>When used with <code class="tool">vcopy</code>, the '~' prefix prevents copying
+of the file entirely (e.g. for keyfiles). With this tool, the file will
+be copied instead of hardlinked when the '-' prefix is used.</div>
+          </div>
+                  </li>
+                  <li>
+                    <span class="boolean" title="/etc/vservers/$vserver-name/apps/vunify/pgkmgmt-force">pgkmgmt-force</span>
+                    <br />
+                    <div class="description">
+When existing, information from packagemanagement will be used to
+create dynamic exclude-lists. This option requires that (a known)
+packagemanagement is configured for the vserver; else the requested
+operation will fail. Most tools assume 'on' as the default value.
+          </div>
+                  </li>
+                  <li>
+                    <span class="boolean" title="/etc/vservers/$vserver-name/apps/vunify/pkgmgmt-ignore">pkgmgmt-ignore</span>
+                    <br />
+                    <div class="description">
+When existing, information from packagemanagement will not be used to
+create dynamic exclude-lists.
+          </div>
+                  </li>
+                  <li>
+                    <span class="symlink" title="/etc/vservers/$vserver-name/apps/vunify/$refserver.X">refserver.X</span>
+                    <br />
+                    <div class="description">
+These are symlinks to the configuration directory
+(e.g. CONFDIR/vservers/&lt;id&gt;) of a refserver. There may be
+multiple such symlinks but they must be prefixed by 'refserver.' and
+will be processed in alphanumerical order.
+          </div>
+                  </li>
+                  <li>
+                    <span class="directory">/etc/vservers/<span class="symbolic">vserver-name</span>/<span class="">apps</span>/<span class="">vunify</span>/<span class="">hash</span></span>
+                    <br />
+                    <div class="description">
+A directory which will be used as the storage place for the
+<code class="tool">vhashify</code> command.
+          </div>
+                    <ul>
+                      <li>
+                        <span class="symlink" title="/etc/vservers/$vserver-name/apps/vunify/hash/$id">id</span>
+                        <br />
+                        <div class="description">
+Points to a directory within the filesystems which are used for the
+vservers. There must be not more than one of such a directory per
+filesystem.
+            </div>
+                      </li>
+                      <li>
+                        <span class="file" title="/etc/vservers/$vserver-name/apps/vunify/hash/method">method</span>
+                        <br />
+                        <div class="description">The used hash method.</div>
+                      </li>
+                    </ul>
+                  </li>
+                </ul>
+              </li>
+            </ul>
+          </li>
+          <li>
+            <span class="directory">/etc/vservers/<span class="symbolic">vserver-name</span>/<span class="">interfaces</span></span>
+            <br />
+            <ul>
+              <li>
+                <span class="file" title="/etc/vservers/$vserver-name/interfaces/bcast">bcast</span>
+                <br />
+                <div class="description">The default broadcast address.</div>
+              </li>
+              <li>
+                <span class="file" title="/etc/vservers/$vserver-name/interfaces/dev">dev</span>
+                <br />
+                <div class="description">The default network device.</div>
+              </li>
+              <li>
+                <span class="file" title="/etc/vservers/$vserver-name/interfaces/mask">mask</span>
+                <br />
+                <div class="description">The default network mask.</div>
+              </li>
+              <li>
+                <span class="file" title="/etc/vservers/$vserver-name/interfaces/prefix">prefix</span>
+                <br />
+                <div class="description">The default network prefix-length.</div>
+              </li>
+              <li>
+                <span class="file" title="/etc/vservers/$vserver-name/interfaces/scope">scope</span>
+                <br />
+                <div class="description">The default scope of the network interfaces.</div>
+              </li>
+              <li>
+                <span class="directory">/etc/vservers/<span class="symbolic">vserver-name</span>/<span class="">interfaces</span>/<span class="symbolic">iface</span></span>
+                <br />
+                <div class="description">
+'iface' is an arbitrary name for the interface; the value itself is
+not important but may be interesting regarding interface-creation and
+usage with <code class="tool">chbind</code>. Both happens in alphabetical order and
+numbers like '00' are good names for these directories.
+        </div>
+                <ul>
+                  <li>
+                    <span class="file" title="/etc/vservers/$vserver-name/interfaces/$iface/bcast">bcast</span>
+                    <br />
+                    <div class="description">The broadcast address.</div>
+                  </li>
+                  <li>
+                    <span class="file" title="/etc/vservers/$vserver-name/interfaces/$iface/dev">dev</span>
+                    <br />
+                    <div class="description">The network device.</div>
+                  </li>
+                  <li>
+                    <span class="boolean" title="/etc/vservers/$vserver-name/interfaces/$iface/disabled">disabled</span>
+                    <br />
+                    <div class="description">When this file exists, this interface will be ignored.</div>
+                  </li>
+                  <li>
+                    <span class="file" title="/etc/vservers/$vserver-name/interfaces/$iface/ip">ip</span>
+                    <br />
+                    <div class="description">The ip which will be assigned to this interface.</div>
+                  </li>
+                  <li>
+                    <span class="file" title="/etc/vservers/$vserver-name/interfaces/$iface/mask">mask</span>
+                    <br />
+                    <div class="description">The network mask.</div>
+                  </li>
+                  <li>
+                    <span class="file" title="/etc/vservers/$vserver-name/interfaces/$iface/name">name</span>
+                    <br />
+                    <div class="description">
+When this file exists, the interface will be named with the text in
+this file. Without such an entry, the IP will not be shown by
+<code class="tool">ifconfig</code> but by <code class="command">ip addr ls</code> only.  Such
+a labeled interface is known as an "alias" also (e.g. 'eth0:foo').
+          </div>
+                  </li>
+                  <li>
+                    <span class="boolean" title="/etc/vservers/$vserver-name/interfaces/$iface/nodev">nodev</span>
+                    <br />
+                    <div class="description">
+When this file exists, the interface will be assumed to exist
+already. This can be used to assign primary interfaces which are
+created by the host or another vserver.
+         </div>
+                  </li>
+                  <li>
+                    <span class="file" title="/etc/vservers/$vserver-name/interfaces/$iface/prefix">prefix</span>
+                    <br />
+                    <div class="description">The network prefix-length.</div>
+                  </li>
+                  <li>
+                    <span class="file" title="/etc/vservers/$vserver-name/interfaces/$iface/scope">scope</span>
+                    <br />
+                    <div class="description">The scope of the network interface.</div>
+                  </li>
+                </ul>
+              </li>
+            </ul>
+          </li>
+          <li>
+            <span class="directory">/etc/vservers/<span class="symbolic">vserver-name</span>/<span class="">rlimits</span></span>
+            <br />
+            <div class="description">
+A directory with resource limits. Possible resources are cpu, fsize,
+data, stack, core, rss, nproc, nofile, memlock, as and locks. This
+configuration will be honored for kernel 2.6 only.
+      </div>
+            <ul>
+              <li>
+                <span class="file" title="/etc/vservers/$vserver-name/rlimits/$resource">resource</span>
+                <br />
+                <div class="description">
+A file which contains the hard- and soft-limit of the given resource
+in the first line. The special keyword 'inf' is recognized.
+       </div>
+              </li>
+              <li>
+                <span class="file" title="/etc/vservers/$vserver-name/rlimits/$resource.hard">resource.hard</span>
+                <br />
+                <div class="description">
+A file which contains the hard- of the given resource in the first
+line. The special keyword 'inf' is recognized.
+       </div>
+              </li>
+              <li>
+                <span class="file" title="/etc/vservers/$vserver-name/rlimits/$resource.min">resource.min</span>
+                <br />
+                <div class="description">
+A file which contains the guaranted minimum of the given resource in
+the first line. The special keyword 'inf' is recognized.
+        </div>
+              </li>
+              <li>
+                <span class="file" title="/etc/vservers/$vserver-name/rlimits/$resource.soft">resource.soft</span>
+                <br />
+                <div class="description">
+A file which contains the soft- of the given resource in the first
+line. The special keyword 'inf' is recognized.
+       </div>
+              </li>
+            </ul>
+          </li>
+          <li>
+            <span class="directory">/etc/vservers/<span class="symbolic">vserver-name</span>/<span class="">scripts</span></span>
+            <br />
+            <div class="description">
+A directory for scripts. By default, when one of these scripts will be
+executed, the execution of defaultscripts (within .../.defaults/scripts)
+will be skipped. To execute them nevertheless, the $DONT_SKIP_DEFAULTS
+environment variable must be set by one of the in-shellcontext scripts
+(the non-executable ones).
+      </div>
+            <ul>
+              <li>
+                <span class="script" title="/etc/vservers/$vserver-name/scripts/post-start">post-start</span>
+                <br />
+                <div class="description">
+The scriptlet which will be executed after the vserver has been
+started. Before executing the script, the vserver root directory
+will be made the working directory.
+        </div>
+              </li>
+              <li>
+                <span class="script" title="/etc/vservers/$vserver-name/scripts/post-stop">post-stop</span>
+                <br />
+                <div class="description">
+The scriptlet which will be executed after the vserver has been
+stopped, but before the directories will be umounted and the the
+interfaces disabled. Before executing the script, the vserver root
+directory will be made the working directory.
+        </div>
+              </li>
+              <li>
+                <span class="script" title="/etc/vservers/$vserver-name/scripts/postpost-stop">postpost-stop</span>
+                <br />
+                <div class="description">
+The scriptlet which will be executed after the vserver has been stopped
+completely. Before executing the script, the vserver root directory
+will be made the working directory.
+        </div>
+              </li>
+              <li>
+                <span class="script" title="/etc/vservers/$vserver-name/scripts/pre-start">pre-start</span>
+                <br />
+                <div class="description">
+The scriptlet which will be executed after network-interfaces were
+enabled and the directories mounted, but before the vserver itself has
+been started.  Before executing the script, the vserver root directory
+will be made the working directory.
+        </div>
+              </li>
+              <li>
+                <span class="script" title="/etc/vservers/$vserver-name/scripts/pre-stop">pre-stop</span>
+                <br />
+                <div class="description">
+The scriptlet which will be executed before the vserver will be
+stopped. Before executing the script, the vserver root directory
+will be made the working directory.
+        </div>
+              </li>
+              <li>
+                <span class="script" title="/etc/vservers/$vserver-name/scripts/prepre-start">prepre-start</span>
+                <br />
+                <div class="description">
+The scriptlet which will be executed before the network-interfaces are
+enabled and the directories are mounted. Before executing the script,
+the configuration directory will be made the working directory.
+        </div>
+              </li>
+              <li>
+                <span class="directory">/etc/vservers/<span class="symbolic">vserver-name</span>/<span class="">scripts</span>/<span class="">post-start.d</span></span>
+                <br />
+                <div class="description">
+Repository of post-start like scripts. Before executing these scripts,
+the vserver root directory will be made the working directory.
+        </div>
+                <ul>
+                  <li>
+                    <span class="script" title="/etc/vservers/$vserver-name/scripts/post-start.d/$script">script</span>
+                    <br />
+                    <div class="description">See post-start.</div>
+                  </li>
+                </ul>
+              </li>
+              <li>
+                <span class="directory">/etc/vservers/<span class="symbolic">vserver-name</span>/<span class="">scripts</span>/<span class="">post-stop.d</span></span>
+                <br />
+                <div class="description">
+Repository of post-stop like scripts. Before executing the script, the
+vserver root directory will be made the working directory.
+        </div>
+                <ul>
+                  <li>
+                    <span class="script" title="/etc/vservers/$vserver-name/scripts/post-stop.d/$script">script</span>
+                    <br />
+                    <div class="description">See post-stop.</div>
+                  </li>
+                </ul>
+              </li>
+              <li>
+                <span class="directory">/etc/vservers/<span class="symbolic">vserver-name</span>/<span class="">scripts</span>/<span class="">postpost-stop.d</span></span>
+                <br />
+                <div class="description">
+Repository of postpost-stop like scripts. Before executing the script,
+the vserver root directory will be made the working directory.
+        </div>
+                <ul>
+                  <li>
+                    <span class="script" title="/etc/vservers/$vserver-name/scripts/postpost-stop.d/$script">script</span>
+                    <br />
+                    <div class="description">See postpost-stop.</div>
+                  </li>
+                </ul>
+              </li>
+              <li>
+                <span class="directory">/etc/vservers/<span class="symbolic">vserver-name</span>/<span class="">scripts</span>/<span class="">pre-start.d</span></span>
+                <br />
+                <div class="description">
+Repository of pre-start like scripts. Before executing these scripts,
+the vserver root directory will be made the working directory.
+        </div>
+                <ul>
+                  <li>
+                    <span class="script" title="/etc/vservers/$vserver-name/scripts/pre-start.d/$script">script</span>
+                    <br />
+                    <div class="description">See pre-start.</div>
+                  </li>
+                </ul>
+              </li>
+              <li>
+                <span class="directory">/etc/vservers/<span class="symbolic">vserver-name</span>/<span class="">scripts</span>/<span class="">pre-stop.d</span></span>
+                <br />
+                <div class="description">
+Repository of pre-stop like scripts. Before executing the script, the
+vserver root directory will be made the working directory.
+        </div>
+                <ul>
+                  <li>
+                    <span class="script" title="/etc/vservers/$vserver-name/scripts/pre-stop.d/$script">script</span>
+                    <br />
+                    <div class="description">See pre-stop.</div>
+                  </li>
+                </ul>
+              </li>
+              <li>
+                <span class="directory">/etc/vservers/<span class="symbolic">vserver-name</span>/<span class="">scripts</span>/<span class="">prepre-start.d</span></span>
+                <br />
+                <div class="description">
+Repository of prepre-start like scripts.  Before executing the script,
+the configuration directory will be made the working directory.
+        </div>
+                <ul>
+                  <li>
+                    <span class="script" title="/etc/vservers/$vserver-name/scripts/prepre-start.d/$script">script</span>
+                    <br />
+                    <div class="description">See prepre-start.</div>
+                  </li>
+                </ul>
+              </li>
+            </ul>
+          </li>
+          <li>
+            <span class="directory">/etc/vservers/<span class="symbolic">vserver-name</span>/<span class="">ulimits</span></span>
+            <br />
+            <div class="description">
+A directory with ulimits. Possible resources are cpu, data, fsize,
+locks, memlock, nofile, nproc, rss and/or stack. This configuration
+will be honored for kernel 2.4 only.
+      </div>
+            <ul>
+              <li>
+                <span class="file" title="/etc/vservers/$vserver-name/ulimits/$resource">resource</span>
+                <br />
+                <div class="description">
+A file which contains the hard- and soft-limit of the given resource
+in the first line. The special keyword 'inf' is recognized.
+       </div>
+              </li>
+              <li>
+                <span class="file" title="/etc/vservers/$vserver-name/ulimits/$resource.hard">resource.hard</span>
+                <br />
+                <div class="description">
+A file which contains the hard- of the given resource in the first
+line. The special keyword 'inf' is recognized.
+       </div>
+              </li>
+              <li>
+                <span class="file" title="/etc/vservers/$vserver-name/ulimits/$resource.soft">resource.soft</span>
+                <br />
+                <div class="description">
+A file which contains the soft- of the given resource in the first
+line. The special keyword 'inf' is recognized.
+       </div>
+              </li>
+            </ul>
+          </li>
+          <li>
+            <span class="directory">/etc/vservers/<span class="symbolic">vserver-name</span>/<span class="">uts</span></span>
+            <br />
+            <ul>
+              <li>
+                <span class="file" title="/etc/vservers/$vserver-name/uts/context">context</span>
+                <br />
+                <div class="description">
+The context-name of the vserver. This file is listed for completeness
+only; the 'context' name is used and set internally by the util-vserver
+tools and can *not* be modified.
+       </div>
+              </li>
+              <li>
+                <span class="file" title="/etc/vservers/$vserver-name/uts/domainname">domainname</span>
+                <br />
+                <div class="description">The NIS domainname of the vserver</div>
+              </li>
+              <li>
+                <span class="file" title="/etc/vservers/$vserver-name/uts/machine">machine</span>
+                <br />
+                <div class="description">The machine-type of the vserver</div>
+              </li>
+              <li>
+                <span class="file" title="/etc/vservers/$vserver-name/uts/nodename">nodename</span>
+                <br />
+                <div class="description">The node-/hostname of the vserver</div>
+              </li>
+              <li>
+                <span class="file" title="/etc/vservers/$vserver-name/uts/release">release</span>
+                <br />
+                <div class="description">The OS-release of the vserver</div>
+              </li>
+              <li>
+                <span class="file" title="/etc/vservers/$vserver-name/uts/sysname">sysname</span>
+                <br />
+                <div class="description">The sysname of the vserver</div>
+              </li>
+              <li>
+                <span class="file" title="/etc/vservers/$vserver-name/uts/version">version</span>
+                <br />
+                <div class="description">The OS-version of the vserver</div>
+              </li>
+            </ul>
+          </li>
+        </ul>
+      </li>
+    </ul>
+  </body>
+</html>