|
This section describes the syntax for the commands
that activate the Messaging command prompt screens. The topics in
this section are organized as follows:
Verb-object syntax
The commands to activate the Messaging command
prompt screens follow a verb-object syntax. A qualifier such as
a subscriber or machine name may be added to some verb-object commands.
The structure of the Messaging
command prompt screen-activation commands is:
Verb or Verbs Object or Object Phrase Qualifier
or Qualifiers
Each of these three elements of the command-line
is described below.
Command-line verbs
The first element of the command-line is the
verb, which specifies the type of action. The following is a list
of verbs in the command-line. Those marked with an asterisk (*)
are complete commands; that is, they are never combined with objects
or qualifiers.
| add |
audit |
change |
display |
exit* |
| get |
help* |
list |
logoff* |
print |
| remove |
reset |
test |
toggle |
trace |
Command-line objects and object phrases
The second element of the command-line is
the object or object phrase. This is usually a screen name. The
screen name consists of one or more words that identify the screen.
If more than one word is used, you must type a hyphen between the
two words to ensure that the object phrase has no embedded spaces.
Screen names are generally (but not always) the same as the title
of the screen as it appears on your monitor. Examples of objects
and object phrases are alarms, measurements, remote-messages, subscribers,
and system-parameters.
Command-line qualifiers
The third element of the command-line is
the qualifier. A command-line qualifier can be a subscriber extension
number (12345), a date (7/21/99), a subscriber name ("Jane Doe"),
and other specific parameters. Note that a qualifier with an embedded
space, such as the subscriber name Jane Doe, must be put in quotation
marks, such as: "Jane Doe".
Variations of commands
You can activate most screens by more than
one version of a command. The different versions of the screen-activation
command are distinguished by the verb that begins the command line,
and the qualifiers that end it. For example, there are four versions
of the command to activate the Machine Profile screen:
- add machine name
- change machine name
- display machine name
- remove machine name
All of these commands activate the Machine
Profile screen with information about the machine. The display
and remove versions of the command activate a display-only
version of the screen. The add and change versions
of the command activate a data entry version of the screen that
allows you to make changes to the features assigned to the machine
specified by name.
Command-line abbreviation
For most screen-activation commands, you
can enter a minimum unique subset of the full command string and
the system expands the entry. For example, the command change
system-parameters sending-restrictions can be abbreviated
to ch sy s since this is a unique subset of the full command.
The abbreviation of each word in the command
must be represented by the first n letters of the word in
the correct spelling order, where n is the minimum number
of letters that uniquely specifies the command word. As a general
rule, n is equal to 2. In other words, it usually takes two
characters to uniquely identify each element of the command line.
In the previous example, the string ch
sys s is acceptable as a unique subset of the full command.
However:
- The string chg sys s is not acceptable
because chg is not the first three letters of "change"
- The string ch s s is not acceptable
because ch s is not unique; that is, it could also mean
change subscriber or change system-parameters.
Note that hyphenated words such as system-parameters
and sending-restrictions are treated as single words.
Command structure
You can build a command one word at a time.
For example, at the beginning of the command line you can press
F6 (Choices) to see a list of all valid command verbs. If you then
enter ch, the system expands ch to change and
lists all valid words that can follow change. If you then enter
sy, the system expands the command line to change system-parameters
and lists all valid words that can follow.
If you enter a string that is not a valid
command word or is not a valid or unique abbreviation, the system
notifies you of the mistake. If you omit a required command qualifier
such as a subscriber name or extension, or a port address, the system
prompts you for the missing information.
Command-line help
While you are entering a command, pressing
the F6 (Choices) function key displays a menu of allowable command
words in the activity window. The choices displayed depend on the
position of the cursor in the command line. That is, the allowable
command words displayed when you press F6 (Choices) are only those
command words that can follow the word or words that are currently
to the left of the cursor, if any. Select from the choices displayed
on the menu by using the Tab key or arrow keys, or by typing the
first one or two characters of the desired menu choice.
Command history and command-line editing
The system memory retains a list of the
10 most recently entered commands. After you enter a command, you
can scroll back through a list of previous commands using the Up
Arrow key. Each time you press the Up Arrow key, the previous command
in the command list is retrieved. Each time you press the Down Arrow
key, the next command in the command list is retrieved. The retrieved
command is placed on the command line with the cursor at the end
of the line. This is a convenient way to reenter commands containing
subscriber names or telephone numbers, for example, without retyping
the entire command.
The following table shows the editing actions
that are possible once you display a previously executed command
on the command line.
Table: Command line history and editing
| Key |
Purpose |
| F1 (Cancel) |
Erases the entire contents of the command
line.
Note: If you are using the Messaging command
prompt screen via the LAN with Internet Explorer, you might
experience difficulties such as the Windows help popping up
when you press F1 or the Messaging command prompt seeming
to freeze. These symptoms indicate that the Java Virtual machine
you are using is incompatible with the software. To alleviate
the problems, select the browser's Tools > Internet
Options... > Advanced tab. Locate the Java (Sun)
subheading and clear the checkbox. Restart the browser to
implement the changes. |
| Left Arrow |
Moves the cursor to the beginning of
the previous word on the command line. |
| Tab or Right Arrow |
Moves the cursor to the beginning of
the next word on the command line. |
| Up Arrow |
Moves through previously completed
commands. |
| Down Arrow |
If you have gone too far through previously
completed commands, moves back through the commands. |
| Backspace |
Deletes the character preceding the
cursor. |
| F4 (Clear Field) |
Clears a single keyword from the command
line; for example, if the command line contains the command
list machine and you press F4, the command line reads
list. |
| F5 (Help) |
Displays a screen explaining the types
of help available for the Messaging command prompt screen. |
| F6 (Choices) |
Displays a menu of valid entries for
command-line keywords. Once a Choices menu is displayed, press
F6 to select the highlighted item from the menu. |
| F3 (Enter) |
Expands a shortened version of a command
and activates the screen. |
Top of page
|
