r4753 - trunk/BOOK/introduction/welcome

randy at linuxfromscratch.org randy at linuxfromscratch.org
Thu Jul 21 14:49:03 PDT 2005


Author: randy
Date: 2005-07-21 15:49:02 -0600 (Thu, 21 Jul 2005)
New Revision: 4753

Modified:
   trunk/BOOK/introduction/welcome/askhelp.xml
   trunk/BOOK/introduction/welcome/conventions.xml
Log:
Various tagging and text modifications to the 'Conventions' and 'Asking for Help' pages

Modified: trunk/BOOK/introduction/welcome/askhelp.xml
===================================================================
--- trunk/BOOK/introduction/welcome/askhelp.xml	2005-07-21 21:03:06 UTC (rev 4752)
+++ trunk/BOOK/introduction/welcome/askhelp.xml	2005-07-21 21:49:02 UTC (rev 4753)
@@ -20,8 +20,8 @@
   you will find that most of the people on Internet Relay Chat (IRC) and on the
   mailing lists are willing to help you. An overview of the LFS mailing
   lists can be found in <xref linkend="intro-welcome-maillists"/>. To assist us
-  in diagnosing and solving your problem, include as much relevant information as
-  possible in your request for help.</para>
+  in diagnosing and solving your problem, include as much relevant information
+  as possible in your request for help.</para>
 
   <sect2>
     <title>Things to Check Prior to Asking</title>
@@ -31,30 +31,33 @@
     <itemizedlist>
       <listitem>
         <para>Is the hardware support compiled into the kernel or
-        available as a module to the kernel?  If it is a module, is it configured
-        properly in <filename>modules.conf</filename> and has it been loaded?  You
-        should use <command>lsmod</command> as root to see if it's loaded. Check the
-        <filename>sys.log</filename> or run <command>modprobe <driver>
-        </command> to review any error message.  If it loads properly, you may need
-        to add the <command>modprobe</command> to your boot scripts.</para>
+        available as a module to the kernel?  If it is a module, is it
+        configured properly in <filename>modules.conf</filename> and has it
+        been loaded?  You should use <command>lsmod</command> as the
+        <systemitem class='username'>root</systemitem> user to see if it's
+        loaded. Check the <filename>syslog.log</filename> or run
+        <command>modprobe <replaceable>[driver]</replaceable></command> to
+        review any error message. If it loads properly, you may need to add
+        the <command>modprobe</command> command to your boot scripts.</para>
       </listitem>
       <listitem>
         <para>Are your permissions properly set, especially for devices? LFS
         uses groups to make these settings easier, but it also adds the step of
         adding users to groups to allow access. A simple <command>moduser
-        -G audio <user></command> may be all that's necessary for that
-        user to have access to the sound system.  Any question that starts
-        out with "It works as root, but not as ..." requires a thorough review
-        of permissions prior to asking.</para>
+        -G audio <replaceable>[user]</replaceable></command> may be all that's
+        necessary for that user to have access to the sound system. Any question
+        that starts out with <quote>It works as root, but not as ...</quote>
+        requires a thorough review of permissions prior to asking.</para>
       </listitem>
       <listitem>
-        <para>BLFS liberally uses <filename>/opt/<package></filename>.
+        <para>BLFS liberally uses <filename
+        class='directory'>/opt/<replaceable>[package]</replaceable></filename>.
         The main objection to this centers around the need to expand your
         environment variables for each package placed there (e.g.,
-        PATH=$PATH:/opt/kde/bin).  In some cases, the package will walk you
-        through the changes, but some will not.  The section called "<ulink
-        url="beyond.html">Going Beyond BLFS</ulink>" is available to help
-        you check.</para>
+        PATH=$PATH:/opt/kde/bin). In most cases, the package instructions will
+        walk you through the changes, but some will not. The section called
+        <quote><ulink url="beyond.html">Going Beyond BLFS</ulink></quote> is
+        available to help you check.</para>
       </listitem>
     </itemizedlist>
 
@@ -91,7 +94,7 @@
     been asked if a little research was done prior to asking. The volunteers
     in the mailing list prefer not to be used as an alternative to doing
     reasonable research on your end.  In addition, the quality of your
-    experience with BLFS  is also greatly enhanced by this research, and
+    experience with BLFS is also greatly enhanced by this research, and
     the quality of volunteers is enhanced because they don't feel that their
     time has been abused, so they are far more likely to participate.</para>
 
@@ -105,4 +108,3 @@
   </sect2>
 
 </sect1>
-

Modified: trunk/BOOK/introduction/welcome/conventions.xml
===================================================================
--- trunk/BOOK/introduction/welcome/conventions.xml	2005-07-21 21:03:06 UTC (rev 4752)
+++ trunk/BOOK/introduction/welcome/conventions.xml	2005-07-21 21:49:02 UTC (rev 4753)
@@ -21,9 +21,9 @@
 <screen><userinput>./configure --prefix=/usr</userinput></screen>
 
   <blockquote>
-    <para>This form of text is designed to be typed exactly
-    as seen unless otherwise noted in the surrounding text.  It is also used
-    in the explanation sections to identify references to specific commands.</para>
+    <para>This form of text is designed to be typed exactly as seen unless
+    otherwise noted in the surrounding text. It is also used to identify
+    references to specific commands.</para>
   </blockquote>
 
 <screen><computeroutput>install-info: unknown option
@@ -58,8 +58,8 @@
 EOF</userinput></screen>
 
   <blockquote>
-    <para>This type of section is used mainly when creating
-    configuration files.  The first command (in bold) tells the system to create
+    <para>This type of section is used mainly when creating configuration
+    files.  The first command (in bold) tells the system to create
     the file <filename>$LFS/etc/group</filename> from whatever is typed on the
     following lines until the sequence EOF is encountered.
     Therefore, this whole section is generally typed as seen.</para>
@@ -69,7 +69,16 @@
 
   <blockquote>
     <para>This form of text is used to encapsulate text that should be
-    modified and is not to be typed as seen or copy and pasted.</para>
+    modified and is not to be typed as seen, or copy and pasted. Note that
+    the square brackets are not part of the text, but should be substituted
+    for as well.</para>
   </blockquote>
 
+  <para><systemitem class='username'>root</systemitem></para>
+
+  <blockquote>
+    <para>This form of text is used to show a specific system user reference
+    in the instructions.</para>
+  </blockquote>
+
 </sect1>




More information about the blfs-book mailing list