Document Conventions
Command descriptions use the following conventions:
| Convention | Description |
|---|---|
| bold |
Bold text indicates the commands and keywords that you enter literally as shown. |
| Italic |
Italic text indicates arguments for which the user supplies the values. |
| [x] |
Square brackets enclose an optional element (keyword or argument). |
| [x | y] |
Square brackets enclosing keywords or arguments separated by a vertical bar indicate an optional choice. |
| {x | y} |
Braces enclosing keywords or arguments separated by a vertical bar indicate a required choice. |
| [x {y | z}] |
Nested set of square brackets or braces indicate optional or required choices within optional or required elements. Braces and a vertical bar within square brackets indicate a required choice within an optional element. |
variable
|
Indicates a variable for which you supply values, in context where italics cannot be used. |
| string | A nonquoted set of characters. Do not use quotation marks around the string or the string will include the quotation marks. |
Examples use the following conventions:
| Convention | Description |
|---|---|
screen font
|
Terminal sessions and information the switch displays are in screen font. |
boldface screen font
|
Information you must enter is in boldface screen font. |
| italic screen font |
Arguments for which you supply values are in italic screen font. |
| < > |
Nonprinting characters, such as passwords, are in angle brackets. |
| [ ] |
Default responses to system prompts are in square brackets. |
| !, # |
An exclamation point (!) or a pound sign (#) at the beginning of a line of code indicates a comment line. |
This document uses the following conventions:
 Note |
Means reader take note. Notes contain helpful suggestions or references to material not covered in the manual. |
 Caution |
Means reader be careful. In this situation, you might do something that could result in equipment damage or loss of data. |
 Warning |
IMPORTANT SAFETY INSTRUCTIONS This warning symbol means danger. You are in a situation that could cause bodily injury. Before you work on any equipment, be aware of the hazards involved with electrical circuitry and be familiar with standard practices for preventing accidents. Use the statement number provided at the end of each warning to locate its translation in the translated safety warnings that accompanied this device. SAVE THESE INSTRUCTIONS |
Feedback