beautypg.com

Preface, Audience, Conventions – H3C Technologies H3C S5820X Series Switches User Manual

Page 3: Command conventions

background image

Preface

H3C S5820X Series Ethernet Switches Installation Manual describes the appearance, installation,

power-on, maintenance, and troubleshooting of the H3C S5820X series Ethernet switches.
This preface includes:

Audience

Conventions

About the H3C S5820X documentation set

Obtaining documentation

Technical support

Documentation feedback

Audience

This documentation is intended for:

Network planners

Field technical support and servicing engineers

Network administrators working with the S5820X series

Conventions

This section describes the conventions used in this documentation set.

Command conventions

Convention Description

Boldface

Bold text represents commands and keywords that you enter literally as shown.

Italic

Italic text represents arguments that you replace with actual values.

[ ]

Square brackets enclose syntax choices (keywords or arguments) that are optional.

{ x | y | ... }

Braces enclose a set of required syntax choices separated by vertical bars, from which
you select one.

[ x | y | ... ]

Square brackets enclose a set of optional syntax choices separated by vertical bars, from
which you select one or none.

{ x | y | ... } *

Asterisk marked braces enclose a set of required syntax choices separated by vertical
bars, from which you select at least one.

[ x | y | ... ] *

Asterisk marked square brackets enclose optional syntax choices separated by vertical
bars, from which you select one choice, multiple choices, or none.

&<1-n>

The argument or keyword and argument combination before the ampersand (&) sign can
be entered 1 to n times.

#

A line that starts with a pound (#) sign is comments.