Documentation Conventions
Table 1 defines notice icons used in this guide.
Table 1: Notice Icons
Icon | Meaning | Description |
---|---|---|
Note: | Informational note | Indicates important features or instructions. |
Caution: | Caution | Indicates a situation that might result in loss of data or hardware damage. |
Warning: | Warning | Alerts you to the risk of personal injury. |
Table 2 describes the text conventions used throughout this manual.
Table 2: Text and Syntax Conventions
Convention | Description | Examples |
---|---|---|
Text Conventions |
|
|
Bold text like this | Represents commands and keywords in text. |
|
Bold text like this | Represents text that the user must type. | host1(config)#traffic class low-loss1 |
Fixed-width text like this | Represents information as displayed on your terminal’s screen. | host1#show ip ospf 2 Routing Process OSPF 2 with Router ID 5.5.0.250 Router is an Area Border Router (ABR) |
Italic text like this |
|
|
Plus sign (+) linking key names | Indicates that you must press two or more keys simultaneously. | Press Ctrl+b. |
Syntax Conventions |
| |
Plain text like this | Represents keywords. | terminal length |
Italic text like this | Represents variables. | mask, accessListName |
< > (angle brackets) | Enclose a list of possible selections. | <add | replace> |
| (pipe symbol) | Represents a choice to select one keyword or variable in a list of choices that is separated by the pipe symbol. | diagnostic | line In this example, you must specify add or replace but cannot specify both: <add | replace> |
[ ] (brackets) | Represent optional keywords or variables. | [ internal | external ], or When they are used in a configuration files brackets identify
a section of the file. |
[ ]* (brackets and asterisk) | Represent optional keywords or variables that can be entered more than once. | [ level1 | level2 | l1 ]* |
{ } (braces) | Represent required keywords or variables. | { permit | deny } { in | out } |