Users Guide

Table Of Contents
Preface
Conventions for Interactive Commands
Doc. No. TD-000947 Rev. 1
Janurary 29, 2021 Page xv Copyright © 2021 Marvell
[] (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.
() (parentheses) and { } (braces) are used to avoid logical ambiguity. For
example:
a|b c is ambiguous
{(a|b) c} means a or b, followed by c
{a|(b c)} means either a, or b c
Conventions for Interactive Commands
Documentation conventions that are specific to the menu-driven CLI commands
include the following:
Breadcrumbs line: Section headings for interactive commands include a
breadcrumbs line that shows the sequence of menu options from the Main
Menu to the current topic.
For example, the following breadcrumbs line shows
that you access the Flash Update option by selecting option 3 (on the Main
Menu), option 1 (on the second menu), and option 1 (on the third menu):
3. Adapter Updates
1. Converged Network Adapter
1. Flash Update
Noninteractive command equivalents: Some interactive commands have
noninteractive command equivalents. For such commands, the
corresponding noninteractive option is listed at the end of the section
heading in parentheses. For example, the following heading for the
interactive Fibre Channel command FC Adapter Information indicates that
the noninteractive equivalent is the -i command line option, described in
the corresponding (Fibre Channel) noninteractive mode chapter:
FC Adapter Information (-i)