[Pkg-uml-commit] r115 - trunk/src/rootstrap

[Mattia Dongili]

Author: malattia
Date: 2006-05-28 19:48:14 +0000 (Sun, 28 May 2006)
New Revision: 115

Modified:
   trunk/src/rootstrap/rootstrap.sgml
Log:
applied, edited and integrated patch from #294214

Modified: trunk/src/rootstrap/rootstrap.sgml
===================================================================
--- trunk/src/rootstrap/rootstrap.sgml	2006-05-28 19:12:40 UTC (rev 114)
+++ trunk/src/rootstrap/rootstrap.sgml	2006-05-28 19:48:14 UTC (rev 115)
@@ -129,8 +129,9 @@
 
     <para>
       The configuration file consists of sections, starting with a
-      "[section]" header, followed by "option: value" entries, with
-      continuations and such in the style of RFC 822.
+      "[section]" header, followed by "option=value" entries.
+      Long values are allowed to span multiple lines if
+      each continued line is indented with whitespace.
     </para>
 
     <para>
@@ -167,13 +168,24 @@
           <term>fstype</term>
           <listitem>
             <para>
-              The type of filesystem to create (ext2, ext3, reiserfs,
-              etc.)
+              The type of filesystem to create
+              (ext2, ext3, reiserfs, etc.)
+              This parameter is mandatory.
             </para>
           </listitem>
         </varlistentry>
 
         <varlistentry>
+          <term>PATH</term>
+          <listitem>
+            <para>
+              The PATH environment variable to pass to modules.
+              This parameter is mandatory.
+            </para>
+          </listitem>
+        </varlistentry>
+
+        <varlistentry>
           <term>initialsize</term>
           <listitem>
             <para>
@@ -182,6 +194,7 @@
               installed system as produced by the selected modules.
               It will be created sparsely, so additional space is not
               entirely allocated until it is used.
+              This parameter is mandatory.
             </para>
           </listitem>
         </varlistentry>
@@ -194,6 +207,7 @@
               megabytes).  The filesystem will be resized, if
               possible, to adjust the amount of free space to
               approximately this amount.
+              This parameter is optional.
             </para>
           </listitem>
         </varlistentry>
@@ -207,6 +221,7 @@
               the FILES section below, and passed environment
               variables based on the options set in the corresponding
               section of the configuration file.
+              This parameter is mandatory.
             </para>
           </listitem>
         </varlistentry>
@@ -220,6 +235,7 @@
 	      The shell will have the same environment as the failing script so
 	      you could simply invoke <command>sh -x /path/to/module</command>
 	      to see what's going wrong.
+              This parameter is optional.
             </para>
           </listitem>
         </varlistentry>
@@ -244,8 +260,10 @@
           <term>interface</term>
           <listitem>
             <para>
-              The name of the UML network interface to configure,
-              typically "eth0".  This parameter is mandatory.
+              The name of the network interface to configure
+              inside the UML virtual machine,
+              typically "eth0".
+              This parameter is mandatory.
               </para>
           </listitem>
         </varlistentry>
@@ -254,9 +272,10 @@
           <term>host</term>
           <listitem>
             <para>
-              The IP address of the host side of the interface (the
-              host on which rootstrap is run).  This parameter is
-              mandatory.
+              The IP address of the host side of the interface
+              (the host on which rootstrap is run),
+              as visible to the UML virtual machine.
+              This parameter is mandatory.
             </para>
           </listitem>
         </varlistentry>
@@ -276,7 +295,9 @@
           <listitem>
             <para>
               The type of virtual networking interface to be used.
-              Typically "tuntap".  This parameter is mandatory.
+              Typically "tuntap".
+              Other available transports are "slirp" and "daemon".
+              This parameter is mandatory.
             </para>
           </listitem>
         </varlistentry>
@@ -292,6 +313,16 @@
         </varlistentry>
 
         <varlistentry>
+          <term>hostname</term>
+          <listitem>
+            <para>
+              The host name to use for the created UML virtual machine.
+              This parameter is optional.
+            </para>
+          </listitem>
+        </varlistentry>
+
+        <varlistentry>
           <term>gateway</term>
           <listitem>
             <para>
@@ -301,6 +332,26 @@
           </listitem>
         </varlistentry>
 
+        <varlistentry>
+          <term>domain</term>
+          <listitem>
+            <para>
+	      The local domain name.
+            </para>
+          </listitem>
+        </varlistentry>
+
+        <varlistentry>
+          <term>nameserver</term>
+          <listitem>
+            <para>
+              The DNS server to use for domain name resolution inside
+              the UML virtual machine. This parameter is optional, but
+              useful if you do not have a name server running on the host.
+            </para>
+          </listitem>
+        </varlistentry>
+
       </variablelist>
 
     </refsect2>
@@ -491,6 +542,23 @@
   </refsect1>
 
   <refsect1>
+    <title>SEE ALSO</title>
+
+    <para>
+      <citerefentry>
+	<refentrytitle>debootstrap</refentrytitle><manvolnum>8</manvolnum>
+      </citerefentry>,
+      <citerefentry>
+	<refentrytitle>linux</refentrytitle><manvolnum>1</manvolnum>
+      </citerefentry>;
+      locally installed User-Mode Linux documentation or
+      <ulink url="http://user-mode-linux.sourceforge.net/">
+	http://user-mode-linux.sourceforge.net/
+      </ulink>
+    </para>
+  </refsect1>
+
+  <refsect1>
     <title>AUTHOR</title>
 
     <para>Rootstrap was written by &dhusername; &dhemail;</para>