[Contents] [Prev] [Next] [Index] [Report an Error]


Table 1, Table 2, and Table 3 list all the conventions used in the ERX documentation. Table 1 defines notice icons. Table 2 shows text conventions used throughout the book, except for command syntax. Table 3 provides command syntax conventions used primarily in the ERX Command Reference Guide. For more information about command syntax, see ERX System Basics Configuration Guide, Chapter 1, Planning Your Network.

Table 1 Notice icons 
Informational note
Indicates important features or instructions.
Indicates that you may risk losing data or damaging your hardware.
Alerts you to the risk of personal injury.

Table 2 Text conventions (except for command syntax) 
Bold typeface
Represents commands and keywords in text.
  • Command example:
    Issue the clock source command.
  • Keyword example:
    Specify the keyword exp-msg.
Bold Courier typeface
Represents text that the user must type.
user input
Key name in angle brackets
Indicates the name of a key on the keyboard.
Press <Enter>.
Key names linked with a plus sign (+) in angle brackets.
Indicates that you must press two or more keys simultaneously.
Press <Ctrl+B>.
Plain Courier typeface
Represents information as displayed on your terminal's screen.
host1#show ip ospf 2
Routing Process OSPF 2 with 
Router ID
Router is an Area Border 
Router (ABR)
  • Emphasize words.
  • Identify variables.
  • Identify chapter, appendix, and book names.
  • There are two levels of access, user and privileged.
  • clusterId, ipAddress.
  • Appendix A, System Specifications.

Table 3 Syntax conventions in Command Reference Guide 
Words in plain text
Represent keywords.
terminal length
Words in italics
Represent variables.
mask, accessListName
Words separated by the | symbol
Represent a choice to select one keyword or variable to the left or right of this symbol. (The keyword or variable may be either optional or required.)
diagnostic | line
Words enclosed in [ brackets ]
Represent optional keywords or variables.
[ internal | external ]
Words enclosed in [ brackets ]*
Represent optional keywords or variables that can be entered more than once.
[ level1 | level2 | l1 ]*
Words enclosed in { braces }
Represent required keywords or variables.
{ permit | deny } { in | out }
clusterId | ipAddress }

[Contents] [Prev] [Next] [Index] [Report an Error]