# About This Manual

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

## Audience and Purpose

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

In general, this document does not explain when to use a command or its place in the sequence of commands that make up a complete procedure. For that type of information, refer to the OpenAFS Administration Guide.

## Organization

This document presents OpenAFS files and commands in separate sections, with the files or commands in alphabetical order.

The following sections of each reference page provide the indicated type of information:

- Purpose briefly describes the command's function.

- Synopsis displays the complete syntax statement for a command, which specifies the required order for all options, using the same notation as the OpenAFS online help. If abbreviating the command name a nd option names is acceptable, as it is for most commands, a second statement specifies the shortest acceptable abbreviation of each name. If the command has an alias, it also appears in this section.

- Description describes the file or command's function in detail.

- Cautions describes restrictions, requirements, and potential complications in use of the command. It appears only when necessary.

- Options describes the function and required form of each argument and flag.

- Output describes any output the command writes to the standard output stream. This section does not appear if the command does not produce output or if the only output is a message confirming the command's success.

- Examples provides one or more sample commands and resulting output.

- Privilege Required lists each privilege required to perform the command.

- Related Information lists related commands and files, if any.

## How to Use This Document

Refer to this document when you need detailed information about a specific command. For a description of all the steps in a procedure, refer to the OpenAFS Administration Guide.

## Related Documents

The following documents are included in the OpenAFS documentation set.

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 Quick Beginnings

This guide provides instructions for installing OpenAFS server and client machines. It is assumed that the installer is an experienced UNIX(R) system administrator.

For predictable performance, machines must be installed and configured in accordance with the instructions in this guide.

OpenAFS Release Notes

This document provides information specific to each release of OpenAFS, such as a list of new features and commands, a list of requirements and limitations, and instructions for upgrading server and client machines.

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.

## 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 OpenAFS online help statements. When issuing a command, do not type these symbols.

- Square brackets [ ] surround optional items.

- Angle brackets < > surround user-supplied values in OpenAFS 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.