beautypg.com

I. command conventions, Ii. gui conventions, Iii. symbols – H3C Technologies H3C S9500 Series Switches User Manual

Page 4

background image

Conventions

The manual uses the following conventions:

I. Command conventions

Convention

Description

Boldface

The keywords of a command line are in Boldface.

italic

Command arguments are in italic.

[ ]

Items (keywords or arguments) in square brackets [ ] are
optional.

{ x | y | ... }

Alternative items are grouped in braces and separated by
vertical bars. One is selected.

[ x | y | ... ]

Optional alternative items are grouped in square brackets
and separated by vertical bars. One or none is selected.

{ x | y | ... } *

Alternative items are grouped in braces and separated by
vertical bars. A minimum of one or a maximum of all can be
selected.

[ x | y | ... ] *

Optional alternative items are grouped in square brackets
and separated by vertical bars. Many or none can be
selected.

#

A line starting with the # sign is comments.

II. GUI conventions

Convention

Description

< >

Button names are inside angle brackets. For example, click
.

[ ]

Window names, menu items, data table and field names
are inside square brackets. For example, pop up the [New
User] window.

/

Multi-level menus are separated by forward slashes. For
example, [File/Create/Folder].

III. Symbols

Convention

Description

Warning

Means reader be extremely careful. Improper operation
may cause bodily injury.

Caution

Means reader be careful. Improper operation may cause
data loss or damage to equipment.

Note

Means a complementary description.