Convention Description
Italic
■
Indicates a document title or emphasized wor
ds 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 g
roup
(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
br
ackets
Indicates variables in the following scenarios:
■
Variables are not clearly separated from the surrounding text or
from other variables. Example:
Status-<r
eport-name><file-version>.csv
■
Variables in headings.
[ ] square
br
ackets
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 mor
e eectively.
Caution Warns the user of adverse conditions and/or consequences
(for example, disruptive operations, data loss, or a system
crash).
Document conventions
Preface
System Administrator Guide for VSP Gx00 models and VSP Fx00 models 15