afs-web-interface-enhancements-20010623
[openafs.git] / doc / html / QuickStartUnix / auqbg003.htm
1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 4//EN">
2 <HTML><HEAD>
3 <TITLE>Quick Beginnings</TITLE>
4 <!-- Begin Header Records  ========================================== -->
5 <!-- /tmp/idwt3574/auqbg000.scr converted by idb2h R4.2 (359) ID      -->
6 <!-- Workbench Version (AIX) on 2 Oct 2000 at 12:25:35                -->
7 <META HTTP-EQUIV="updated" CONTENT="Mon, 02 Oct 2000 12:25:35">
8 <META HTTP-EQUIV="review" CONTENT="Tue, 02 Oct 2001 12:25:35">
9 <META HTTP-EQUIV="expires" CONTENT="Wed, 02 Oct 2002 12:25:35">
10 </HEAD><BODY>
11 <!-- (C) IBM Corporation 2000. All Rights Reserved    --> 
12 <BODY bgcolor="ffffff"> 
13 <!-- End Header Records  ============================================ -->
14 <A NAME="Top_Of_Page"></A>
15 <H1>Quick Beginnings</H1>
16 <HR><P ALIGN="center"> <A HREF="../index.htm"><IMG SRC="../books.gif" BORDER="0" ALT="[Return to Library]"></A> <A HREF="auqbg002.htm#ToC"><IMG SRC="../toc.gif" BORDER="0" ALT="[Contents]"></A> <A HREF="auqbg002.htm"><IMG SRC="../prev.gif" BORDER="0" ALT="[Previous Topic]"></A> <A HREF="#Bot_Of_Page"><IMG SRC="../bot.gif" BORDER="0" ALT="[Bottom of Topic]"></A> <A HREF="auqbg004.htm"><IMG SRC="../next.gif" BORDER="0" ALT="[Next Topic]"></A> <A HREF="auqbg009.htm#HDRINDEX"><IMG SRC="../index.gif" BORDER="0" ALT="[Index]"></A> <P> 
17 <P>
18 <HR><H1><A NAME="HDRWQ1" HREF="auqbg002.htm#ToC_1">About This Guide</A></H1>
19 <P>This section describes the purpose, organization, and conventions of this
20 document.
21 <HR><H2><A NAME="HDRWQ2" HREF="auqbg002.htm#ToC_2">Audience and Purpose</A></H2>
22 <P>This guide explains how to install and configure
23 AFS<SUP><SUP>(R)</SUP></SUP> server and client machines. It assumes that the
24 reader is familiar with UNIX<SUP><SUP>(R)</SUP></SUP> system administration, but not
25 AFS.
26 <P>The instructions explain how to issue AFS commands in the context of
27 specific tasks, but do not describe a command's function or arguments in
28 detail. Refer to the <I>IBM AFS Administration Reference</I> as
29 necessary.
30 <HR><H2><A NAME="HDRWQ3" HREF="auqbg002.htm#ToC_3">Organization of the Document</A></H2>
31 <P>See <A HREF="auqbg004.htm#HDRWQ7">The Procedures Described in this Guide</A>.
32 <HR><H2><A NAME="HDRWQ4" HREF="auqbg002.htm#ToC_4">How to Use This Document</A></H2>
33 <P>See <A HREF="auqbg004.htm#HDRWQ7">The Procedures Described in this Guide</A> and <A HREF="auqbg004.htm#HDRWQ16">How to Continue</A>.
34 <HR><H2><A NAME="HDRWQ5" HREF="auqbg002.htm#ToC_5">Related Documents</A></H2>
35 <P>The AFS documentation set also includes the following
36 documents.
37 <P><I>IBM AFS Administration Guide</I>
38 <P>This guide describes the concepts and procedures that a system
39 administrator must know to manage an AFS cell. It assumes familiarity
40 with UNIX, but requires no previous knowledge of AFS.
41 <P>The first chapters of the <I>IBM AFS Administration Guide</I> present
42 basic concepts and guidelines. Understanding them is crucial to
43 successful administration of an AFS cell. The remaining chapters in the
44 guide provide step-by-step instructions for specific administrative tasks,
45 along with discussions of the concepts important to that particular
46 task.
47 <P><I>IBM AFS Administration Reference</I>
48 <P>This reference manual details the syntax and effect of each AFS
49 command. It is intended for the experienced AFS administrator,
50 programmer, or user.
51 <P>The <I>IBM AFS Administration Reference</I> lists AFS files and
52 commands in alphabetical order. The reference page for each command
53 specifies its syntax, including the acceptable aliases and
54 abbreviations. It then describes the command's function,
55 arguments, and output if any. Examples and a list of related commands
56 are provided, as are warnings where appropriate.
57 <P>This manual complements the <I>IBM AFS Administration Guide</I>:
58 it does not include procedural information, but describes commands in more
59 detail than the <I>IBM AFS Administration Guide</I>.
60 <P><I>IBM AFS User Guide</I>
61 <P>This guide presents the basic concepts and procedures necessary for using
62 AFS effectively. It assumes that the reader has some experience with
63 UNIX, but does not require familiarity with networking or AFS.
64 <P>The guide explains how to perform basic functions, including
65 authenticating, changing a password, protecting AFS data, creating groups, and
66 troubleshooting. It provides illustrative examples for each function
67 and describes some of the differences between the UNIX file system and
68 AFS.
69 <P><I>IBM AFS Release Notes</I>
70 <P>This document provides information specific to each release of AFS, such as
71 a list of new features and commands, a list of requirements and limitations,
72 and instructions for upgrading server and client machines.
73 <HR><H2><A NAME="HDRTYPO_CONV" HREF="auqbg002.htm#ToC_6">Typographical Conventions</A></H2>
74 <P>This document uses the following typographical
75 conventions:
76 <UL>
77 <P><LI>Command and option names appear in <B>bold type</B> in syntax
78 definitions, examples, and running text. Names of directories, files,
79 machines, partitions, volumes, and users also appear in <B>bold
80 type</B>.
81 <P><LI>Variable information appears in <I>italic type</I>. This
82 includes user-supplied information on command lines and the parts of prompts
83 that differ depending on who issues the command. New terms also appear
84 in <I>italic type</I>.
85 <P><LI>Examples of screen output and file contents appear in <TT>monospace
86 type</TT>.
87 </UL>
88 <P>In addition, the following symbols appear in command syntax definitions,
89 both in the documentation and in AFS online help statements. When
90 issuing a command, do not type these symbols. 
91 <UL>
92 <P><LI>Square brackets <B>[   ]</B> surround optional items.
93 <P><LI>Angle brackets <B>&lt;   ></B> surround user-supplied values in AFS
94 commands.
95 <P><LI>A superscripted plus sign <B>+</B> follows an argument that accepts
96 more than one value.
97 <P><LI>The percent sign <TT>%</TT> represents the regular command shell
98 prompt. Some operating systems possibly use a different character for
99 this prompt.
100 <P><LI>The number sign <TT>#</TT> represents the command shell prompt for the
101 local superuser <B>root</B>. Some operating systems possibly use a
102 different character for this prompt.
103 <P><LI>The pipe symbol <B> |</B> in a command syntax statement separates
104 mutually exclusive values for an argument.
105 </UL>
106 <P>For additional information on AFS commands, including a description of
107 command string components, acceptable abbreviations and aliases, and how to
108 get online help for commands, see the appendix to the <I>IBM AFS
109 Administration Guide</I>.
110 <HR><P ALIGN="center"> <A HREF="../index.htm"><IMG SRC="../books.gif" BORDER="0" ALT="[Return to Library]"></A> <A HREF="auqbg002.htm#ToC"><IMG SRC="../toc.gif" BORDER="0" ALT="[Contents]"></A> <A HREF="auqbg002.htm"><IMG SRC="../prev.gif" BORDER="0" ALT="[Previous Topic]"></A> <A HREF="#Top_Of_Page"><IMG SRC="../top.gif" BORDER="0" ALT="[Top of Topic]"></A> <A HREF="auqbg004.htm"><IMG SRC="../next.gif" BORDER="0" ALT="[Next Topic]"></A> <A HREF="auqbg009.htm#HDRINDEX"><IMG SRC="../index.gif" BORDER="0" ALT="[Index]"></A> <P> 
111 <!-- Begin Footer Records  ========================================== -->
112 <P><HR><B> 
113 <br>&#169; <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A>  All Rights Reserved 
114 </B> 
115 <!-- End Footer Records  ============================================ -->
116 <A NAME="Bot_Of_Page"></A>
117 </BODY></HTML>