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
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, Using AFS Commands.