doc/xml/AdminGuide/auagd005.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2
   3 <preface id="Header_3">
   4   <title>About This Guide</title>
   5
   6   <para>This section describes the purpose, organization, and conventions
   7   of this document.</para>
   8
   9   <sect1 id="HDRWQ1">
  10     <title>Audience and Purpose</title>
  11
  12     <para>This guide describes the concepts and procedures that an AFS(R)
  13     system administrator needs to know. It assumes familiarity with
  14     UNIX(R) administration, but no previous knowledge of AFS.</para>
  15
  16     <para>This document describes AFS commands in the context of specific
  17     tasks. Thus, it does not describe all commands in detail.  Refer to
  18     the OpenAFS Administration Reference for detailed command
  19     descriptions.</para>
  20   </sect1>
  21
  22   <sect1 id="HDRWQ2">
  23     <title>Document Organization</title>
  24
  25     <para>
  26       This document groups AFS administrative tasks into the following
  27       conceptual sections:
  28       <itemizedlist>
  29         <listitem>
  30           <para>Concepts and Configuration Issues</para>
  31         </listitem>
  32
  33         <listitem>
  34           <para>Managing File Server Machines</para>
  35         </listitem>
  36
  37         <listitem>
  38           <para>Managing Client Machines</para>
  39         </listitem>
  40
  41         <listitem>
  42           <para>Managing Users and Groups</para>
  43         </listitem>
  44       </itemizedlist>
  45     </para>
  46
  47     <para>
  48       The individual chapters in each section contain the following:
  49       <itemizedlist>
  50         <listitem>
  51           <para>A chapter overview</para>
  52         </listitem>
  53
  54         <listitem>
  55           <para>A quick reference list of the tasks and commands described
  56           in the chapter</para>
  57         </listitem>
  58
  59         <listitem>
  60           <para>An introduction to concepts that pertain to all of the
  61           tasks described in the chapter</para>
  62         </listitem>
  63
  64         <listitem>
  65           <para>A set of sections devoted to specific tasks. Each section
  66           begins with a discussion of concepts specific to that task,
  67           followed by step-by-step instructions for performing the
  68           task. The instructions are as specific as has been judged
  69           practical. If two related procedures differ from one another in
  70           important details, separate sets of instructions are usually
  71           provided.</para>
  72         </listitem>
  73     </itemizedlist>
  74     </para>
  75   </sect1>
  76
  77   <sect1 id="HDRWQ3">
  78     <title>How to Use This Document</title>
  79
  80     <para>When you need to perform a specific administrative task, follow
  81     these steps:
  82
  83     <orderedlist>
  84       <listitem>
  85         <para>Determine if the task concerns file server machines, client
  86         machines, or users and groups. Turn to the appropriate section in
  87         this document and then to the appropriate chapter.</para>
  88       </listitem>
  89
  90       <listitem>
  91         <para>Read or review the general introductory material at the
  92         beginning of the chapter.</para>
  93       </listitem>
  94
  95       <listitem>
  96         <para>Read or review the introductory material concerning the
  97         specific task you wish to perform.</para>
  98       </listitem>
  99
 100       <listitem>
 101         <para>Follow the step-by-step instructions for the task.</para>
 102       </listitem>
 103
 104       <listitem>
 105         <para>If necessary, refer to the OpenAFS Administration Reference
 106         for more detailed information about the commands.</para>
 107       </listitem>
 108     </orderedlist>
 109     </para>
 110   </sect1>
 111
 112   <sect1 id="HDRWQ4">
 113     <title>Related Documents</title>
 114
 115     <para>The following documents are also included in the AFS
 116     documentation set.
 117     <variablelist>
 118       <varlistentry>
 119         <term>OpenAFS Quick Start Guide</term>
 120
 121         <listitem>
 122           <para>
 123             This guide provides instructions for installing AFS server and
 124             client machines. It is assumed that the installer is an
 125             experienced UNIX(R) system administrator.
 126           </para>
 127
 128           <para>
 129             For predictable performance, machines must be installed and
 130             configured in accordance with the instructions in this guide.
 131           </para>
 132         </listitem>
 133       </varlistentry>
 134
 135       <varlistentry>
 136         <term>OpenAFS User Guide</term>
 137
 138         <listitem>
 139           <para>
 140             This guide presents the basic concepts and procedures
 141             necessary for using AFS effectively. It assumes that the
 142             reader has some experience with UNIX, but does not require
 143             familiarity with networking or AFS.
 144           </para>
 145
 146           <para>
 147             The guide explains how to perform basic functions, including
 148             authenticating, changing a password, protecting AFS data,
 149             creating groups, and troubleshooting. It provides illustrative
 150             examples for each function and describes some of the
 151             differences between the UNIX file system and AFS.
 152           </para>
 153         </listitem>
 154       </varlistentry>
 155
 156       <varlistentry>
 157         <term>OpenAFS Reference Manual</term>
 158
 159         <listitem>
 160           <para>
 161             This reference manual details the syntax and effect of each
 162             AFS command. It is intended for the experienced AFS
 163             administrator, programmer, or user. It contains a reference
 164             page for each command or file specifying its syntax, including
 165             the acceptable aliases and abbreviations. It then describes
 166             the command's function, arguments, and output if any. Examples
 167             and a list of related commands are provided, as are warnings
 168             where appropriate.
 169           </para>
 170
 171           <para>
 172             This manual complements the OpenAFS Administration Guide:  it
 173             does not include procedural information, but describes
 174             commands in more detail than the OpenAFS Administration Guide.
 175           </para>
 176
 177           <para>
 178             The OpenAFS Reference Manual is provided in the form of
 179             UNIX(R) manual pages and as HTML pages.
 180           </para>
 181         </listitem>
 182       </varlistentry>
 183
 184       <varlistentry>
 185         <term>OpenAFS for Windows Release Notes</term>
 186
 187         <listitem>
 188           <para>
 189             This document provides a series of usage notes regarding the
 190             OpenAFS for Windows client, supported platforms, contribution
 191             information, debugging techniques, and a reference to
 192             supported Windows registry values.
 193           </para>
 194         </listitem>
 195       </varlistentry>
 196     </variablelist>
 197     </para>
 198   </sect1>
 199
 200   <sect1 id="HDRTYPO_CONV">
 201     <title>Typographical Conventions</title>
 202
 203     <para>This document uses the following typographical conventions:
 204
 205     <itemizedlist>
 206       <listitem>
 207         <para>
 208           Command and option names appear in <emphasis role="bold">bold
 209           type</emphasis> in syntax definitions, examples, and running
 210           text. Names of directories, files, machines, partitions,
 211           volumes, and users also appear in <emphasis role="bold">bold
 212           type</emphasis>.
 213         </para>
 214       </listitem>
 215
 216       <listitem>
 217         <para>
 218           Variable information appears in <emphasis>italic
 219           type</emphasis>. This includes user-supplied information on
 220           command lines and the parts of prompts that differ depending on
 221           who issues the command. New terms also appear in
 222           <emphasis>italic type</emphasis>.
 223         </para>
 224       </listitem>
 225
 226       <listitem>
 227         <para>
 228           Examples of screen output and file contents appear in
 229           <computeroutput>monospace type</computeroutput>.
 230       </para>
 231       </listitem>
 232     </itemizedlist>
 233     </para>
 234
 235     <para>In addition, the following symbols appear in command syntax
 236     definitions, both in the documentation and in AFS online help
 237     statements. When issuing a command, do not type these
 238     symbols.
 239     <itemizedlist>
 240       <listitem>
 241         <para>Square brackets <emphasis role="bold">[ ]</emphasis>
 242         surround optional items.</para>
 243       </listitem>
 244
 245       <listitem>
 246         <para>Angle brackets <emphasis role="bold">&lt; &gt;</emphasis>
 247         surround user-supplied values in AFS commands.</para>
 248       </listitem>
 249
 250       <listitem>
 251         <para>A superscripted plus sign <emphasis role="bold">+</emphasis>
 252         follows an argument that accepts more than one value.</para>
 253       </listitem>
 254
 255       <listitem>
 256         <para>The percent sign <computeroutput>%</computeroutput>
 257         represents the regular command shell prompt. Some operating
 258         systems possibly use a different character for this prompt.</para>
 259       </listitem>
 260
 261       <listitem>
 262         <para>The number sign <computeroutput>#</computeroutput>
 263         represents the command shell prompt for the local superuser
 264         <emphasis role="bold">root</emphasis>.  Some operating systems
 265         possibly use a different character for this prompt.</para>
 266       </listitem>
 267
 268       <listitem>
 269         <para>The pipe symbol <emphasis role="bold">|</emphasis> in a
 270         command syntax statement separates mutually exclusive values for
 271         an argument.</para>
 272       </listitem>
 273     </itemizedlist>
 274     </para>
 275
 276     <para>For additional information on AFS commands, including a
 277     description of command string components, acceptable abbreviations and
 278     aliases, and how to get online help for commands, see <link
 279     linkend="HDRCOMMANDS">Appendix B, Using AFS Commands</link>.</para>
 280   </sect1>
 281 </preface>