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.  Large portions of them are as released to the community
  44       by IBM, and are not directly applicable to current releases of
  45       OpenAFS.  This document uses the legacy "Transarc" paths
  46       (<computeroutput>/usr/afs</computeroutput>,
  47        <computeroutput>/usr/vice</computeroutput>, etc.), which do not
  48        correspond to the normal file system hierarchy on many modern
  49        machines; the paths may need to be substituted according to
  50        the local software installation.
  51       <variablelist>
  52         <varlistentry>
  53           <term><citetitle>OpenAFS Administration Guide</citetitle></term>
  54
  55           <listitem>
  56             <para>This guide describes the concepts and procedures that a
  57             system administrator must know to manage an AFS cell.  It
  58             assumes familiarity with UNIX, but requires no previous
  59             knowledge of AFS.</para>
  60
  61             <para>The first chapters of the <citetitle>OpenAFS
  62             Administration Guide</citetitle> present basic concepts and
  63             guidelines.  Understanding them is crucial to successful
  64             administration of an AFS cell.  The remaining chapters in the
  65             guide provide step-by-step instructions for specific
  66             administrative tasks, along with discussions of the concepts
  67             important to that particular task.</para>
  68           </listitem>
  69         </varlistentry>
  70
  71         <varlistentry>
  72           <term><citetitle>OpenAFS Administration
  73           Reference</citetitle></term>
  74
  75           <listitem>
  76             <para>This reference manual details the syntax and effect of
  77             each AFS command.  It is intended for the experienced AFS
  78             administrator, programmer, or user.</para>
  79
  80             <para>The <citetitle>OpenAFS Administration
  81             Reference</citetitle> lists AFS files and commands in
  82             alphabetical order.  The reference page for each command
  83             specifies its syntax, including the acceptable aliases and
  84             abbreviations.  It then describes the command's function,
  85             arguments, and output if any.  Examples and a list of related
  86             commands are provided, as are warnings where
  87             appropriate.</para>
  88
  89             <para>This manual complements the <citetitle>OpenAFS
  90             Administration Guide</citetitle>: it does not include
  91             procedural information, but describes commands in more detail
  92             than the <citetitle>OpenAFS Administration
  93             Guide</citetitle>.</para>
  94           </listitem>
  95         </varlistentry>
  96
  97         <varlistentry>
  98           <term><citetitle>OpenAFS User Guide</citetitle></term>
  99
 100           <listitem>
 101             <para>This guide presents the basic concepts and procedures
 102             necessary for using AFS effectively.  It assumes that the
 103             reader has some experience with UNIX, but does not require
 104             familiarity with networking or AFS.</para>
 105
 106             <para>The guide explains how to perform basic functions,
 107             including authenticating, changing a password, protecting AFS
 108             data, creating groups, and troubleshooting.  It provides
 109             illustrative examples for each function and describes some of
 110             the differences between the UNIX file system and AFS.</para>
 111           </listitem>
 112         </varlistentry>
 113
 114         <varlistentry>
 115           <term><citetitle>OpenAFS Release Notes</citetitle></term>
 116
 117           <listitem>
 118             <para>This document provides information specific to each
 119             release of AFS, such as a list of new features and commands, a
 120             list of requirements and limitations, and instructions for
 121             upgrading server and client machines.</para>
 122           </listitem>
 123         </varlistentry>
 124       </variablelist>
 125     </para>
 126   </sect1>
 127
 128   <sect1 id="HDRTYPO_CONV">
 129     <title>Typographical Conventions</title>
 130
 131     <para>This document uses the following typographical conventions:
 132       <itemizedlist>
 133         <listitem>
 134           <para>Command and option names appear
 135           in <emphasis role="bold">bold type</emphasis> in syntax
 136           definitions, examples, and running text.  Names of directories,
 137           files, machines, partitions, volumes, and users also appear
 138           in <emphasis role="bold">bold type</emphasis>.</para>
 139         </listitem>
 140
 141         <listitem>
 142           <para>Variable information appears in <emphasis>italic
 143           type</emphasis>.  This includes user-supplied information on
 144           command lines and the parts of prompts that differ depending on
 145           who issues the command.  New terms also appear
 146           in <emphasis>italic type</emphasis>.</para>
 147         </listitem>
 148
 149         <listitem>
 150           <para>Examples of screen output and file contents appear
 151           in <computeroutput>monospace type</computeroutput>.</para>
 152         </listitem>
 153       </itemizedlist>
 154     </para>
 155
 156     <para>In addition, the following symbols appear in command syntax
 157     definitions, both in the documentation and in AFS online help
 158     statements. When issuing a command, do not type these
 159     symbols.
 160       <itemizedlist>
 161         <listitem>
 162           <para>Square brackets <emphasis role="bold">[ ]</emphasis>
 163           surround optional items.</para>
 164         </listitem>
 165
 166         <listitem>
 167           <para>Angle brackets <emphasis role="bold">&lt; &gt;</emphasis>
 168           surround user-supplied values in AFS commands.</para>
 169         </listitem>
 170
 171         <listitem>
 172           <para>A superscripted plus
 173           sign <emphasis role="bold">+</emphasis> follows an argument that
 174           accepts more than one value.</para>
 175         </listitem>
 176
 177         <listitem>
 178           <para>The percent sign <computeroutput>%</computeroutput>
 179           represents the regular command shell prompt. Some operating
 180           systems possibly use a different character for this
 181           prompt.</para>
 182         </listitem>
 183
 184         <listitem>
 185           <para>The number sign <computeroutput>#</computeroutput>
 186           represents the command shell prompt for the local
 187           superuser <emphasis role="bold">root</emphasis>. Some operating
 188           systems possibly use a different character for this
 189           prompt.</para>
 190         </listitem>
 191
 192         <listitem>
 193           <para>The pipe symbol <emphasis role="bold">|</emphasis> in a
 194           command syntax statement separates mutually exclusive values for
 195           an argument.</para>
 196         </listitem>
 197       </itemizedlist>
 198     </para>
 199
 200     <para>For additional information on AFS commands, including a
 201     description of command string components, acceptable abbreviations and
 202     aliases, and how to get online help for commands, see the appendix to
 203     the <citetitle>OpenAFS Administration Guide</citetitle>.</para>
 204   </sect1>
 205 </preface>