beautypg.com

Document conventions, Text formatting, Command syntax conventions – Dell POWEREDGE M1000E User Manual

Page 6

background image

vi

M5424 SAN I/O Module Hardware Reference Manual

53-1001082-01

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 often all
lowercase. Otherwise, this manual specifically notes those cases in which a command is case
sensitive.

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

-

mode egress | ingress