added some explicit '--'
[util-vserver.git] / util-vserver / doc / configuration.xml
index b86fec8..04b78db 100644 (file)
@@ -74,7 +74,8 @@
          <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>
 
            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>
     </dir>
 
       </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">
            <description>A symlink to the TTY device where input/output will be redirected from/to
            at startup via initscript.</description>
          </symlink>
+       </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>
 
        </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 with the text in this file.</description>