Text Conventions

Unless otherwise noted, information in this document applies to all supported environments for the products in question. Exceptions, like command keywords associated with a specific software version, are identified in the text.

When a feature, function, or operation pertains to a specific hardware product, the product name is used. When features, functions, and operations are the same across an entire product family, such as ExtremeSwitching switches or SLX routers, the product is referred to as the switch or the router.

Table 1. Notes and warnings
Icon Notice type Alerts you to...
Tip icon Tip Helpful tips and notices for using the product
Note icon Note Useful information or instructions
Important icon Important Important features or instructions
Caution icon Caution Risk of personal injury, system damage, or loss of data
Warning icon Warning Risk of severe personal injury
Table 2. Text
Convention Description
screen displays This typeface indicates command syntax, or represents information as it is displayed on the screen.
The words enter and type When you see the word enter in this guide, you must type something, and then press the Return or Enter key. Do not press the Return or Enter key when an instruction simply says type.
Key names Key names are written in boldface, for example Ctrl or Esc. If you must press two or more keys simultaneously, the key names are linked with a plus sign (+). Example: Press Ctrl+Alt+Del
Words in italicized type Italics emphasize a point or denote new terms at the place where they are defined in the text. Italics are also used when referring to publication titles.
Icon for new information New information. In a PDF, this is searchable text.
Table 3. Command syntax
Convention Description
bold text Bold text indicates command names, keywords, and command options.
italic text Italic text indicates variable content.

[ ]

Syntax components displayed within square brackets are optional.

Default responses to system prompts are enclosed in square brackets.

{ x | y | z }

A choice of required parameters is enclosed in curly brackets separated by vertical bars. You must select one of the options.

x | y

A vertical bar separates mutually exclusive elements.

< >

Nonprinting characters, such as passwords, are enclosed in angle brackets.


Repeat the previous element, for example, member[member...].


In command examples, the backslash indicates a “soft” line break. When a backslash separates two lines of a command input, enter the entire command at the prompt without the backslash.