NET/MASTER Management Services (MS) System Management Guide

The Format of a Command Help Edit File
Customizing Command Help Information
13–6 105744 Tandem Computers Incorporated
The Command Help Edit
File
Updated and new command help information is written to the customized command
help database. However, because this file is key-sequenced, you cannot write
information to the file directly. As Figure 13-1 shows, you must write updated and
new command help information in an intermediate file—the command help edit file—
and then import the information to the customized command help database.
The command help edit file is an edit file (with a file code of 101). You must provide
the name of the file during an export or import operation. The name of the file,
however, does not have to reflect the name of the command or command/operand
combination for which you are updating or providing new information.
An export operation exports the help information for a single command or
command/operand combination from the command help database to the command
help edit file. After an export operation, you can use Edit Services, which uses PS Text
Edit (TEDIT), to read or update the information in the file.
An import operation imports the help information for a single command or
command/operand combination from the command help edit file to the command
help database. Before an import operation, you can use Edit Services to create or
update the information in the file.
The procedures used to export and import information are described later in this
section.
The Format of a
Command Help Edit
File
This subsection describes the format in which all distributed command help
information appears in the command help edit file after an export operation. You
usually use this standard format when you create customized command help
information to import to the command help database.
Standard Command Help
Edit File Format
A standard-format command help edit file has two parts: the summary help line and
the detailed help information.
The Summary Help Line
A standard-format summary help line has the following four parts:
The word SUMMARY
The authority level of the command or command/operand combination
A platform indicator
A brief description of the command or command/operand combination
The Word SUMMARY. The word SUMMARY simply indicates that the line in the edit file
is a summary help line. In a standard-format command help edit file, the summary
help line:
Appears once only
Is the first line in the command help edit file
Begins with the word SUMMARY (in uppercase letters)