# About This Guide

This section describes the purpose, organization, and conventions of this document.

## Audience and Purpose

This guide describes concepts and procedures for accessing information stored in the AFS filespace. It is intended for AFS users who are familiar with UNIX but not necessarily AFS.

The first chapter describes basic AFS concepts and guidelines for using it, and summarizes some of the differences between the UNIX file system and AFS. The remaining chapters explain how to perform basic AFS functions, including logging in, changing a password, listing information, protecting files, creating groups, and troubleshooting. Concepts important to a specific task or group of related tasks are presented in context, just prior to the procedures. Many examples are provided.

Instructions generally include only the commands and command options necessary for a specific task. For a complete list of AFS commands and description of all options available on every command, see the OpenAFS Administration Reference.

## Document Organization

This document is divided into the following chapters.

An Introduction to OpenAFS introduces the basic concepts and functions of AFS. To use AFS successfully, it is important to be familiar with the terms and concepts described in this chapter.

Using OpenAFS describes how to use AFS's basic features: how to log in and authenticate, unlog, log out, access AFS files and directories in AFS, and change your password.

Displaying Information about OpenAFS describes how to display information about AFS volume quota and location, file server machine status, and the foreign cells you can access.

Protecting Your Directories and Files describes how to protect your data using AFS access control lists (ACLs).

Using Groups describes how to create and manage groups.

Troubleshooting outlines step-by-step diagnostic and corrective steps for specific problems.

Appendix A, Using the NFS/AFS Translator describes how to use the NFS/AFS Translator to access the AFS filespace from an NFS client machine.

Appendix B, OpenAFS Command Syntax and Online Help describes AFS command syntax and how to obtain online information about commands.

Appendix C, Glossary defines terms used in the OpenAFS User Guide.

## How To Use This Document

Before you begin using OpenAFS, read An Introduction to OpenAFS. Next, follow the procedures outlined in Using OpenAFS to get started using OpenAFS as an authenticated user. It describes how to access files in the AFS filespace and how to end an AFS session. Consult the other chapters as you need to perform the tasks they describe.

## Related Documents

The AFS Documentation Kit also includes the following documents:

- The OpenAFS Administration Reference details the syntax of each AFS command and is intended for the experienced AFS administrator, programmer, or user. For each AFS command, the OpenAFS Administration Reference lists the command syntax, aliases and abbreviations, description, arguments, warnings, output, examples, and related topics. Commands are organized alphabetically.

- The OpenAFS Administration Guide describes concepts and procedures necessary for administering an AFS cell, as well as more extensive coverage of the topics in the OpenAFS User Guide.

- The OpenAFS Quick Beginnings provides instructions for installing AFS server and client machines.

## Typographical Conventions

This document uses the following typographical conventions:

- Command and option names appear in bold type in syntax definitions, examples, and running text. Names of directories, files, machines, partitions, volumes, and users also appear in bold type.

- Variable information appears in italic type. 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 italic type.

- Examples of screen output and file contents appear in `monospace type`.

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.

- Square brackets [ ] surround optional items.

- Angle brackets < > surround user-supplied values in AFS commands.

- A superscripted plus sign + follows an argument that accepts more than one value.

- The percent sign `%` represents the regular command shell prompt. Some operating systems possibly use a different character for this prompt.

- The number sign `#` represents the command shell prompt for the local superuser root. Some operating systems possibly use a different character for this prompt.

- The pipe symbol | in a command syntax statement separates mutually exclusive values for an argument.

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 Appendix B, OpenAFS Command Syntax and Online Help.