NET/MASTER Management Services (MS) System Management Guide

The Format of a Command Help Edit File
Customizing Command Help Information
13–10 105744 Tandem Computers Incorporated
Information. The help information in a standard-format help edit file follows the
following format:
*Function: This is a brief description of the function of the command
* or command/operand combination.
*
The following format is used for a command:
*+-----------+---------------------------------------------------------+
+| @COMMAND@ | < KEYWORD1=variable1 > |
*| ( m / n ) | < ( KEYWORD2 | K )=( VALUE1 | V1 ) | ( VALUE2 | V2 ) > |
*| | KEYWORD3=variable2 |
*+-----------+---------------------------------------------------------+
*
The following format is used for a command/operand combination:
*+-----------+---------------------------------------------------------+
+| @COMMAND@ | @OPERAND@ |
*| ( m / n ) | < KEYWORD1=variable1 > |
*| | < ( KEYWORD2 | K )=( VALUE1 | V1 ) | ( VALUE2 | V2 ) > |
*| | KEYWORD3=variable3 |
*+-----------+---------------------------------------------------------+
*
*Use: Specifies whether the command or command/operand combination
* is specific to NonStop NET/MASTER MS or the SOLVE management
* services
*
* This is a brief description of the use of the command or
* command/operand combination.
*
*Operands: KEYWORD1=variable1
* this is a description of KEYWORD1 and variable1.
*
* ( KEYWORD2 | K )
* this is a description of KEYWORD2.
*
* ( VALUE1 | V1 )
* this is a description of VALUE1.
*
* ( VALUE2 | V2 )
* this is a description of VALUE2.
*
* KEYWORD3=variable2
* this is a description of KEYWORD3 and variable3.
*
*Examples: 1. This sentence introduces the first example:
*
* THIS IS THE FIRST EXAMPLE
*
* 2. This sentence introduces the second example:
*
* THIS IS THE SECOND EXAMPLE
*
*Notes: Special considerations and additional information about
* the command or command/operand combination are described
* here.
*
*See also: Related NonStop NET/MASTER commands are listed here.