Whamcloud - gitweb
LUDOC-445 fix minor typo
[doc/manual.git] / Preface.xml
index 85eaf91..874b4c5 100644 (file)
@@ -8,9 +8,9 @@
     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
+    <para>This document is maintained by Whamcloud in Docbook format. The
     canonical version is available at
-    <link xl:href="http://wiki.hpdd.intel.com/display/PUB/Documentation">http://wiki.hpdd.intel.com/display/PUB/Documentation</link>. </para>
+    <link xl:href="http://wiki.whamcloud.com/display/PUB/Documentation">http://wiki.whamcloud.com/display/PUB/Documentation</link>. </para>
 
     <section remap="h2">
       <title>UNIX<superscript>*</superscript> Commands</title>
     </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> Online at <link
-                    xl:href="http://wiki.hpdd.intel.com/display/PUB/Documentation"
-                    >http://wiki.hpdd.intel.com/display/PUB/Documentation</link></para>
+                    xl:href="http://wiki.whamcloud.com/display/PUB/Documentation"
+                    >http://wiki.whamcloud.com/display/PUB/Documentation</link></para>
               </entry>
             </row>
             <row>
               </entry>
               <entry>
                 <para> Online at <link
-                    xl:href="http://wiki.hpdd.intel.com/display/PUB/Documentation"
-                    >http://wiki.hpdd.intel.com/display/PUB/Documentation</link></para>
+                    xl:href="http://wiki.whamcloud.com/display/PUB/Documentation"
+                    >http://wiki.whamcloud.com/display/PUB/Documentation</link></para>
               </entry>
             </row>
           </tbody>
       </informaltable>
     </section>
     <section remap="h2">
-      <title>Documentation, Support, and Training</title>
+      <title>Documentation and Support</title>
       <para>These web sites provide additional resources:</para>
       <itemizedlist>
         <listitem>
-          <para> Documentation <link xl:href="http://wiki.hpdd.intel.com/display/PUB/Documentation">http://wiki.hpdd.intel.com/display/PUB/Documentation</link></para>
-        </listitem>
-        <listitem>
-          <para> Support <link xl:href="http://www.hpdd.intel.com/">http://www.hpdd.intel.com/</link></para>
+                                       <para> Documentation
+                                               <link xl:href="http://wiki.whamcloud.com/display/PUB/Documentation">
+                                               http://wiki.whamcloud.com/display/PUB/Documentation</link>
+                                               <link xl:href="http://www.lustre.org">
+                                               http://www.lustre.org</link></para>
         </listitem>
         <listitem>
-          <para> Training <link xl:href="http://www.hpdd.intel.com/">http://www.hpdd.intel.com/</link></para>
+          <para> Support <link xl:href="https://jira.whamcloud.com/">https://jira.whamcloud.com/</link></para>
         </listitem>
       </itemizedlist>
     </section>