Document Conventions
Table 1 defines the notice icons used in this guide.
Table 1: Notice Icons
Icon |
Meaning |
Description |
---|---|---|
![]() |
Informational note |
Indicates important features or instructions. |
![]() |
Caution |
Indicates a situation that might result in loss of data or hardware damage. |
![]() |
Warning |
Alerts you to the risk of personal injury or death. |
![]() |
Laser warning |
Alerts you to the risk of personal injury from a laser. |
![]() |
Tip |
Indicates helpful information. |
![]() |
Best practice |
Alerts you to a recommended use or implementation. |
Table 2 defines the text and syntax conventions used in this guide.
Table 2: Text and Syntax Conventions
Convention |
Description |
Examples |
---|---|---|
Bold text like this |
Represents text that you type. |
To enter configuration mode, type the configure command:
user@host> configure
|
Fixed-width text like this |
Represents output that appears on the terminal screen. |
user@host> show chassis alarms No alarms currently active |
Italic text like this |
|
|
Italic text like this |
Represents variables (options for which you substitute a value) in commands or configuration statements. |
Configure the machine’s domain name:
[edit]
root@# set system domain-name
domain-name
|
Text like this |
Represents names of configuration statements, commands, files, and directories; configuration hierarchy levels; or labels on routing platform components. |
|
< > (angle brackets) |
Encloses optional keywords or variables. |
stub <default-metric metric>; |
| (pipe symbol) |
Indicates a choice between the mutually exclusive keywords or variables on either side of the symbol. The set of choices is often enclosed in parentheses for clarity. |
broadcast | multicast (string1 | string2 | string3) |
# (pound sign) |
Indicates a comment specified on the same line as the configuration statement to which it applies. |
rsvp { # Required for dynamic MPLS only |
[ ] (square brackets) |
Encloses a variable for which you can substitute one or more values. |
community name members [ community-ids ] |
Indention and braces ( { } ) |
Identifies a level in the configuration hierarchy. |
[edit]
routing-options {
static {
route default {
nexthop address;
retain;
}
}
}
|
; (semicolon) |
Identifies a leaf statement at a configuration hierarchy level. |
|
GUI Conventions | ||
Bold text like this |
Represents graphical user interface (GUI) items you click or select. |
|
> (bold right angle bracket) |
Separates levels in a hierarchy of menu selections. |
In the configuration editor hierarchy, select Protocols>Ospf. |