added formerly missing 'v_gated' registration
[util-vserver.git] / util-vserver / doc / configuration.xml
index 2f327fa..c72b9fe 100644 (file)
@@ -1,5 +1,5 @@
 <?xml version="1.0"?>
-<!DOCTYPE cfgdirdoc SYSTEM "cfgdirdoc.dtd" [
+<!DOCTYPE cfgdirdoc SYSTEM "configuration.dtd" [
 <!ENTITY init-scriptlet-params
          "<params>
            <param id='vserver-dir'>
@@ -30,9 +30,8 @@
                             completely.">
 ]>
 
-
 <cfgdirdoc>
-  <topleveldir path="@CONFDIR@">
+  <topleveldir type="confdir">
     <description>The base configuration directory.</description>
 
     <dir name=".defaults" type="fixed" optional="yes">
          <file name="files">
            <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.</description>
+           it overrides the defaults in SYSDEFAULTDIR/vprocunhide-files. The entries there must be
+           absolute filenames inclusive the leading '/proc'.</description>
+         </file>
+       </dir>
+
+       <dir name="init" type="fixed">
+         <symlink name="tty">
+           <description>A symlink to the TTY device where input/output will be redirected from/to
+           at startup via initscript.</description>
+         </symlink>
+       </dir>
+
+       <dir name="vunify" type="fixed">
+         <file name="exclude">
+           <description>Static list of excluded files.</description>
          </file>
        </dir>
       </dir>
        </file>
 
        <file name="apt.conf">
-         <description>The default apt.conf which is going to be used .It overrides the apt.conf
-         from @CONFDIR@/.defaults/apps/pkgmgmt.</description>
+         <description>The default apt.conf which is going to be used. It overrides the apt.conf
+         from CONFDIR/.defaults/apps/pkgmgmt.</description>
        </file>
 
        <script name="initpre">
       </file>
 
       <file name="fstab">
-       <description>The fstab file for the vserver.</description>
+       <description>The fstab file for the vserver. Entries in this file will be mounted within the
+       network context of the vserver; this means that mount will be called as 'chbind &lt;options&gt;
+       mount ...'. Use the 'fstab.local' file when you do not want this behavior, but in most cases
+       the 'fstab' file should be used.</description>
+      </file>
+
+      <file name="fstab.local">
+       <description>The fstab file for the vserver. In opposite to the normal 'fstab' file, the
+       mounting happens in the local network context. Currently there is no way to mix entries of
+       both files; 'fstab' will be always processed before 'fstab.local'.</description>
       </file>
       
       <dir name="apps" type="fixed">
          </file>
 
          <file name="style">
-           <description>Contains the init-style; possible values are 'sysv', 'plain' and
-           'minit'.</description>
+           <description>Contains the init-style; possible values are 'sysv', 'plain', 'minit' and
+           'gentoo'.</description>
          </file>
 
          <file name="runlevel">
          <file name="sync">
            <description>Without this file, the 'cmd.*-sync' files will be ignored.</description>
          </file>
+
+         <symlink name="tty">
+           <description>A symlink to the TTY device where input/output will be redirected from/to
+           at startup via initscript.</description>
+         </symlink>
+
+         <file name="mark">
+           <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'.</description>
+         </file>
+
+         <file name="depends">
+           <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).</description>
+         </file>
+       </dir> <!-- ...apps/init -->
+
+       <dir name="vunify" type="fixed">
+         <description>This directory contains configuration data required for vserver
+         unification.</description>
+         
+         <file name="exclude">
+           <description>Static list of excluded files. This list supports an rsync syntax: when a
+           file is prefixed by '+', it is a candidate for unification; when there is no prefix or a
+           '-' it will be excluded. Shell-wildcards are allowed for the filenames.</description>
+         </file>
+
+         <symlink name="refserver.X">
+           <description>These are symlinks to the configuration directory
+           (e.g. CONFDIR/vservers/&lt;idgt;) of a refserver. There may be multiple such symlinks
+           but they must be prefixed by 'refserver.' and will be processed in alphanumerical
+           order.</description>
+         </symlink>
        </dir>
       </dir>
 
            <description>&init-dir-script-text; &init-pre-start;</description>
            &init-scriptlet-params;
          </script>
-         
        </dir>
 
        <script name="post-start">
        </file>
 
        <dir name="iface" type="symbolic">
+         <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 'chbind'. Both happens in
+         alphabetical order and numbers like '00' are good names for these directories.</description>
+         
          <file name="disabled">
            <description>When this file exists, this interface will be ignored.</description>
          </file>
            <description>The network-mask.</description>
          </file>
          <file name="scope">
-           <description>The scope of the network interfaces.</description>
+           <description>The scope of the network interface.</description>
          </file>
          <file name="name">
-           <description>When this file exists, the interface will be named.</description>
+           <description>When this file exists, the interface will be named with the text in this file.</description>
+         </file>
+         <file name="nodev">
+           <description>When this file exists, the interface will be assumed to exist already. A
+           former name for this flag was 'only_ip' which is deprecated now.</description>
          </file>
        </dir>
       </dir>
          special keyword 'inf' is recognized.</description>
        </file>
       </dir>
+
+      <dir name="rlimits" type="fixed">
+       <description>see ulimits</description>
+      </dir>
+
+      <dir name="uts" type="fixed">
+       <file name="context">
+         <description>The context-name of the vserver</description>
+       </file>
+       <file name="sysname">
+         <description>The sysname of the vserver</description>
+       </file>
+       <file name="nodename">
+         <description>The node-/hostname of the vserver</description>
+       </file>
+       <file name="release">
+         <description>The OS-release of the vserver</description>
+       </file>
+       <file name="version">
+         <description>The OS-version of the vserver</description>
+       </file>
+       <file name="machine">
+         <description>The machine-type of the vserver</description>
+       </file>
+       <file name="domainname">
+         <description>The NIS domainname of the vserver</description>
+       </file>
+      </dir>
     </dir>
   </topleveldir>
 </cfgdirdoc>