Document conventions

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:

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 syntax conventions

Command syntax in this manual follows these conventions:

command and

Commands and parameters are printed in bold.

parameters

 

[ ]

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.

Command examples

This document describes how to perform simple upgrade and configuration tasks using the command line interface (CLI), but does not describe the commands in detail. For complete descriptions of commands for Brocade MLX Series and Brocade NetIron XMR routers, see the Brocade MLX Series and Brocade NetIron Family Configuration Guide.

Notes, cautions, and danger notices

The following notices and danger 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.

Brocade MLX Series and NetIron XMR Hardware Installation Guide

xv

53-1002373-02

 

Page 15
Image 15
Brocade Communications Systems 53-1002373-02 manual Document conventions, Bold text, Command Parameters