beautypg.com

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

Page 24

background image

xxiv

Fabric OS Command Reference

53-1002746-01

Automatic page breaks in CLI command output displays are being phased out. Use the more option
to display command output with page breaks: command | more. Do not use the more option in
conjunction with help pages. Executing help command | more will display a command “no manual
entry for command” message.

Document conventions

This section describes text formatting conventions and important notices formats.

Text formatting

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

bold text

Identifies command names
Identifies 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 syntax examples

For readability, command names in the command titles and in the narrative portions of this guide are
presented in mixed letter case, for example, switchShow. In examples, command letter case is all
lowercase.

Command syntax conventions

Command syntax in this document follows these conventions:

command

Commands are printed in bold.

--option, option

Command options are printed in bold.

-argument, arg

Arguments are printed in bold.

[ ]

Optional element.

variable

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

...

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

value

Fixed (literal) values following arguments are printed in plain font. For example,
--show WWN

|

Boolean. Elements are exclusive. Example: --show -mode egress | ingress

\

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