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