beautypg.com

Preface, Document conventions, Text formatting conventions – Brocade ICX 6650 Hardware Installation Guide User Manual

Page 7: Command syntax conventions

background image

Preface

Document conventions......................................................................................................5

Brocade resources............................................................................................................ 7

Getting technical help........................................................................................................7

Document feedback.......................................................................................................... 8

Document conventions

The document conventions describe text formatting conventions, command syntax conventions, and
important notice formats used in Brocade technical documentation.

Text formatting conventions

Text formatting conventions such as boldface, italic, or Courier font may be used in the flow of the text
to highlight specific words or phrases.

Format

Description

bold text

Identifies command names

Identifies keywords and operands

Identifies the names of user-manipulated GUI elements

Identifies text to enter at the GUI

italic text

Identifies emphasis

Identifies variables and modifiers

Identifies paths and Internet addresses

Identifies document titles

Courier font

Identifies CLI output

Identifies command syntax examples

Command syntax conventions

Bold and italic text identify command syntax components. Delimiters and operators define groupings of
parameters and their logical relationships.

Convention

Description

bold text

Identifies command names, keywords, and command options.

italic text

Identifies a variable.

Brocade ICX 6650 Hardware Installation Guide

5

53-1003083-01