Document conventions – Kentrox AI296 User Manual

Page 4

Advertising
background image

AI296 Version 9.8x User’s Guide

About this Document: Document Conventions

ii

Document Conventions

Table 1

describes the text conventions used in this document.

Table 1 Document Conventions

Convention

Meaning

Screen Text, Menu Items,
System Prompts, Messages
and Reports

This style indicates Kentrox configuration screen text,
menu items, system prompts, messages, and reports.

Static Command Text

In a command statement, this style indicates text that
should be entered exactly as shown at a command line.

Variable Command Text

In a command statement, this style indicates
user-specified text.

...

In a command statement, ellipses (

...

) signify that the

preceding parameter can be repeated a number of
times.

[ ]

[ | ]

In a command statement, square brackets indicate an
optional parameter. Two or more parameters in square
brackets with a vertical bar ( | ) between them indicate a
choice of optional parameters.

{ | }

In a command statement, two or more parameters in
braces with a vertical bar ( | ) between them indicate a
choice of required parameters.

Variable Field Text

This style indicates variable information you type in a
dialog box field.

KEYS

Uppercase body text indicates keys on a keyboard,
such as the TAB or ENTER keys. Keys used in
combination are connected with a plus symbol (+).

Labels

This style designates physical components on Kentrox
products such as jumpers, switches, and cable
connectors.



Note:

Note messages emphasize or supplement important
points of the main text.

Important:

Important messages provide information that is
essential to the completion of a task.

Tip:

Tip messages provide information that assists users in
operating equipment more effectively.

Advertising