Chas Williams 52557c982e xml-docbook-documentation-first-pass-20060915
needs more massaging to make it fit the tree, but, get it here first
2006-09-16 01:13:22 +00:00

429 lines
8.2 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML
><HEAD
><TITLE
>About This Guide</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.7"><LINK
REL="HOME"
TITLE="AFS Quick Beginnings"
HREF="book1.html"><LINK
REL="PREVIOUS"
TITLE="AFS Quick Beginnings"
HREF="book1.html"><LINK
REL="NEXT"
TITLE="Installation Overview"
HREF="c104.html"></HEAD
><BODY
CLASS="preface"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="NAVHEADER"
><TABLE
SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>AFS Quick Beginnings: Version 3.6</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="book1.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="c104.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><DIV
CLASS="preface"
><H1
><A
NAME="HDRWQ1"
></A
>About This Guide</H1
><P
>This section describes the purpose, organization, and conventions of this document.</P
><DIV
CLASS="sect1"
><H1
CLASS="sect1"
><A
NAME="HDRWQ2"
>Audience and Purpose</A
></H1
><P
>This guide explains how to install and configure AFS<SUP
>(R)</SUP
> server and client machines. It assumes
that the reader is familiar with UNIX<SUP
>(R)</SUP
> system administration, but not AFS.</P
><P
>The instructions explain how to issue AFS commands in the context of specific tasks, but do not describe a command's
function or arguments in detail. Refer to the <SPAN
CLASS="emphasis"
><I
CLASS="emphasis"
>IBM AFS Administration Reference</I
></SPAN
> as necessary.</P
></DIV
><DIV
CLASS="sect1"
><H1
CLASS="sect1"
><A
NAME="HDRWQ3"
>Organization of the Document</A
></H1
><P
>See <A
HREF="c104.html#HDRWQ7"
>The Procedures Described in this Guide</A
>.</P
></DIV
><DIV
CLASS="sect1"
><H1
CLASS="sect1"
><A
NAME="HDRWQ4"
>How to Use This Document</A
></H1
><P
>See <A
HREF="c104.html#HDRWQ7"
>The Procedures Described in this Guide</A
> and <A
HREF="c104.html#HDRWQ16"
>How to
Continue</A
>.</P
></DIV
><DIV
CLASS="sect1"
><H1
CLASS="sect1"
><A
NAME="HDRWQ5"
>Related Documents</A
></H1
><P
>The AFS documentation set also includes the following documents.</P
><P
>&#13; <SPAN
CLASS="emphasis"
><I
CLASS="emphasis"
>IBM AFS Administration Guide</I
></SPAN
>
</P
><P
>This guide describes the concepts and procedures that a system administrator must know to manage an AFS cell. It assumes
familiarity with UNIX, but requires no previous knowledge of AFS.</P
><P
>The first chapters of the <SPAN
CLASS="emphasis"
><I
CLASS="emphasis"
>IBM AFS Administration Guide</I
></SPAN
> present basic concepts and guidelines.
Understanding them is crucial to successful administration of an AFS cell. The remaining chapters in the guide provide
step-by-step instructions for specific administrative tasks, along with discussions of the concepts important to that particular
task.</P
><P
>&#13; <SPAN
CLASS="emphasis"
><I
CLASS="emphasis"
>IBM AFS Administration Reference</I
></SPAN
>
</P
><P
>This reference manual details the syntax and effect of each AFS command. It is intended for the experienced AFS
administrator, programmer, or user.</P
><P
>The <SPAN
CLASS="emphasis"
><I
CLASS="emphasis"
>IBM AFS Administration Reference</I
></SPAN
> lists AFS files and commands in alphabetical order. The
reference page for each command specifies its syntax, including the acceptable aliases and abbreviations. It then describes the
command's function, arguments, and output if any. Examples and a list of related commands are provided, as are warnings where
appropriate.</P
><P
>This manual complements the <SPAN
CLASS="emphasis"
><I
CLASS="emphasis"
>IBM AFS Administration Guide</I
></SPAN
>: it does not include procedural information,
but describes commands in more detail than the <SPAN
CLASS="emphasis"
><I
CLASS="emphasis"
>IBM AFS Administration Guide</I
></SPAN
>.</P
><P
>&#13; <SPAN
CLASS="emphasis"
><I
CLASS="emphasis"
>IBM AFS User Guide</I
></SPAN
>
</P
><P
>This guide presents the basic concepts and procedures necessary for using AFS effectively. It assumes that the reader has
some experience with UNIX, but does not require familiarity with networking or AFS.</P
><P
>The guide explains how to perform basic functions, including authenticating, changing a password, protecting AFS data,
creating groups, and troubleshooting. It provides illustrative examples for each function and describes some of the differences
between the UNIX file system and AFS.</P
><P
>&#13; <SPAN
CLASS="emphasis"
><I
CLASS="emphasis"
>IBM AFS Release Notes</I
></SPAN
>
</P
><P
>This document provides information specific to each release of AFS, such as a list of new features and commands, a list of
requirements and limitations, and instructions for upgrading server and client machines.</P
></DIV
><DIV
CLASS="sect1"
><H1
CLASS="sect1"
><A
NAME="HDRTYPO_CONV"
>Typographical Conventions</A
></H1
><P
>This document uses the following typographical conventions: <UL
><LI
><P
>Command and option names appear in <SPAN
CLASS="bold"
><B
CLASS="emphasis"
>bold type</B
></SPAN
> in syntax definitions, examples, and
running text. Names of directories, files, machines, partitions, volumes, and users also appear in <SPAN
CLASS="bold"
><B
CLASS="emphasis"
>bold type</B
></SPAN
>.</P
></LI
><LI
><P
>Variable information appears in <SPAN
CLASS="emphasis"
><I
CLASS="emphasis"
>italic type</I
></SPAN
>. This includes user-supplied information on command
lines and the parts of prompts that differ depending on who issues the command. New terms also appear in <SPAN
CLASS="emphasis"
><I
CLASS="emphasis"
>italic
type</I
></SPAN
>.</P
></LI
><LI
><P
>Examples of screen output and file contents appear in <SAMP
CLASS="computeroutput"
>monospace type</SAMP
>.</P
></LI
></UL
> </P
><P
>In addition, the following symbols appear in command syntax definitions, both in the documentation and in AFS online help
statements. When issuing a command, do not type these symbols. <UL
><LI
><P
>Square brackets <SPAN
CLASS="bold"
><B
CLASS="emphasis"
>[ ]</B
></SPAN
> surround optional items.</P
></LI
><LI
><P
>Angle brackets <SPAN
CLASS="bold"
><B
CLASS="emphasis"
>&#60; &#62;</B
></SPAN
> surround user-supplied values in AFS commands.</P
></LI
><LI
><P
>A superscripted plus sign <SPAN
CLASS="bold"
><B
CLASS="emphasis"
>+</B
></SPAN
> follows an argument that accepts more than one
value.</P
></LI
><LI
><P
>The percent sign <SAMP
CLASS="computeroutput"
>%</SAMP
> represents the regular command shell prompt. Some operating
systems possibly use a different character for this prompt.</P
></LI
><LI
><P
>The number sign <SAMP
CLASS="computeroutput"
>#</SAMP
> represents the command shell prompt for the local superuser
<SPAN
CLASS="bold"
><B
CLASS="emphasis"
>root</B
></SPAN
>. Some operating systems possibly use a different character for this prompt.</P
></LI
><LI
><P
>The pipe symbol <SPAN
CLASS="bold"
><B
CLASS="emphasis"
>|</B
></SPAN
> in a command syntax statement separates mutually exclusive values
for an argument.</P
></LI
></UL
> </P
><P
>For additional information on AFS commands, including a description of command string components, acceptable abbreviations
and aliases, and how to get online help for commands, see the appendix to the <SPAN
CLASS="emphasis"
><I
CLASS="emphasis"
>IBM AFS Administration
Guide</I
></SPAN
>.</P
></DIV
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="book1.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="book1.html"
ACCESSKEY="H"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="c104.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>AFS Quick Beginnings</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
>&nbsp;</TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>Installation Overview</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>