[openafs.git] / doc / html / UserGuide / auusg003.htm
3 <TITLE>User Guide</TITLE>
4 <!-- Begin Header Records  ========================================== -->
5 <!-- /tmp/idwt3629/auusg000.scr converted by idb2h R4.2 (359) ID      -->
6 <!-- Workbench Version (AIX) on 2 Oct 2000 at 14:38:44                -->
7 <META HTTP-EQUIV="updated" CONTENT="Mon, 02 Oct 2000 14:38:42">
8 <META HTTP-EQUIV="review" CONTENT="Tue, 02 Oct 2001 14:38:42">
9 <META HTTP-EQUIV="expires" CONTENT="Wed, 02 Oct 2002 14:38:42">
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>User Guide</H1>
16 <HR><P ALIGN="center"> <A HREF="../index.htm"><IMG SRC="../books.gif" BORDER="0" ALT="[Return to Library]"></A> <A HREF="auusg002.htm#ToC"><IMG SRC="../toc.gif" BORDER="0" ALT="[Contents]"></A> <A HREF="auusg002.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="auusg004.htm"><IMG SRC="../next.gif" BORDER="0" ALT="[Next Topic]"></A> <A HREF="auusg013.htm#HDRINDEX"><IMG SRC="../index.gif" BORDER="0" ALT="[Index]"></A> <P> 
17 <P>
18 <HR><H1><A NAME="HDRWQ1" HREF="auusg002.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="HDRPREFAUDPUR" HREF="auusg002.htm#ToC_2">Audience and Purpose</A></H2>
22 <P>This guide describes concepts and procedures for
23 accessing information stored in the AFS filespace. It is intended for
24 AFS users who are familiar with UNIX but not necessarily AFS.
25 <P>The first chapter describes basic AFS concepts and guidelines for using it,
26 and summarizes some of the differences between the UNIX file system and
27 AFS. The remaining chapters explain how to perform basic AFS functions,
28 including logging in, changing a password, listing information, protecting
29 files, creating groups, and troubleshooting. Concepts important to a
30 specific task or group of related tasks are presented in context, just prior
31 to the procedures. Many examples are provided.
32 <P>Instructions generally include only the commands and command options
33 necessary for a specific task. For a complete list of AFS commands and
34 description of all options available on every command, see the <I>IBM AFS
35 Administration Reference</I>.
36 <HR><H2><A NAME="HDRPREFORGAN" HREF="auusg002.htm#ToC_3">Document Organization</A></H2>
37 <P>This document is divided into the following
38 chapters.
39 <P><A HREF="auusg004.htm#HDRWQ2">An Introduction to AFS</A> introduces the basic concepts and functions of AFS.
40 To use AFS successfully, it is important to be familiar with the terms and
41 concepts described in this chapter.
42 <P><A HREF="auusg005.htm#HDRWQ20">Using AFS</A> describes how to use AFS's basic features: how to
43 log in and authenticate, unlog, log out, access AFS files and directories in
44 AFS, and change your password.
45 <P><A HREF="auusg006.htm#HDRWQ38">Displaying Information about AFS</A> describes how to display information about AFS volume quota
46 and location, file server machine status, and the foreign cells you can
47 access.
48 <P><A HREF="auusg007.htm#HDRWQ44">Protecting Your Directories and Files</A> describes how to protect your data using AFS access control
49 lists (ACLs).
50 <P><A HREF="auusg008.htm#HDRWQ60">Using Groups</A> describes how to create and manage groups.
51 <P><A HREF="auusg009.htm#HDRWQ76">Troubleshooting</A> outlines step-by-step diagnostic and corrective steps for
52 specific problems.
53 <P><A HREF="auusg010.htm#HDRWQ80">Appendix A,  Using the NFS/AFS Translator</A> describes how to use the NFS/AFS Translator to access the
54 AFS filespace from an NFS client machine.
55 <P><A HREF="auusg011.htm#HDRWQ86">Appendix B,  AFS Command Syntax and Online Help</A> describes AFS command syntax and how to obtain online
56 information about commands.
57 <P><A HREF="auusg012.htm#HDRWQ90">Appendix C,  Glossary</A> defines terms used in the <I>IBM AFS User
58 Guide</I>.
59 <HR><H2><A NAME="HDRUSERFRONTHOWTO" HREF="auusg002.htm#ToC_4">How To Use This Document</A></H2>
60 <P>Before you begin using AFS, read <A HREF="auusg004.htm#HDRWQ2">An Introduction to AFS</A>. Next, follow the procedures
61 outlined in <A HREF="auusg005.htm#HDRWQ20">Using AFS</A> to get started using AFS as an authenticated user. It
62 describes how to access files in the AFS filespace and how to end an AFS
63 session. Consult the other chapters as you need to perform the tasks
64 they describe.
65 <HR><H2><A NAME="HDRPREFRELATE" HREF="auusg002.htm#ToC_5">Related Documents</A></H2>
66 <P>The AFS Documentation Kit also includes the following
67 documents:
68 <UL>
69 <P><LI>The <I>IBM AFS Administration Reference</I> details the syntax of each
70 AFS command and is intended for the experienced AFS administrator, programmer,
71 or user. For each AFS command, the <I>IBM AFS Administration
72 Reference</I> lists the command syntax, aliases and abbreviations,
73 description, arguments, warnings, output, examples, and related topics.
74 Commands are organized alphabetically.
75 <P><LI>The <I>IBM AFS Administration Guide</I> describes concepts and
76 procedures necessary for administering an AFS cell, as well as more extensive
77 coverage of the topics in the <I>IBM AFS User Guide</I>.
78 <P><LI>The <I>IBM AFS Quick Beginnings</I> provides instructions for
79 installing AFS server and client machines.
80 </UL>
81 <HR><H2><A NAME="HDRTYPO_CONV" HREF="auusg002.htm#ToC_6">Typographical Conventions</A></H2>
82 <P>This document uses the following typographical
83 conventions:
84 <UL>
85 <P><LI>Command and option names appear in <B>bold type</B> in syntax
86 definitions, examples, and running text. Names of directories, files,
87 machines, partitions, volumes, and users also appear in <B>bold
88 type</B>.
89 <P><LI>Variable information appears in <I>italic type</I>. This
90 includes user-supplied information on command lines and the parts of prompts
91 that differ depending on who issues the command. New terms also appear
92 in <I>italic type</I>.
93 <P><LI>Examples of screen output and file contents appear in <TT>monospace
94 type</TT>.
95 </UL>
96 <P>In addition, the following symbols appear in command syntax definitions,
97 both in the documentation and in AFS online help statements. When
98 issuing a command, do not type these symbols. 
99 <UL>
100 <P><LI>Square brackets <B>[   ]</B> surround optional items.
101 <P><LI>Angle brackets <B>&lt;   ></B> surround user-supplied values in AFS
102 commands.
103 <P><LI>A superscripted plus sign <B>+</B> follows an argument that accepts
104 more than one value.
105 <P><LI>The percent sign <TT>%</TT> represents the regular command shell
106 prompt. Some operating systems possibly use a different character for
107 this prompt.
108 <P><LI>The number sign <TT>#</TT> represents the command shell prompt for the
109 local superuser <B>root</B>. Some operating systems possibly use a
110 different character for this prompt.
111 <P><LI>The pipe symbol <B> |</B> in a command syntax statement separates
112 mutually exclusive values for an argument.
113 </UL>
114 <P>For additional information on AFS commands, including a description of
115 command string components, acceptable abbreviations and aliases, and how to
116 get online help for commands, see <A HREF="auusg011.htm#HDRWQ86">Appendix B,  AFS Command Syntax and Online Help</A>.
117 <HR><P ALIGN="center"> <A HREF="../index.htm"><IMG SRC="../books.gif" BORDER="0" ALT="[Return to Library]"></A> <A HREF="auusg002.htm#ToC"><IMG SRC="../toc.gif" BORDER="0" ALT="[Contents]"></A> <A HREF="auusg002.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="auusg004.htm"><IMG SRC="../next.gif" BORDER="0" ALT="[Next Topic]"></A> <A HREF="auusg013.htm#HDRINDEX"><IMG SRC="../index.gif" BORDER="0" ALT="[Index]"></A> <P> 
118 <!-- Begin Footer Records  ========================================== -->
119 <P><HR><B> 
120 <br>&#169; <A HREF="">IBM Corporation 2000.</A>  All Rights Reserved 
121 </B> 
122 <!-- End Footer Records  ============================================ -->
123 <A NAME="Bot_Of_Page"></A>
124 </BODY></HTML>