About This Document
Document Conventions
This section describes the text format conventions, command syntax, and important notification formats used in this document.
Text
The text format conventions used in this document are as follows:
Format |
Description |
|---|---|
Bold text |
Identifies command names. |
Identifies keywords and operands. |
|
Identifies graphical user interface (GUI) element names. |
|
Identifies text to be entered on the GUI. |
|
Italic text |
Provides emphasis. |
Identifies variables and modifiers. |
|
Identifies paths, directories, and Internet addresses. |
|
Identifies document titles. |
|
Courier font |
Identifies command-line interface (CLI) output. |
Identifies command syntax examples. |
Command Syntax Conventions
The command syntax is expressed in bold and italics. Delimiters and operators define parameter groups and their logical relationships.
Conventions |
Description |
|---|---|
Bold text |
Identifies command names, keywords, and command options. |
Italic text |
Indicates variables. |
Value |
For FC products, the fixed values in commands are expressed in plain text, such as --show WWN. |
[ ] |
Indicates optional elements in a command syntax line. Indicates default response to the system prompt. |
{ x | y | z } |
Indicates a set of choices from which the user must choose one. For FC products, square brackets may be used in this case. |
x | y |
Indicates mutually exclusive elements in a command syntax line. |
< > |
Indicates nonprintable characters (such as passwords). |
... |
Repeats the previous element, for example, member[member...]. |
\ |
Indicates the soft line break in command examples. If a backslash separates two command lines, enter the complete command after the prompt without a backslash. |
Symbol Conventions
The symbols that may be found in this document are defined as follows.
Symbol |
Description |
|---|---|
Indicates a hazard with a high level of risk which, if not avoided, will result in death or serious injury. |
|
Indicates a hazard with a medium level of risk which, if not avoided, could result in death or serious injury. |
|
Indicates a hazard with a low level of risk which, if not avoided, could result in minor or moderate injury. |
|
Indicates a potentially hazardous situation which, if not avoided, could result in equipment damage, data loss, performance deterioration, or unanticipated results. NOTICE is used to address practices not related to personal injury. |
|
Supplements the important information in the main text. NOTE is used to address information not related to personal injury, equipment damage, and environment deterioration. |
Change History
Issue |
Date |
Description |
|---|---|---|
02 |
2020-05-07 |
This issue is the second official release. |
01 |
2019-11-20 |
This issue is the first official release. |
