Whamcloud - gitweb
LUDOC-98 mgs: Document new lctl replace_nids feature
[doc/manual.git] / Preface.xml
1 <?xml version='1.0' encoding='UTF-8'?>
2 <preface xmlns="http://docbook.org/ns/docbook" xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:lang="en-US">
3   <title>Preface</title>
4   <para>The <emphasis role="italic">Lustre* Operations Manual</emphasis> provides detailed
5     information and procedures to install, configure and tune a Lustre file system. The manual
6     covers topics such as failover, quotas, striping, and bonding. This manual also contains
7     troubleshooting information and tips to improve the operation and performance of a Lustre file
8     system.</para>
9   <section remap="h2">
10     <title>About this Document</title>
11     <para>This document is maintained by Intel in Docbook format. The
12     canonical version is available at
13     <link xl:href="http://wiki.hpdd.intel.com/display/PUB/Documentation">http://wiki.hpdd.intel.com/display/PUB/Documentation</link>. </para>
14
15     <section remap="h2">
16       <title>UNIX Commands</title>
17       <para>This document may not contain information about basic UNIX* operating system commands
18         and procedures such as shutting down the system, booting the system, and configuring
19         devices. Refer to the following for this information:</para>
20       <itemizedlist>
21         <listitem>
22           <para> Software documentation that you received with your system</para>
23         </listitem>
24         <listitem>
25           <para> Red Hat* Enterprise Linux* documentation, which is at: <link
26               xl:href="http://docs.redhat.com/docs/en-US/index.html"
27               >http://docs.redhat.com/docs/en-US/index.html</link></para>
28   <note><para> The Lustre client module is available for many different Linux* versions and distributions.
29               Red Hat Enterprise is the best supported and tested platform for Lustre servers. </para></note>
30         </listitem>
31       </itemizedlist>
32     </section>
33     <section remap="h2">
34       <title>Shell Prompts</title>
35       <informaltable frame="all">
36         <tgroup cols="2">
37           <colspec colname="c1" colwidth="50*"/>
38           <colspec colname="c2" colwidth="50*"/>
39           <thead>
40             <row>
41               <entry>
42                 <para><emphasis role="bold">Shell</emphasis></para>
43               </entry>
44               <entry>
45                 <para><emphasis role="bold">Prompt</emphasis></para>
46               </entry>
47             </row>
48           </thead>
49           <tbody>
50             <row>
51               <entry>
52                 <para> C shell</para>
53               </entry>
54               <entry>
55                 <para> <emphasis>machine-name</emphasis>%</para>
56               </entry>
57             </row>
58             <row>
59               <entry>
60                 <para> C shell superuser</para>
61               </entry>
62               <entry>
63                 <para> <emphasis>machine-name</emphasis>#</para>
64               </entry>
65             </row>
66             <row>
67               <entry>
68                 <para> Bourne shell and Korn shell</para>
69               </entry>
70               <entry>
71                 <para> <prompt>$</prompt></para>
72               </entry>
73             </row>
74             <row>
75               <entry>
76                 <para> Bourne shell and Korn shell superuser</para>
77               </entry>
78               <entry>
79                 <para> <prompt>#</prompt></para>
80               </entry>
81             </row>
82           </tbody>
83         </tgroup>
84       </informaltable>
85     </section>
86     <section remap="h2">
87       <title>Related Documentation</title>
88       <para>The documents listed as online are available at:</para>
89       <para><link xl:href="http://wiki.hpdd.intel.com/display/PUB/Documentation">http://wiki.hpdd.intel.com/display/PUB/Documentation</link></para>
90       <informaltable frame="all">
91         <tgroup cols="4">
92           <colspec colname="c1" colwidth="25*"/>
93           <colspec colname="c2" colwidth="25*"/>
94           <colspec colname="c3" colwidth="25*"/>
95           <colspec colname="c4" colwidth="25*"/>
96           <thead>
97             <row>
98               <entry>
99                 <para><emphasis role="bold">Application</emphasis></para>
100               </entry>
101               <entry>
102                 <para><emphasis role="bold">Title</emphasis></para>
103               </entry>
104               <entry>
105                 <para><emphasis role="bold">Format</emphasis></para>
106               </entry>
107               <entry>
108                 <para><emphasis role="bold">Location</emphasis></para>
109               </entry>
110             </row>
111           </thead>
112           <tbody>
113             <row>
114               <entry>
115                 <para> Latest information</para>
116               </entry>
117               <entry>
118                 <para>
119                   <emphasis>Lustre* 2.0 Release Notes</emphasis></para>
120               </entry>
121               <entry>
122                 <para> PDF</para>
123               </entry>
124               <entry>
125                 <para> Online</para>
126               </entry>
127             </row>
128             <row>
129               <entry>
130                 <para> Service</para>
131               </entry>
132               <entry>
133                 <para>
134                   <emphasis>Lustre* 2.0 Operations Manual</emphasis></para>
135               </entry>
136               <entry>
137                 <para> PDF</para>
138                 <para>HTML</para>
139               </entry>
140               <entry>
141                 <para> Online</para>
142               </entry>
143             </row>
144           </tbody>
145         </tgroup>
146       </informaltable>
147     </section>
148     <section remap="h2">
149       <title>Documentation, Support, and Training</title>
150       <para>These web sites provide additional resources:</para>
151       <itemizedlist>
152         <listitem>
153           <para> Documentation <link xl:href="http://wiki.hpdd.intel.com/display/PUB/Documentation">http://wiki.hpdd.intel.com/display/PUB/Documentation</link></para>
154         </listitem>
155         <listitem>
156           <para> Support <link xl:href="http://www.hpdd.intel.com/">http://www.hpdd.intel.com/</link></para>
157         </listitem>
158         <listitem>
159           <para> Training <link xl:href="http://www.hpdd.intel.com/">http://www.hpdd.intel.com/</link></para>
160         </listitem>
161       </itemizedlist>
162     </section>
163   </section>
164     <xi:include href="Revision.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
165 </preface>