Document Conventions - Hitachi Virtual Storage Platform User And Reference Manual

Document conventions

This document uses the following typographic conventions:
Convention
Bold
Italic
screen/code
< > angled brackets
[ ] square brackets
{ } braces
| vertical bar
This document uses the following icons to draw attention to information:
Icon
x
Indicates text on a window, other than the window title,
including menus, menu options, buttons, fields, and labels.
Example: Click OK.
Indicates a variable, which is a placeholder for actual text
provided by the user or system. Example: copy source-file
target-file
Note: Angled brackets (< >) are also used to indicate
variables.
Indicates text that is displayed on screen or entered by the
user. Example: # pairdisplay -g oradb
Indicates a variable, which is a placeholder for actual text
provided by the user or system. Example: # pairdisplay -g
<group>
Note: Italic font is also used to indicate variables.
Indicates optional values. Example: [ a | b ] indicates that you
can choose a, b, or nothing.
Indicates required or expected values. Example: { a | b }
indicates that you must choose either a or b.
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.
Meaning
Tip Tips provide helpful information, guidelines, or suggestions
for performing tasks more effectively.
Note Notes emphasize or supplement important points of the main
text.
Caution Cautions indicate that failure to take a specified action could
result in damage to the software or hardware.
WARNING Warnings indicate that failure to tae a specified action could
result in loss of data or serious damage to hardware.
ELECTRIC Failure to take appropriate precautions such as not opening
SHOCK or touching hazardous areas of the equipment could result in
HAZARD injury or death.
Preface
Hitachi VSP User and Reference Guide
Description
Description