[Fai-commit] r3047 - in trunk: debian doc

fai-repository at svn.debian.org fai-repository at svn.debian.org
Fri Nov 11 15:48:10 UTC 2005 

Author: lange
Date: 2005-11-11 15:48:09 +0000 (Fri, 11 Nov 2005)
New Revision: 3047

Modified:
   trunk/debian/changelog
   trunk/doc/fai-guide.sgml
Log:
minor fixes to fai guide, closes 332318


Modified: trunk/debian/changelog
===================================================================
--- trunk/debian/changelog	2005-11-11 15:44:31 UTC (rev 3046)
+++ trunk/debian/changelog	2005-11-11 15:48:09 UTC (rev 3047)
@@ -17,8 +17,8 @@
   * fai-mirror: add -i to egrep (closes: #312508)
   * fai-do-scripts: do not execute S[0-9][0-9]* any more (closes: #310999)
   * fcopy: add preinst support, fix for inforing .svn dirs (closes: #297550)
-  * fai-guide.sgml: include README.disk_config into fai guide
-    (closes: #332295) 
+  * fai-guide.sgml: include README.disk_config into fai guide, minor fixes,
+    (closes: #332295, 332318)
   * fix typos (closes: #332291)
   
  -- Thomas Lange <lange at debian.org>  Fri, 11 Nov 2005 15:45:15 +0100

Modified: trunk/doc/fai-guide.sgml
===================================================================
--- trunk/doc/fai-guide.sgml	2005-11-11 15:44:31 UTC (rev 3046)
+++ trunk/doc/fai-guide.sgml	2005-11-11 15:48:09 UTC (rev 3047)
@@ -26,7 +26,7 @@
       <title>FAI Guide (Fully Automatic Installation)
 
       <author>Thomas Lange <email>lange at informatik.uni-koeln.de</email>
-      <version>FAI Guide version &version;, &date for FAI package version &faiver;
+      <version>FAI Guide version &version;, &date; for FAI package version &faiver;
 
 <abstract>
 This manual describes the fully automatic installation package for
@@ -49,7 +49,7 @@
 General Public License for more details.
 	<p>
 A copy of the GNU General Public License is available as &file-GPL; in
-the &dgl distribution or on the World Wide Web at <url id="&url-gpl;"
+the &dgl; distribution or on the World Wide Web at <url id="&url-gpl;"
 	name="the GNU website">. You can also obtain it by 
 writing to the &fsf-addr;.
 
@@ -57,10 +57,10 @@
 
 <chapt id="intro">Introduction<p>
 <sect id="availability">Availability<p>
-The homepage of FAI is <url id="&faiwww">.
+The homepage of FAI is <url id="&faiwww;">.
 There you will find information about FAI, for example the mailing
 list archive. The FAI package is also available as a Debian package from
-<url id="&faidownload">;. It's an official Debian package and is available from
+<url id="&faidownload;">. It's an official Debian package and is available from
 all Debian mirrors. To access the newest versions of the FAI packages,
 you can add the following line to your <file>/etc/apt/sources.list</file> file.
 
@@ -132,7 +132,7 @@
 
 <sect id="overview">Overview and concepts<p>
 <p>
-FAI is a non-interactive system to install a &dgl operating system
+FAI is a non-interactive system to install a &dgl; operating system
 unattended on
 a single computer or a whole cluster. You can take one or more virgin
 PCs, turn on the power and after a few minutes Linux is installed,
@@ -204,7 +204,7 @@
 <p>
 FAI can also be used as a network rescue system. You can boot your
 computer, but it will not perform an installation. Instead it will run a
-fully functional &dgl without using the local hard disks. Then you can
+fully functional &dgl; without using the local hard disks. Then you can
 do a remote login and backup or restore a disk partition, check a filesystem,
 inspect the hardware or do any other task.
 
@@ -262,7 +262,10 @@
 <item><p>When using PXE, tell the install client to boot the install
   kernel and perform an installation during the next boot <example>fai-chboot -IFv demohost</example>
 </p></item>
-<item><p>If you want to try FAI without setting up a PXE+DNS+DHCP-Environment: put the hostnames into /etc/hosts inside the nfsroot and use a bootfloppy/CD/DVD to boot the client. See <tt>man make-fai-bootfloppy</tt>
+<item><p>If you want to try FAI without setting up a PXE+DNS+DHCP-Environment:
+put the hostnames into <file>/etc/hosts</file> inside the nfsroot and use
+a bootfloppy/CD/DVD to boot the client.
+See <manref name="make-fai-bootfloppy" section="8">
 <item><p>Boot your demo host and enjoy the fully automatic installation.</p></item>
 <item><p>If the installation has finished successfully, the computer should boot a
 small Debian system. You can login as user <tt>demo</tt> or <tt>root</tt> with password <tt>fai</tt>.</p></item>
@@ -350,7 +353,7 @@
 which contains the install kernels for FAI. You can install both
 packages using
 
-&packageinstall
+&packageinstall;
 
 If you would like to install all recommended packages that are useful for
 fai, use the following command
@@ -454,17 +457,17 @@
 
 FAI uses <manref name="apt-get" section="8"> to create the nfsroot
 filesystem in <file>/usr/lib/fai/nfsroot</file>. It needs about
-&nfsrootsize of free disk space. Before setting up FAI, you should get
+&nfsrootsize; of free disk space. Before setting up FAI, you should get
 the program <prgn>imggen</prgn>,<footnote>Available at the download
 page <httpsite>www.ltsp.org</httpsite> or from the FAI download
 page &faidownload;.</footnote> if you like to boot from a 3Com network
 card. This executable converts netboot images created by <manref
 name="mknbi-linux" section="8">, so they can be booted by network
 cards from 3Com. Put that executable in your path
-(e.g. <file>/usr/local/bin</file>). After editing &fc; and &mfnc call
+(e.g. <file>/usr/local/bin</file>). After editing &fc; and &mfnc; call
 <prgn>fai-setup</prgn>.
 
-&faisetup
+&faisetup;
 
 <p>
 A complete log of fai-setup is available on the fai web page.
@@ -509,7 +512,7 @@
 </example>
 
 <p>
-The setup also creates the account <tt>fai</tt> (defined by $LOGUSER)
+The setup also creates the account <tt>fai</tt> (defined by <var>$LOGUSER</var>)
 if not already available. So you can add a user before calling <manref
 name="fai-setup" section="8"> using the command
 <manref name="adduser" section="8"> and use this as your local account
@@ -843,7 +846,7 @@
 These are the messages when booting from floppy disk.
 <example>
 GRUB loading stage2..............
-&lt now the grub menu with multiple boot options is displayed &gt;
+&lt; now the grub menu with multiple boot options is displayed &gt;
 BOOTING 'FAI-BOTH'
 kernel (fd0)/vmlinuz-2.4.27 root=/dev/nfs ip=both
   [Linux-bzImage, setup=0x1400, size=0xd8450]
@@ -857,9 +860,9 @@
 After this, the rest of the boot messages will be equal to those when booting from
 network card. When booting from network card with PXE you will see:
 
-&bootexample
+&bootexample;
 
-When the copyright message of fai is shown, the install client has mounted
+When the copyright message of FAI is shown, the install client has mounted
 the nfsroot<footnote> <p><file>/usr/lib/fai/nfsroot</file> from the
 install server</p> </footnote> to the clients' root directory
 <file>/</file>. This is the whole filesystem for the client at this
@@ -868,7 +871,7 @@
 After <tt>task_confdir</tt> is executed, the configuration space is
 mounted or received from a CVS repository.
 
-Before the installation is started (FAI_ACTION=install) the computer
+Before the installation is started (<var>FAI_ACTION=install</var>) the computer
 beeps three times. So, be watchful when you hear three beeps
 but you do not want to perform an installation!
 
@@ -952,7 +955,8 @@
 without using the local hard disk. Use this as a rescue system if
 your local disk is damaged or the computer can't boot properly from
 hard disk. You will get a shell and you can execute various commands
-(dmesg, lsmod, df, lspci, ...). Look at the log file in
+(<prgn>dmesg</prgn>, <prgn>lsmod</prgn>, <prgn>df</prgn>,
+<prgn>lspci</prgn>, ...). Look at the log file in
 <file>/tmp/fai</file>. There you can find much information about the boot
 process.
 
@@ -1533,7 +1537,7 @@
 define the corresponding global variables. This is an example for this
 log file when using a DHCP server.
 
-&bootlog
+&bootlog;
 
 Additional information is passed via the kernel command line or read
 from &fc;. When booting with PXE, command line parameters are created using <manref
@@ -2294,7 +2298,7 @@
 computer installed with Debian. If you already have a host running
 Debian, you can also install the master server via FAI. Create a
 partition on <file>/files/scratch/debmirror</file> for the local
-Debian mirror with more than &mirrorsize GB space available.
+Debian mirror with more than &mirrorsize; GB space available.
 
 <sect1 id=beonetworkmaster> Set up the network<p>
 
@@ -2370,7 +2374,7 @@
 <file>/files/scratch/debmirror</file> using
 <prgn>mkdebmirror</prgn>. You can add the option <tt>--debug</tt> to
 see which files are received. This will
-need about &mirrorsize GB disk space for Debian 3.0 (aka woody). Export this
+need about &mirrorsize; GB disk space for Debian 3.0 (aka woody). Export this
 directory to the netgroup <tt>@faiclients</tt> read only.
 Here's the line for <file>/etc/exports</file>
 <p><tt>/files/scratch/debmirror *(ro)</tt>
@@ -2603,7 +2607,7 @@
 further documentation to find the optimal solution in your
 environment</footnote>. </p>
 
-<p>The relevant variables in &fc and &mfnc; for CVS are:
+<p>The relevant variables in &fc; and &mfnc; for CVS are:
 <taglist>
   <tag><var>FAI_LOCATION</var></tag>
     <item>

More information about the Fai-commit mailing list