A Summary of Commands

explain

The explanation file itself is almost a clear text file of what you want the user to see when they ask for the explanation. There are two features of the file that are not plain clear text. All lines beginning with the pound sign (#) character are treated as internal comments and are not output. Also lines of the form explain {msgID} have special meaning. They cause the inclusion of the explanation text specified by the {msgID}. This allows you to have common explanations and reference from more than one explanation.

The recommended format for an explanation procedure is:

# Comment and SCCS keywords<<{msgID} [{msgID}...] >> {text of message}

...

When creating a new explanation procedure, you will be asked to edit the synonyms list and be placed in the appropriate translateLst file. There are instructions at the top of the file. Each noncomment line is a list of synonyms, with the right most word on the line being the name of the file in which the text is located. For example:

ADM001ADM_SYSERR

ALERT003AL_INVALID_THRESHOLDAL_INVALID_T

The description for ADM001 and ADM_SYSERR are found in a file named ADM_SYSERR. The description for ALERT003 and AL_INVALID_THRESHOLD are found in a file named AL_INVALID_T. The

UCS 1000 R4.2 Administration 585-313-507

Issue 3 April 2000 469