LUDOC-391 audit: doc for Lustre Audit with Changelogs

[doc/manual.git] / Preface.xml

diff --git a/Preface.xml b/Preface.xml
index 85eaf91..56645fb 100644 (file)
--- a/Preface.xml
+++ b/Preface.xml
@@ -33,6 +33,13 @@
     </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*"/>
@@ -50,34 +57,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>