Obtaining Help At The Map Terminal; Understanding Command Syntax - Nortel DMS-100 Series Maintenance Manual

6-2 Star Remote System user interface

Obtaining help at the MAP terminal

To receive online help information for commands at the MAP terminal, enter
H or HELP and the command name you need help with at the command line.
Online help provides the following information for a command:
•
•
•
The following example shows how to access online help using the HELP
command:
>help nag
This NAG command will display the nodes that are not in
service.
ALL parameter.
ON or OFF.
Parms:[<OPTIONS>{ON,

Understanding command syntax

The standard command entry sequence is as follows:
•
•
•
Online help provides information for parameters using the following special
formatting and symbols:
•
•
•
•
•
•
297-8353-550 Standard 05.01 March 2001
description of the function of the command
defaults for unspecified information
command syntax for required and optional parameters
The offline nodes can be included by using the
It also allows the nag log to be turned
OFF,
ALL}]
command
required parameter
optional parameter
parameters appear on separate lines
square brackets [ ] indicate the parameter is optional
angle brackets < > enclose the name of a required parameter
underscore character ( _ ) in a parameter name indicates the value of the
parameter is one word or string
curly braces { } contain a complete list of possible values for the parameter
information about the acceptable values for the parameter follow the name
of the parameter