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:

command

Commands are printed in bold.

--option, option

Command options are printed in bold.

-argument, arg

Arguments.

[ ]

Optional element.

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-modeegress ingress

Command examples

This book describes how to perform configuration tasks using the switch module command line interface, but does not describe the commands in detail.

viii

Dell M8428-k Hardware Reference Manual

 

53-1001980-01

Page 8
Image 8
Dell M8428-K manual Document conventions, Text formatting, Command syntax conventions, Command examples