beautypg.com

Document conventions, Text formatting, Command syntax conventions – Brocade ICX 7750 Hardware Installation Guide User Manual

Page 8

background image

viii

Brocade ICX 7750 Hardware Installation Guide

53-1003084-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:

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 danger notices

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

bold text

Identifies command names

Identifies the names of user-manipulated GUI elements

Identifies keywords

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

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