version 0.30.209
[util-vserver.git] / util-vserver / doc / configuration.xml
index 941ec37..f0563ba 100644 (file)
@@ -25,8 +25,8 @@ Disable namespace usage globally. It can be overridden for a single vserver
 by setting the <optionref ref="global-namespace">namespace</optionref> flag
 there.
 
-In this mode the /vservers directory must have the 'barrier'
-attribute. Else, common chroot(2) exploits are possible.
+In this mode the <directory>/vservers</directory> directory must have
+the 'barrier' attribute. Else, common chroot(2) exploits are possible.
       </description>
     </boolean>
 
@@ -73,7 +73,7 @@ from this uri and install it at a temporary place.
          <description>
 The file where output will be logged to when <tool>vshelper</tool>
 is invoked from the kernel. This should point somewhere e.g. into
-/var/log.
+<directory>/var/log</directory>.
           </description>
        </link>
 
@@ -178,7 +178,8 @@ operation will fail. Most tools assume 'on' as the default value.
       </scalar>
       <collection name="yum">
        <description>
-The default, yum-related content of the /etc directory.
+The default, yum-related content of the <directory>/etc</directory>
+directory.
         </description>
        <scalar name="yum.conf">
          <description>
@@ -253,19 +254,19 @@ distribution.
       
       <collection name="apt">
        <description>
-Default content of the /etc/apt/ directory.
+Default content of the <directory>/etc/apt/</directory> directory.
         </description>
       </collection>
       
       <collection name="rpm">
        <description>
-Default content of the /etc/rpm directory.
+Default content of the <directory>/etc/rpm</directory> directory.
         </description>
       </collection>
       
       <link name="rpmlib">
        <description>
-Directory which overrides /usr/lib/rpm.
+Directory which overrides <directory>/usr/lib/rpm</directory>.
         </description>
       </link>
       <link name="execdir">
@@ -323,8 +324,8 @@ namespace usage for the current vserver.
       <description>
 Disables namespace usage for the current vserver.
 
-In this mode the /vservers directory must have the 'barrier'
-attribute. Else, common chroot(2) exploits are possible.
+In this mode the <directory>/vservers</directory> directory must have
+the 'barrier' attribute. Else, common chroot(2) exploits are possible.
       </description>
     </boolean>
 
@@ -341,6 +342,9 @@ 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.
+
+See the <ulink url="http://linux-vserver.org/Scheduler+Parameters">Linux
+VServer Wiki</ulink> for more information about this file.
       </description>
       <keys>
        <key id="fill_rate" name="fill-rate">
@@ -399,12 +403,21 @@ Contains the pathname of the shell which will be used by the "vserver
 ... enter" command.
       </description>
     </scalar>
+    <list name="personality">
+      <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
+<filename>/usr/include/linux/personality.h</filename> for possible
+values.
+      </description>
+    </list>
     <list name="flags">
       <description>
 Contains per line a flag. See <ulink
 url="http://savannah.nongnu.org/cgi-bin/viewcvs/util-vserver/util-vserver/lib/cflags-v13.c?rev=HEAD">lib/cflags-v13.c</ulink>
 for possible values.
       </description>
+      <!--
       <elements>
        <element name="fakeinit">
          <description>
@@ -442,27 +455,28 @@ Apply the current ulimit to the whole context
           </description>
        </element>
       </elements>
+      -->
     </list>
     <scalar name="context">
       <description>
 Contains the context which shall be used for the vserver.
         </description>
     </scalar>
-    <data name="fstab">
+    <data id="fstab" name="fstab">
       <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 <command>chbind &lt;options&gt; mount ...</command>. Use
-the 'fstab.local' file when you do not want this behavior, but in most
-cases the 'fstab' file should be used.
+within the network context of the host. Use the
+<optionref>fstab.remote</optionref> file when you want that the
+mounting happens in the network context of the vserver. In most cases
+the 'fstab' file should be used.
       </description>
     </data>
-    <data name="fstab.local">
+    <data id="fstab.remote" name="fstab.remote">
       <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'.
+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 <command>chbind &lt;options&gt; mount ...</command>. See
+<optionref>fstab</optionref> also.
       </description>
     </data>
     
@@ -723,7 +737,8 @@ environment variable must be set by one of the in-shellcontext scripts
       <program name="prepre-start">
        <description>
 The scriptlet which will be executed before the network-interfaces are
-enabled and the directories are mounted."
+enabled and the directories are mounted. Before executing the script,
+the configuration directory will be made the working directory.
         </description>
        <parameterList>
          <parameter name="vserver-dir">
@@ -745,7 +760,8 @@ The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
       </program>
       <collection name="prepre-start.d">
        <description>
-Repository of prepre-start like scripts
+Repository of prepre-start like scripts.  Before executing the script,
+the configuration directory will be made the working directory.
         </description>                                                                                                                 
        <program name="script" type="symbolic">
          <description>See prepre-start.</description>
@@ -773,7 +789,8 @@ The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
        <description>
 The scriptlet which will be executed after network-interfaces were
 enabled and the directories mounted, but before the vserver itself has
-been started.
+been started.  Before executing the script, the vserver root directory
+will be made the working directory.
         </description>
        <parameterList>
          <parameter name="vserver-dir">
@@ -795,7 +812,8 @@ The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
       </program>
       <collection name="pre-start.d">
        <description>
-Repository of pre-start like scripts
+Repository of pre-start like scripts. Before executing these scripts,
+the vserver root directory will be made the working directory.
         </description>                                                                                                                 
        <program name="script" type="symbolic">
          <description>See pre-start.</description>
@@ -820,7 +838,9 @@ The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
 
       <program name="post-start">
        <description>
-The scriptlet which will be executed after the vserver has been started.
+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.
         </description>
        <parameterList>
          <parameter name="vserver-dir">
@@ -837,7 +857,10 @@ The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
        </parameterList>
       </program>
       <collection name="post-start.d">
-       <description>Repository of post-start like scripts</description>
+       <description>
+Repository of post-start like scripts. Before executing these scripts,
+the vserver root directory will be made the working directory.
+        </description>
        <program name="script" type="symbolic">
          <description>See post-start.</description>
          <parameterList>
@@ -859,7 +882,9 @@ The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
 
       <program name="pre-stop">
        <description>
-The scriptlet which will be executed before the vserver will be stopped.
+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.
         </description>
        <parameterList>
          <parameter name="vserver-dir">
@@ -877,7 +902,8 @@ The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
       </program>
       <collection name="pre-stop.d">
        <description>
-Repository of pre-stop like scripts
+Repository of pre-stop like scripts. Before executing the script, the
+vserver root directory will be made the working directory.
         </description>                                                                                                                 
        <program name="script" type="symbolic">
          <description>See pre-stop.</description>
@@ -901,7 +927,8 @@ The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
        <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.
+interfaces disabled. Before executing the script, the vserver root
+directory will be made the working directory.
         </description>
        <parameterList>
          <parameter name="vserver-dir">
@@ -918,7 +945,10 @@ The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
        </parameterList>
       </program>
       <collection name="post-stop.d">
-       <description>Repository of post-stop like scripts</description>
+       <description>
+Repository of post-stop like scripts. Before executing the script, the
+vserver root directory will be made the working directory.
+        </description>
        <program name="script" type="symbolic">
          <description>See post-stop.</description>
          <parameterList>
@@ -940,7 +970,8 @@ The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
       <program name="postpost-stop">
        <description>
 The scriptlet which will be executed after the vserver has been stopped
-completely.
+completely. Before executing the script, the vserver root directory
+will be made the working directory.
         </description>
        <parameterList>
          <parameter name="vserver-dir">
@@ -957,7 +988,10 @@ The fixed value of the current action (e.g. 'prepre-start', 'post-stop'...).
        </parameterList>
       </program>
       <collection name="postpost-stop.d">
-       <description>Repository of postpost-stop like scripts</description>
+       <description>
+Repository of postpost-stop like scripts. Before executing the script,
+the vserver root directory will be made the working directory.
+        </description>
        <program name="script" type="symbolic">
          <description>See postpost-stop.</description>
          <parameterList>