Document conventions, Text formatting, Command syntax conventions – Brocade BigIron RX Series Configuration Guide User Manual

Page 77: Notes and cautions

Advertising
background image

BigIron RX Series Configuration Guide

lxxvii

53-1002484-04

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:

Command syntax conventions

Command syntax in this manual follows these conventions:

Notes and cautions

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

NOTE

A note provides a tip, guidance or advice, emphasizes important information, or provides a reference
to related information.

CAUTION

A Caution statement alerts you to situations that can be potentially hazardous to you or cause
damage to hardware, firmware, software, or data.

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 document titles

code

text

Identifies CLI output

command and
parameters

Commands and parameters are printed in bold.

[ ]

Optional parameter.

variable

Variables are printed in italics enclosed in angled brackets < >.

...

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

|

Choose from one of the parameters.

Advertising