User Guide
Ampex 1308910-01 1-3
General Information Notational Conventions
1.4 Notational Conventions
This document uses the following typographical conventions:
Bold
In a syntax description, indicates text that must be typed literally. In
other contexts, indicates UNIX command and utility names, program
and application names, and C function names.
Italic
In a syntax description, indicates generic arguments or options; these
should be replaced with user-supplied values. Also used for book titles,
notes in the text requiring special attention, or to
emphasize
terms.
[ ] In a command syntax description, surrounds optional elements. Do not
type the brackets themselves.
| In a command syntax description, separates alternate items. Only one of
the alternate items may be used in any given invocation. Do not type the
| character. In contexts other than syntax descriptions, the | character
stands for the UNIX pipe feature, which directs the output of one
command into another command.
{ } In a command syntax description, groups alternate items. Do not type
the braces themselves.
... In a command syntax description, indicates an element that may be
repeated. Do not type the dots themselves.
Fixed
In an example, indicates computer output or contents of files or
directories. In other contexts, indicates C type names, C symbolic
constants, C structure or member names, file names, and path names.
Fixed Bold
In an example, indicates text typed by the operator.
Note:
In C function prototypes and examples, the special characters above ([ ] | { }) retain
their normal meaning in the C language. The conventions above for the special
characters apply only to command-line syntax descriptions, not to C language
descriptions or examples.
≈
Indicates approximate values.