# About This Guide

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

## Audience and Purpose

This guide explains how to install and configure OpenAFS server and client machines. It assumes that the reader is familiar with UNIX system administration, but not AFS.

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 OpenAFS Administration Reference as necessary.

## Organization of the Document

See The Procedures Described in this Guide.

## How to Use This Document

See The Procedures Described in this Guide and How to Continue.

## Related Documents

The OpenAFS documentation set also includes the following documents. Large portions of them are as released to the community by IBM, and are not directly applicable to current releases of OpenAFS. This document uses the legacy "Transarc" paths (`/usr/afs`, `/usr/vice`, etc.), which do not correspond to the normal file system hierarchy on many modern machines; the paths may need to be substituted according to the local software installation.

OpenAFS Administration Guide

  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.

  The first chapters of the OpenAFS Administration Guide 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.

OpenAFS Administration Reference

  This reference manual details the syntax and effect of each AFS command. It is intended for the experienced AFS administrator, programmer, or user.

  The OpenAFS Administration Reference 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.

  This manual complements the OpenAFS Administration Guide: it does not include procedural information, but describes commands in more detail than the OpenAFS Administration Guide.

OpenAFS User Guide

  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.

  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.

OpenAFS Release Notes

  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.

## 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 the appendix to the OpenAFS Administration Guide.