Cavium FastLinQ 45000 Series, User Manual

Page: 22 / 342

Preface
Documentation Conventions
xxii BC0154501-00 P
 Text in italics indicates terms, emphasis, variables, or document titles. For
example:
 What are shortcut keys ?
 To enter the date type mm/dd/yyyy (where mm is the month, dd is the
day, and yyyy is the year).
 Topic titles between quotation marks identify related topics either within this
manual or in the online help, which is also referred to as
the help system
throughout this document.
 Command line interface (CLI) command syntax conventions include the
following:
 Plain text indicates items that you must type as shown. For example:

qaucli -pr nic -ei

< >
(angle brackets) indicate a variable whose value you must
specify. For example:

<serial_number>

[ ]
(square brackets) indicate an optional parameter. For example:

[<file_name>]
means specify a file name, or omit it to select
the default file name.

|
(vertical bar) indicates mutually exclusive options; select one option
only. For example:

on|off

1|2|3|4

...
(ellipsis) indicates that the preceding item may be repeated. For
example:

x...
means one or more instances of
x
.

[x...]
means zero or more instances of
x
.

⋮
(vertical ellipsis) within command example output indicate where
portions of repetitious output data have been intentionally omitted.
NOTE
For CLI commands only, variable names are always indicated
using angle brackets instead of
italics .