Document conventions, Text formatting, Command syntax conventions – Brocade Communications Systems Layer 3 Routing Configuration ICX 6650 User Manual

Page 15: Notes, cautions, and warnings

Advertising
background image

Brocade ICX 6650 Layer 3 Routing Configuration Guide

xiii

53-1002603-01

Brocade ICX 6650 slot and port numbering

Document conventions

This section describes text formatting conventions and important notice formats used in this
document.

Text formatting

The narrative-text formatting conventions that are used are as follows:

bold text

Identifies command names
Identifies the names of user-manipulated GUI elements
Identifies keywords and operands
Identifies text to enter at the GUI or CLI

italic text

Provides emphasis
Identifies variables
Identifies paths and Internet addresses
Identifies document titles

code

text

Identifies CLI output
Identifies command syntax examples

For readability, command names in the narrative portions of this guide are presented in mixed
lettercase: for example, switchShow. In actual examples, command lettercase is all lowercase.

Command syntax conventions

Command syntax in this manual follows these conventions:

Notes, cautions, and warnings

The following notices and statements are used in this manual. They are listed below in order of
increasing severity of potential hazards.

NOTE

A note provides a tip, guidance, or advice, emphasizes important information, or provides a
reference to related information.

command

Commands are printed in bold.

--

option, option

Command options are printed in bold.

-

argument, arg

Arguments.

[ ]

Optional elements appear in brackets.

variable

Variables are printed in italics. In the help pages, values are underlined or
enclosed in angled brackets < >.

...

Repeat the previous element, for example “member[;member...]”

value

Fixed values following arguments are printed in plain font. For example,

--

show WWN

|

Boolean. Elements are exclusive. Example:

--

show

-

mode egress | ingress

Advertising