1 <?xml version="1.0" encoding="UTF-8"?>
3 <title>About This Guide</title>
5 <para>This section describes the purpose, organization, and conventions
6 of this document.</para>
9 <title>Audience and Purpose</title>
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
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>
25 <title>Organization of the Document</title>
27 <para>See <link linkend="HDRWQ7">The Procedures Described in this
32 <title>How to Use This Document</title>
34 <para>See <link linkend="HDRWQ7">The Procedures Described in this
35 Guide</link> and <link linkend="HDRWQ16">How to
36 Continue</link>.</para>
40 <title>Related Documents</title>
42 <para>The OpenAFS documentation set also includes the following
46 <term><citetitle>OpenAFS Administration Guide</citetitle></term>
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>
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>
65 <term><citetitle>OpenAFS Administration
66 Reference</citetitle></term>
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>
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
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>
91 <term><citetitle>OpenAFS User Guide</citetitle></term>
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>
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>
108 <term><citetitle>OpenAFS Release Notes</citetitle></term>
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>
121 <sect1 id="HDRTYPO_CONV">
122 <title>Typographical Conventions</title>
124 <para>This document uses the following typographical conventions:
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>
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>
143 <para>Examples of screen output and file contents appear
144 in <computeroutput>monospace type</computeroutput>.</para>
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
155 <para>Square brackets <emphasis role="bold">[ ]</emphasis>
156 surround optional items.</para>
160 <para>Angle brackets <emphasis role="bold">< ></emphasis>
161 surround user-supplied values in AFS commands.</para>
165 <para>A superscripted plus
166 sign <emphasis role="bold">+</emphasis> follows an argument that
167 accepts more than one value.</para>
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
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
186 <para>The pipe symbol <emphasis role="bold">|</emphasis> in a
187 command syntax statement separates mutually exclusive values for
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>