You are here: Home > CLI Commands > Typographic Conventions

Typographic Conventions

The following conventions are used throughout this manual to emphasize important concepts:

Table 1: Text Conventions

Type Style

Description

Italics

This style is used to emphasize important terms and to mark the titles of books.

Boldface

This style is used to emphasize command names and parameter options when mentioned in the text.

Commands

This fixed-width font depicts command syntax and examples of commands and command output.

<angle brackets>

In the command syntax, text within angle brackets represents items that you should replace with information appropriate to your specific situation. For example:

ping <ipaddr>

In this example, you would type “ping” at the system prompt exactly as shown, followed by the IP address of the system to which ICMPInternet Control Message Protocol. ICMP is an error reporting protocol. It is used by network devices such as routers, to send error messages and operational information to the source IP address when network problems prevent delivery of IP packets. echo packets are to be sent. Do not type the angle brackets.

[square brackets]

In the command syntax, items enclosed in brackets are optional. Do not type the brackets.

{Item_A|Item_B}

In the command examples, single items within curled braces and separated by a vertical bar represent the available choices. Enter only one choice. Do not type the braces or bars.

{ap-name <ap-name>}|{ipaddr <ip-addr>}

Two items within curled braces indicate that both parameters must be entered together. If two or more sets of curled braces are separated by a vertical bar, like in the example to the left, enter only one choice Do not type the braces or bars.

/*]]>*/