Conventions Used To Describe Commands - Avaya M770 User Manual

Chapter 3 How to Use the Command-line Interface
For example, the output of the tree command from the pport functional group
prompt is:
Command:
Output:
Note: Certain functional groups in the hierarchy are also commands in their own
right. For example, the vport show functional group is also a command when
entered on its own.

Conventions used to describe commands

Throughout this chapter the following conventions are used:
• All command examples are given in relation to the root of the hierarchy. That is,
this is how you would enter the command if you were at the root of the
hierarchy.
• The syntax of commands are described using the symbols displayed in
Table 3.2.
Table 3.2
Syntax
[ ]
{ }
< >
24
M15-155s8:/pport>tree
pport
+-disable -- Disable a physical port
+-enable -- Enable a physical port
+-reset -- Reset all settable parameters on a physical port to their defaults
+-set -- Set a physical port parameter
| +-framing -- Specify the framing
| +-payloadscrambling -- Specify whether payload scrambling is on or off
| `-txrate -- Specify port transmit rate in Kbits/sec
+-show -- Show information about all physical ports
| `-counters -- Show counter information for a physical port
Symbols used to describe command syntax
Description
Characters surrounded by square brackets denote optional
arguments.
Characters surrounded with braces denote a selection list. When
there are several argument selections surrounded by braces and
separated by a vertical bar (|) then one of the arguments must be
included in the command.
Characters surrounded by angle brackets denote information that
you must provide.
Avaya M770 ATM Switch User's Guide