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