NET/MASTER Management Services (MS) System Management Guide

The Format of a Command Help Edit File
Customizing Command Help Information
105744 Tandem Computers Incorporated 13–11
Notable features of the standard-format help edit file are:
The headings used are Function, Use, Operands, Examples, Notes, and See also.
COMMAND is surrounded by at signs (@): for example, @SHOW@.
OPERAND in a command/operand combination is surrounded by at signs: for
example, @FILES@ in SHOW FILES.
Angle brackets (< >) are used instead of square brackets ([ ]) to enclose optional
syntax items.
Parentheses (( )) are used instead of braces ({ }) to enclose required syntax items.
Vertical bars separate mutually exclusive operands.
The text is unformatted; it appears on the screen as it appears in the file.
User-Defined Command
Help File Format
User-defined command help information means updated information or new
information. When you create user-defined command help information, you normally
use the standard command help edit file format. Then all command help information
follows a consistent format, making it easier for users to find information. This
subsection discusses considerations for creating user-defined command help
information if you choose not to use the standard command help edit file format.
The Summary Help Line
Considerations for the summary help line are as follows:
The Word SUMMARY. In a command help edit file that you update or create:
You can enter more than one summary help line. However, only the last summary
help line is recognized and written to the command help database in an import
operation; all other summary help lines are ignored.
You can position the summary help line anywhere in the file. However, the
import operation always positions the summary help line as the first line of the
help information for the command in the command help database. (Therefore, the
summary help line is always the first line in the command help edit file after an
export operation.)
You must have a summary help line that must begin with the word SUMMARY
(in either lowercase or uppercase letters). If you omit the summary help line in a
command help edit file you create, the import operation inserts a summary line,
which contains only the word SUMMARY.
In an import operation, the brief description is truncated, if necessary, so that line
length does not exceed 80 characters.
Authority Level of the Command or Command/Operand Combination. In a command help edit
file you update or create, you can enter any text after the word SUMMARY. However,
when the summary help line is displayed, the information following SUMMARY
appears as the authority level of the command or command/operand combination.