2 motload command description page format – Artesyn MOTLoad Firmware Package User's Manual (February 2015) User Manual

Page 29

Advertising
background image

Using MOTLoad

MOTLoad Firmware Package User’s Manual (6806800C24D)

29

2.2

MOTLoad Command Description Page Format

All MOTLoad command pages follow the format described below.

Name

This field names the test or utility as it would appear on the MOTLoad command line. It also
provides a description of the command, for example:

errorDisplay

- displays the Contents of the MOTLoad Test Error Status Table

Synopsis

This field shows command line usage or syntax of a command, test, or utility. This consists
of the name of the command, test or utility, and a list of all possible arguments/options, for
example:

errorDisplay [-eP*] [-nP*] [-sP*]

If an argument is optional, it is enclosed in a set of braces [ ], otherwise it is required.

If an asterisk (*) or other symbol follows an option, another argument is required with that
option.

The asterisk (*) symbol means that a number of valid numeric base conversion option
arguments are possible. Refer to the table titled Number Base Specifiers for more
information.

An attempt has been made to standardize the meaning of option arguments but the exact
meaning of an option and its arguments is test specific. Exact option information can be
displayed through the use of the help command or by referring the appropriate man page.

Parameter

This field describes each argument and option of the command, for example:

Advertising