Convention
Description
Italic
■
Indicates a document title or emphasized words in text.
■
Indicates a variable, which is a placeholder for actual text provided
by the user or for output by the system. Example:
pairdisplay -g
group
(For exceptions to this convention for variables, see the entry for
angle brackets.)
Monospace
Indicates text that is displayed on screen or entered by the user.
Example:
pairdisplay -g oradb
< > angle
brackets
Indicates variables in the following scenarios:
■
Variables are not clearly separated from the surrounding text or
from other variables. Example:
Status-<
report-name
><
file-version
>.csv
■
Variables in headings.
[ ] square
brackets
Indicates optional values. Example: [ a | b ] indicates that you can
choose a, b, or nothing.
{ } braces
Indicates required or expected values. Example: { a | b } indicates that
you must choose either a or b.
| vertical bar
Indicates that you have a choice between two or more options or
arguments. Examples:
[ a | b ] indicates that you can choose a, b, or nothing.
{ a | b } indicates that you must choose either a or b.
This document uses the following icons to draw attention to information:
Icon
Label
Description
Note
Calls attention to important or additional information.
Tip
Provides helpful information, guidelines, or suggestions for
performing tasks more effectively.
Caution
Warns the user of adverse conditions and/or consequences (for
example, disruptive operations, data loss, or a system crash).
Document conventions
Preface
VSP N400, N600 Hardware Reference Guide
9
