quickstart-solaris-pam-20070423
[openafs.git] / doc / xml / UserGuide / f24.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <HTML
3 ><HEAD
4 ><TITLE
5 >About This Guide</TITLE
6 ><META
7 NAME="GENERATOR"
8 CONTENT="Modular DocBook HTML Stylesheet Version 1.7"><LINK
9 REL="HOME"
10 TITLE="AFS User Guide"
11 HREF="book1.html"><LINK
12 REL="PREVIOUS"
13 TITLE="AFS User Guide"
14 HREF="book1.html"><LINK
15 REL="NEXT"
16 TITLE="An Introduction to AFS"
17 HREF="c113.html"></HEAD
18 ><BODY
19 CLASS="preface"
20 BGCOLOR="#FFFFFF"
21 TEXT="#000000"
22 LINK="#0000FF"
23 VLINK="#840084"
24 ALINK="#0000FF"
25 ><DIV
26 CLASS="NAVHEADER"
27 ><TABLE
28 SUMMARY="Header navigation table"
29 WIDTH="100%"
30 BORDER="0"
31 CELLPADDING="0"
32 CELLSPACING="0"
33 ><TR
34 ><TH
35 COLSPAN="3"
36 ALIGN="center"
37 >AFS User Guide: Version 3.6</TH
38 ></TR
39 ><TR
40 ><TD
41 WIDTH="10%"
42 ALIGN="left"
43 VALIGN="bottom"
44 ><A
45 HREF="book1.html"
46 ACCESSKEY="P"
47 >Prev</A
48 ></TD
49 ><TD
50 WIDTH="80%"
51 ALIGN="center"
52 VALIGN="bottom"
53 ></TD
54 ><TD
55 WIDTH="10%"
56 ALIGN="right"
57 VALIGN="bottom"
58 ><A
59 HREF="c113.html"
60 ACCESSKEY="N"
61 >Next</A
62 ></TD
63 ></TR
64 ></TABLE
65 ><HR
66 ALIGN="LEFT"
67 WIDTH="100%"></DIV
68 ><DIV
69 CLASS="preface"
70 ><H1
71 ><A
72 NAME="HDRWQ1"
73 ></A
74 >About This Guide</H1
75 ><P
76 >This section describes the purpose, organization, and conventions of this document.</P
77 ><DIV
78 CLASS="sect1"
79 ><H1
80 CLASS="sect1"
81 ><A
82 NAME="HDRPREFAUDPUR"
83 >Audience and Purpose</A
84 ></H1
85 ><P
86 >This guide describes concepts and procedures for accessing information stored in the AFS filespace. It is intended for AFS
87     users who are familiar with UNIX but not necessarily AFS.</P
88 ><P
89 >The first chapter describes basic AFS concepts and guidelines for using it, and summarizes some of the differences between
90     the UNIX file system and AFS. The remaining chapters explain how to perform basic AFS functions, including logging in, changing
91     a password, listing information, protecting files, creating groups, and troubleshooting. Concepts important to a specific task
92     or group of related tasks are presented in context, just prior to the procedures. Many examples are provided.</P
93 ><P
94 >Instructions generally include only the commands and command options necessary for a specific task. For a complete list of
95     AFS commands and description of all options available on every command, see the <SPAN
96 CLASS="emphasis"
97 ><I
98 CLASS="emphasis"
99 >IBM AFS Administration
100     Reference</I
101 ></SPAN
102 >.</P
103 ></DIV
104 ><DIV
105 CLASS="sect1"
106 ><H1
107 CLASS="sect1"
108 ><A
109 NAME="HDRPREFORGAN"
110 >Document Organization</A
111 ></H1
112 ><P
113 >This document is divided into the following chapters.</P
114 ><P
115 ><A
116 HREF="c113.html"
117 >An Introduction to AFS</A
118 > introduces the basic concepts and functions of AFS. To use AFS
119     successfully, it is important to be familiar with the terms and concepts described in this chapter.</P
120 ><P
121 ><A
122 HREF="c569.html"
123 >Using AFS</A
124 > describes how to use AFS's basic features: how to log in and authenticate, unlog,
125     log out, access AFS files and directories in AFS, and change your password.</P
126 ><P
127 ><A
128 HREF="c1095.html"
129 >Displaying Information about AFS</A
130 > describes how to display information about AFS volume
131     quota and location, file server machine status, and the foreign cells you can access.</P
132 ><P
133 ><A
134 HREF="c1444.html"
135 >Protecting Your Directories and Files</A
136 > describes how to protect your data using AFS access
137     control lists (ACLs).</P
138 ><P
139 ><A
140 HREF="c2454.html"
141 >Using Groups</A
142 > describes how to create and manage groups.</P
143 ><P
144 ><A
145 HREF="c3402.html"
146 >Troubleshooting</A
147 > outlines step-by-step diagnostic and corrective steps for specific
148     problems.</P
149 ><P
150 ><A
151 HREF="a3632.html"
152 >Appendix A, Using the NFS/AFS Translator</A
153 > describes how to use the NFS/AFS Translator to
154     access the AFS filespace from an NFS client machine.</P
155 ><P
156 ><A
157 HREF="a3812.html"
158 >Appendix B, AFS Command Syntax and Online Help</A
159 > describes AFS command syntax and how to
160     obtain online information about commands.</P
161 ><P
162 ><A
163 HREF="g4153.html"
164 >Appendix C, Glossary</A
165 > defines terms used in the <SPAN
166 CLASS="emphasis"
167 ><I
168 CLASS="emphasis"
169 >IBM AFS User
170     Guide</I
171 ></SPAN
172 >.</P
173 ></DIV
174 ><DIV
175 CLASS="sect1"
176 ><H1
177 CLASS="sect1"
178 ><A
179 NAME="HDRUSERFRONTHOWTO"
180 >How To Use This Document</A
181 ></H1
182 ><P
183 >Before you begin using AFS, read <A
184 HREF="c113.html"
185 >An Introduction to AFS</A
186 >. Next, follow the procedures
187     outlined in <A
188 HREF="c569.html"
189 >Using AFS</A
190 > to get started using AFS as an authenticated user. It describes how to
191     access files in the AFS filespace and how to end an AFS session. Consult the other chapters as you need to perform the tasks
192     they describe.</P
193 ></DIV
194 ><DIV
195 CLASS="sect1"
196 ><H1
197 CLASS="sect1"
198 ><A
199 NAME="HDRPREFRELATE"
200 >Related Documents</A
201 ></H1
202 ><P
203 >The AFS Documentation Kit also includes the following documents:
204
205     <UL
206 ><LI
207 ><P
208 >The <SPAN
209 CLASS="emphasis"
210 ><I
211 CLASS="emphasis"
212 >IBM AFS Administration Reference</I
213 ></SPAN
214 > details the syntax of each AFS command and is intended for
215         the experienced AFS administrator, programmer, or user. For each AFS command, the <SPAN
216 CLASS="emphasis"
217 ><I
218 CLASS="emphasis"
219 >IBM AFS Administration
220         Reference</I
221 ></SPAN
222 > lists the command syntax, aliases and abbreviations, description, arguments, warnings, output,
223         examples, and related topics. Commands are organized alphabetically.</P
224 ></LI
225 ><LI
226 ><P
227 >The <SPAN
228 CLASS="emphasis"
229 ><I
230 CLASS="emphasis"
231 >IBM AFS Administration Guide</I
232 ></SPAN
233 > describes concepts and procedures necessary for administering an
234         AFS cell, as well as more extensive coverage of the topics in the <SPAN
235 CLASS="emphasis"
236 ><I
237 CLASS="emphasis"
238 >IBM AFS User Guide</I
239 ></SPAN
240 >.</P
241 ></LI
242 ><LI
243 ><P
244 >The <SPAN
245 CLASS="emphasis"
246 ><I
247 CLASS="emphasis"
248 >IBM AFS Quick Beginnings</I
249 ></SPAN
250 > provides instructions for installing AFS server and client
251         machines.</P
252 ></LI
253 ></UL
254 >
255 </P
256 ></DIV
257 ><DIV
258 CLASS="sect1"
259 ><H1
260 CLASS="sect1"
261 ><A
262 NAME="HDRTYPO_CONV"
263 >Typographical Conventions</A
264 ></H1
265 ><P
266 >This document uses the following typographical conventions:
267
268     <UL
269 ><LI
270 ><P
271 >Command and option names appear in <SPAN
272 CLASS="bold"
273 ><B
274 CLASS="emphasis"
275 >bold type</B
276 ></SPAN
277 > in syntax definitions, examples, and
278         running text. Names of directories, files, machines, partitions, volumes, and users also appear in <SPAN
279 CLASS="bold"
280 ><B
281 CLASS="emphasis"
282 >bold type</B
283 ></SPAN
284 >.</P
285 ></LI
286 ><LI
287 ><P
288 >Variable information appears in <SPAN
289 CLASS="emphasis"
290 ><I
291 CLASS="emphasis"
292 >italic type</I
293 ></SPAN
294 >. This includes user-supplied information on command
295         lines and the parts of prompts that differ depending on who issues the command. New terms also appear in <SPAN
296 CLASS="emphasis"
297 ><I
298 CLASS="emphasis"
299 >italic
300         type</I
301 ></SPAN
302 >.</P
303 ></LI
304 ><LI
305 ><P
306 >Examples of screen output and file contents appear in <SAMP
307 CLASS="computeroutput"
308 >monospace type</SAMP
309 >.</P
310 ></LI
311 ></UL
312 >
313 </P
314 ><P
315 >In addition, the following symbols appear in command syntax definitions, both in the documentation and in AFS online help
316     statements. When issuing a command, do not type these symbols.
317
318     <UL
319 ><LI
320 ><P
321 >Square brackets <SPAN
322 CLASS="bold"
323 ><B
324 CLASS="emphasis"
325 >[ ]</B
326 ></SPAN
327 > surround optional items.</P
328 ></LI
329 ><LI
330 ><P
331 >Angle brackets <SPAN
332 CLASS="bold"
333 ><B
334 CLASS="emphasis"
335 >&#60; &#62;</B
336 ></SPAN
337 > surround user-supplied values in AFS commands.</P
338 ></LI
339 ><LI
340 ><P
341 >A superscripted plus sign <SPAN
342 CLASS="bold"
343 ><B
344 CLASS="emphasis"
345 >+</B
346 ></SPAN
347 > follows an argument that accepts more than one
348         value.</P
349 ></LI
350 ><LI
351 ><P
352 >The percent sign <SAMP
353 CLASS="computeroutput"
354 >%</SAMP
355 > represents the regular command shell prompt. Some operating
356         systems possibly use a different character for this prompt.</P
357 ></LI
358 ><LI
359 ><P
360 >The number sign <SAMP
361 CLASS="computeroutput"
362 >#</SAMP
363 > represents the command shell prompt for the local superuser
364         <SPAN
365 CLASS="bold"
366 ><B
367 CLASS="emphasis"
368 >root</B
369 ></SPAN
370 >. Some operating systems possibly use a different character for this prompt.</P
371 ></LI
372 ><LI
373 ><P
374 >The pipe symbol <SPAN
375 CLASS="bold"
376 ><B
377 CLASS="emphasis"
378 >|</B
379 ></SPAN
380 > in a command syntax statement separates mutually exclusive values
381         for an argument.</P
382 ></LI
383 ></UL
384 >
385 </P
386 ><P
387 >For additional information on AFS commands, including a description of command string components, acceptable abbreviations
388     and aliases, and how to get online help for commands, see <A
389 HREF="a3812.html"
390 >Appendix B, AFS Command Syntax and Online
391     Help</A
392 >.</P
393 ></DIV
394 ></DIV
395 ><DIV
396 CLASS="NAVFOOTER"
397 ><HR
398 ALIGN="LEFT"
399 WIDTH="100%"><TABLE
400 SUMMARY="Footer navigation table"
401 WIDTH="100%"
402 BORDER="0"
403 CELLPADDING="0"
404 CELLSPACING="0"
405 ><TR
406 ><TD
407 WIDTH="33%"
408 ALIGN="left"
409 VALIGN="top"
410 ><A
411 HREF="book1.html"
412 ACCESSKEY="P"
413 >Prev</A
414 ></TD
415 ><TD
416 WIDTH="34%"
417 ALIGN="center"
418 VALIGN="top"
419 ><A
420 HREF="book1.html"
421 ACCESSKEY="H"
422 >Home</A
423 ></TD
424 ><TD
425 WIDTH="33%"
426 ALIGN="right"
427 VALIGN="top"
428 ><A
429 HREF="c113.html"
430 ACCESSKEY="N"
431 >Next</A
432 ></TD
433 ></TR
434 ><TR
435 ><TD
436 WIDTH="33%"
437 ALIGN="left"
438 VALIGN="top"
439 >AFS User Guide</TD
440 ><TD
441 WIDTH="34%"
442 ALIGN="center"
443 VALIGN="top"
444 >&nbsp;</TD
445 ><TD
446 WIDTH="33%"
447 ALIGN="right"
448 VALIGN="top"
449 >An Introduction to AFS</TD
450 ></TR
451 ></TABLE
452 ></DIV
453 ></BODY
454 ></HTML
455 >