[Fai-commit] r6324 - trunk/doc

[Michael Prokop]

Author: mika
Date: 2011-03-28 14:55:39 +0000 (Mon, 28 Mar 2011)
New Revision: 6324

Modified:
   trunk/doc/fai-guide.txt
Log:
fai-guide: adjusting quoting of variables like FAI_CONFIG_SRC for proper output

At least with recent toolchains (>=squeeze) we get
e.g. "FAI\_CONFIG\_SRC" rather than "FAI_CONFIG_SRC",
removing the "\" characters provide output as expected,
therefore remove all unnecessary "\" chars.



Modified: trunk/doc/fai-guide.txt
===================================================================
--- trunk/doc/fai-guide.txt	2011-03-28 12:40:17 UTC (rev 6323)
+++ trunk/doc/fai-guide.txt	2011-03-28 14:55:39 UTC (rev 6324)
@@ -375,7 +375,7 @@
 Create a file `sources.list(5)` in '/etc/fai/apt' which gives access
 to your Debian mirror. An example can be found in
 '/usr/share/doc/fai-doc/examples/etc'. Also add the IP-address of the
-HTTP server to the variable +$NFSROOT\_ETC\_HOSTS+ in
+HTTP server to the variable +$NFSROOT_ETC_HOSTS+ in
 'make-fai-nfsroot.conf' when the install clients have no DNS access.
 
 ////
@@ -417,13 +417,13 @@
 'make-fai-nfsroot.conf'. Edit these files before calling
 'fai-setup'. These are important variables in 'make-fai-nfsroot.conf':
 
-FAI\_DEBOOTSTRAP::
+FAI_DEBOOTSTRAP::
 For building the nfsroot there's the command called
 `debootstrap(8)`. It needs the location of a Debian mirror and the
 name of the distribution (etch, lenny, sid) for which the basic Debian
 system should be built.
 
-NFSROOT\_ETC\_HOSTS::
+NFSROOT_ETC_HOSTS::
 If you use HTTP or FTP access to the Debain mirror, add its IP-address
 and the name to this variable. For a Beowulf master node, add the name
 and IP-address of both networks to it. This variable is not needed
@@ -432,7 +432,7 @@
 
 These are important variables in 'fai.conf':
 
-FAI\_CONFIG\_SRC::
+FAI_CONFIG_SRC::
 This variables described how to access the configuration space on the
 install clients. It's an Universal Resource Identifier
 (URI). Currently supported methods are:
@@ -458,15 +458,15 @@
 checked. +tarfile+ will be extracted by `ftar(8)`, and thus needs to have
 a recognized suffix, such as .tar.gz.
 
-If +$FAI\_CONFIG\_SRC+ is undefined in 'fai.conf', then the default is
+If +$FAI_CONFIG_SRC+ is undefined in 'fai.conf', then the default is
 to use an NFS mount from the fai install server onto the install
-client. It's the same as +nfs://\`hostname\`/$FAI\_CONFIGDIR+ with the
+client. It's the same as +nfs://`hostname`/$FAI_CONFIGDIR+ with the
 host name determined on the install server. Remember that this
 directory must be exported to all install clients, so that all files
 can be read by root.
 
 
-FAI\_DEBMIRROR::
+FAI_DEBMIRROR::
 If you have NFS access to your local Debian mirror, specify the remote
 file system. It will be mounted to +$MNTPOINT+, which must also be
 defined. It's not needed if you use access via FTP or HTTP.
@@ -474,7 +474,7 @@
 A list of variables used by FAI can be found at
 http://wiki.fai-project.org/wiki/Variables.
 
-The content of '/etc/fai/apt/sources.list' and +$FAI\_DEBMIRROR+ are
+The content of '/etc/fai/apt/sources.list' and +$FAI_DEBMIRROR+ are
 used by the install server and also by the clients. If your install
 server has multiple network cards and different host names for each
 card (as for a Beowulf server), use the install server name which is
@@ -2690,7 +2690,7 @@
 ////
 
 - If your computer can't boot from the network card, you do not always
-need to boot from floppy. Add the class _FAI\_BOOTPART_ and FAI will
+need to boot from floppy. Add the class _FAI_BOOTPART_ and FAI will
 automatically create a lilo or grub entry for booting the FAI
 bootfloppy from this partition. So you can start the re-installation
 without a boot floppy. This will also make the test phase shorter,