Administration Reference

Organization

This document presents AFS 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 AFS online help. If abbreviating the command name and 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.