Whamcloud - gitweb
LUDOC-403 acl: Update link for POSIX ACL paper
[doc/manual.git] / Preface.xml
index 976011a..56645fb 100644 (file)
@@ -1,11 +1,11 @@
 <?xml version='1.0' encoding='UTF-8'?>
 <preface xmlns="http://docbook.org/ns/docbook" xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:lang="en-US">
   <title>Preface</title>
-  <para>The <emphasis role="italic">Lustre<superscript>*</superscript> Operations Manual</emphasis>
-    provides detailed information and procedures to install, configure and tune a Lustre file
-    system. The manual covers topics such as failover, quotas, striping, and bonding. This manual
-    also contains troubleshooting information and tips to improve the operation and performance of a
-    Lustre file system.</para>
+  <para>The <emphasis role="italic">Lustre<superscript>*</superscript>Software Release 2.x
+      Operations Manual</emphasis> provides detailed information and procedures to install,
+    configure and tune a Lustre file system. The manual covers topics such as failover, quotas,
+    striping, and bonding. This manual also contains troubleshooting information and tips to improve
+    the operation and performance of a Lustre file system.</para>
   <section remap="h2">
     <title>About this Document</title>
     <para>This document is maintained by Intel in Docbook format. The
     </section>
     <section remap="h2">
       <title>Shell Prompts</title>
+      <para>The shell prompt used in the example text indicates whether a
+      command can or should be executed by a regular user, or whether it
+      requires superuser permission to run.  Also, the machine type is often
+      included in the prompt to indicate whether the command should be run
+      on a client node, on an MDS node, an OSS node, or the MGS node.</para>
+      <para>Some examples are listed below, but other prompt combinations
+      are also used as needed for the example.</para>
       <informaltable frame="all">
         <tgroup cols="2">
           <colspec colname="c1" colwidth="50*"/>
           <tbody>
             <row>
               <entry>
-                <para> C shell</para>
+                <para> Regular user</para>
               </entry>
               <entry>
-                <para> <emphasis>machine-name</emphasis>%</para>
+                <para> <prompt>machine$</prompt></para>
               </entry>
             </row>
             <row>
               <entry>
-                <para> C shell superuser</para>
+                <para> Superuser (root)</para>
               </entry>
               <entry>
-                <para> <emphasis>machine-name</emphasis>#</para>
+                <para> <prompt>machine#</prompt></para>
               </entry>
             </row>
             <row>
               <entry>
-                <para> Bourne shell and Korn shell</para>
+                <para> Regular user on the client</para>
               </entry>
               <entry>
-                <para> <prompt>$</prompt></para>
+                <para> <prompt>client$</prompt></para>
               </entry>
             </row>
             <row>
               <entry>
-                <para> Bourne shell and Korn shell superuser</para>
+                <para> Superuser on the MDS</para>
               </entry>
               <entry>
-                <para> <prompt>#</prompt></para>
+                <para> <prompt>mds#</prompt></para>
+              </entry>
+            </row>
+            <row>
+              <entry>
+                <para> Superuser on the OSS</para>
+              </entry>
+              <entry>
+                <para> <prompt>oss#</prompt></para>
+              </entry>
+            </row>
+            <row>
+              <entry>
+                <para> Superuser on the MGS</para>
+              </entry>
+              <entry>
+                <para> <prompt>mgs#</prompt></para>
               </entry>
             </row>
           </tbody>
               </entry>
               <entry>
                 <para>
-                  <emphasis>Lustre 2.0 Release Notes</emphasis></para>
+                  <emphasis>Lustre Software Release 2.x Change Logs</emphasis></para>
               </entry>
               <entry>
-                <para> PDF</para>
+                <para> Wiki page</para>
               </entry>
               <entry>
                 <para> Online at <link
               </entry>
               <entry>
                 <para>
-                  <emphasis>Lustre 2.0 Operations Manual</emphasis></para>
+                  <emphasis>Lustre Software Release 2.x Operations Manual</emphasis></para>
               </entry>
               <entry>
                 <para> PDF</para>