beautypg.com

Cli usage conventions, Document conventions, Text formatting – Brocade Fabric OS Command Reference (Supporting Fabric OS v7.3.0) User Manual

Page 26: Command syntax conventions

background image

xxvi

Fabric OS Command Reference

53-1003131-01

CLI usage conventions

Some Fabric OS show commands display certain switch or fabric components in three-digit
decimal numbers, for example, 003. When you use these numeric identifiers as inputs to other
commands, you must remove the leading zeros; otherwise the commands will either fail or
generate incorrect results. Adding zeros to any decimal number in a command input will cause
that number to be treated as an Octal number.

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...]”