doc: fix kindle builds of documentation
[openafs.git] / doc / xml / QuickStartUnix / auqbg003.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <preface id="HDRWQ1">
3   <title>About This Guide</title>
4
5   <para>This section describes the purpose, organization, and conventions
6   of this document.</para>
7
8   <sect1 id="HDRWQ2">
9     <title>Audience and Purpose</title>
10
11     <para>This guide explains how to install and configure OpenAFS
12     server and client machines. It
13     assumes that the reader is familiar with <trademark
14     class="registered">UNIX</trademark> system administration, but not
15     AFS.</para>
16
17     <para>The instructions explain how to issue 
18     <trademark class="registered">AFS</trademark> commands in the
19     context of specific tasks, but do not describe a command's function or
20     arguments in detail. Refer to the <citetitle>OpenAFS Administration
21     Reference</citetitle> as necessary.</para>
22   </sect1>
23
24   <sect1 id="HDRWQ3">
25     <title>Organization of the Document</title>
26
27     <para>See <link linkend="HDRWQ7">The Procedures Described in this
28     Guide</link>.</para>
29   </sect1>
30
31   <sect1 id="HDRWQ4">
32     <title>How to Use This Document</title>
33
34     <para>See <link linkend="HDRWQ7">The Procedures Described in this
35     Guide</link> and <link linkend="HDRWQ16">How to
36     Continue</link>.</para>
37   </sect1>
38
39   <sect1 id="HDRWQ5">
40     <title>Related Documents</title>
41
42     <para>The OpenAFS documentation set also includes the following
43     documents.
44       <variablelist>
45         <varlistentry>
46           <term><citetitle>OpenAFS Administration Guide</citetitle></term>
47
48           <listitem>
49             <para>This guide describes the concepts and procedures that a
50             system administrator must know to manage an AFS cell.  It
51             assumes familiarity with UNIX, but requires no previous
52             knowledge of AFS.</para>
53
54             <para>The first chapters of the <citetitle>OpenAFS
55             Administration Guide</citetitle> present basic concepts and
56             guidelines.  Understanding them is crucial to successful
57             administration of an AFS cell.  The remaining chapters in the
58             guide provide step-by-step instructions for specific
59             administrative tasks, along with discussions of the concepts
60             important to that particular task.</para>
61           </listitem>
62         </varlistentry>
63
64         <varlistentry>
65           <term><citetitle>OpenAFS Administration
66           Reference</citetitle></term>
67
68           <listitem>
69             <para>This reference manual details the syntax and effect of
70             each AFS command.  It is intended for the experienced AFS
71             administrator, programmer, or user.</para>
72
73             <para>The <citetitle>OpenAFS Administration
74             Reference</citetitle> lists AFS files and commands in
75             alphabetical order.  The reference page for each command
76             specifies its syntax, including the acceptable aliases and
77             abbreviations.  It then describes the command's function,
78             arguments, and output if any.  Examples and a list of related
79             commands are provided, as are warnings where
80             appropriate.</para>
81
82             <para>This manual complements the <citetitle>OpenAFS
83             Administration Guide</citetitle>: it does not include
84             procedural information, but describes commands in more detail
85             than the <citetitle>OpenAFS Administration
86             Guide</citetitle>.</para>
87           </listitem>
88         </varlistentry>
89
90         <varlistentry>
91           <term><citetitle>OpenAFS User Guide</citetitle></term>
92
93           <listitem>
94             <para>This guide presents the basic concepts and procedures
95             necessary for using AFS effectively.  It assumes that the
96             reader has some experience with UNIX, but does not require
97             familiarity with networking or AFS.</para>
98
99             <para>The guide explains how to perform basic functions,
100             including authenticating, changing a password, protecting AFS
101             data, creating groups, and troubleshooting.  It provides
102             illustrative examples for each function and describes some of
103             the differences between the UNIX file system and AFS.</para>
104           </listitem>
105         </varlistentry>
106
107         <varlistentry>
108           <term><citetitle>OpenAFS Release Notes</citetitle></term>
109
110           <listitem>
111             <para>This document provides information specific to each
112             release of AFS, such as a list of new features and commands, a
113             list of requirements and limitations, and instructions for
114             upgrading server and client machines.</para>
115           </listitem>
116         </varlistentry>
117       </variablelist>
118     </para>
119   </sect1>
120
121   <sect1 id="HDRTYPO_CONV">
122     <title>Typographical Conventions</title>
123
124     <para>This document uses the following typographical conventions:
125       <itemizedlist>
126         <listitem>
127           <para>Command and option names appear
128           in <emphasis role="bold">bold type</emphasis> in syntax
129           definitions, examples, and running text.  Names of directories,
130           files, machines, partitions, volumes, and users also appear
131           in <emphasis role="bold">bold type</emphasis>.</para>
132         </listitem>
133
134         <listitem>
135           <para>Variable information appears in <emphasis>italic
136           type</emphasis>.  This includes user-supplied information on
137           command lines and the parts of prompts that differ depending on
138           who issues the command.  New terms also appear
139           in <emphasis>italic type</emphasis>.</para>
140         </listitem>
141
142         <listitem>
143           <para>Examples of screen output and file contents appear
144           in <computeroutput>monospace type</computeroutput>.</para>
145         </listitem>
146       </itemizedlist>
147     </para>
148
149     <para>In addition, the following symbols appear in command syntax
150     definitions, both in the documentation and in AFS online help
151     statements. When issuing a command, do not type these
152     symbols.
153       <itemizedlist>
154         <listitem>
155           <para>Square brackets <emphasis role="bold">[ ]</emphasis>
156           surround optional items.</para>
157         </listitem>
158
159         <listitem>
160           <para>Angle brackets <emphasis role="bold">&lt; &gt;</emphasis>
161           surround user-supplied values in AFS commands.</para>
162         </listitem>
163
164         <listitem>
165           <para>A superscripted plus
166           sign <emphasis role="bold">+</emphasis> follows an argument that
167           accepts more than one value.</para>
168         </listitem>
169
170         <listitem>
171           <para>The percent sign <computeroutput>%</computeroutput>
172           represents the regular command shell prompt. Some operating
173           systems possibly use a different character for this
174           prompt.</para>
175         </listitem>
176
177         <listitem>
178           <para>The number sign <computeroutput>#</computeroutput>
179           represents the command shell prompt for the local
180           superuser <emphasis role="bold">root</emphasis>. Some operating
181           systems possibly use a different character for this
182           prompt.</para>
183         </listitem>
184
185         <listitem>
186           <para>The pipe symbol <emphasis role="bold">|</emphasis> in a
187           command syntax statement separates mutually exclusive values for
188           an argument.</para>
189         </listitem>
190       </itemizedlist>
191     </para>
192
193     <para>For additional information on AFS commands, including a
194     description of command string components, acceptable abbreviations and
195     aliases, and how to get online help for commands, see the appendix to
196     the <citetitle>OpenAFS Administration Guide</citetitle>.</para>
197   </sect1>
198 </preface>