Pg. of GC20-1819-2 Rev March 30, 1919 by Supp. SD23-9024-1 for 5148-118 Section 18. HELP File Naming Conventions and Creation The HELP facility enables the user to: I • Extend the command and .essage description files IBft provides with I additional description files of the user's choice I • Produce a formatted terminal display by using the HELP format words I when creating the HELP description file Naming Conventions When you extend the HELP text files IBft provides, you must use the following naming conventions for the HELP files: I • The filename for components, commands, subcommands, or EXECs must be I the exact full name of the component, command, subcommand, or EXEC. I • The filename for messages has the form xxxnnnt where: xxx is the component code messages). See component code prefixes. nnn is the .essage number. prefix (for example, for a DftS for list of ces the t 1.5 the lIessage eMS). (for example. E for error messages in For example, the filename for the eMS message "NO FILENAME SPECIFIED" would be DMS001E. I • The filetype for components, commands, or EXECs is 'HELPxxxx' where I xxxx identifies the system associated with this component, command, I or EXEC. For example, the filetype for a CMS command would be I 'HELPCMS'. I • The filetype for subcommands is 'HELPxxxx' where X%XX identifies the I command name associated with this subcommand; for example, DEBU for I the DEBUG com.and. I • The filetype for messages is 'HELPMSG'. I • The filetype for a list of all supported commands for a given I function is 'HELPMENU'. The following examples illustrate the naming conventions required to interface with the HELP command. ACCESS E:CIT CHANGE DMS186i CMS HELPCMS HELPCMS HELPEDIT HELPMSG HELPMENU A CMS command description A CMS command description An EDIT subcommand description A message description A list of the CMS command and/or EXEC names supported by the HELP facility Section 18. HELP File Naming Conventions and creation 324.3
Pg. of GC20-1819-2 Rev March 30, 1919 by Supp. SD23-9024-1 for 5148-118 Section 18. HELP File Naming Conventions and Creation The HELP facility enables the user to: I • Extend the command and .essage description files IBft provides with I additional description files of the user's choice I • Produce a formatted terminal display by using the HELP format words I when creating the HELP description file Naming Conventions When you extend the HELP text files IBft provides, you must use the following naming conventions for the HELP files: I • The filename for components, commands, subcommands, or EXECs must be I the exact full name of the component, command, subcommand, or EXEC. I • The filename for messages has the form xxxnnnt where: xxx is the component code messages). See component code prefixes. nnn is the .essage number. prefix (for example, for a DftS for list of ces the t 1.5 the lIessage eMS). (for example. E for error messages in For example, the filename for the eMS message "NO FILENAME SPECIFIED" would be DMS001E. I • The filetype for components, commands, or EXECs is 'HELPxxxx' where I xxxx identifies the system associated with this component, command, I or EXEC. For example, the filetype for a CMS command would be I 'HELPCMS'. I • The filetype for subcommands is 'HELPxxxx' where X%XX identifies the I command name associated with this subcommand; for example, DEBU for I the DEBUG com.and. I • The filetype for messages is 'HELPMSG'. I • The filetype for a list of all supported commands for a given I function is 'HELPMENU'. The following examples illustrate the naming conventions required to interface with the HELP command. ACCESS E:CIT CHANGE DMS186i CMS HELPCMS HELPCMS HELPEDIT HELPMSG HELPMENU A CMS command description A CMS command description An EDIT subcommand description A message description A list of the CMS command and/or EXEC names supported by the HELP facility Section 18. HELP File Naming Conventions and creation 324.3
$COL The $COL edit macro inserts, after the current record in the file, a line containing column numbers (that is, 1. 6. 11 ••••• 76). The format of the $COL macro instruction is: $COL I I No operands are used with $COL. If any arguments are entered, the .acro usage is explained. To create $COL, enter: edit $col exec and in input mode, enter the following: &CONTROL OFF &IF &INDEX NE 0 &GOTO -TELL SSTACK LIFO RESTORE &STICK LIFO &BEGSTACK LIFO ALL 1 6 11 16 21 26 31 36 41 46 S1 S6 61 66 SEND &STACK LIFO INPUT &BEGSTACK LIFO TRUNC * VERIFY OFF LONG PRESERVE SEND SEXIT * -TELL &BEGTYPE CORRECT FORM IS: $COL INSERTS A LINE INTO THE FILE SHOWING COLUMN NU!BERS. &END SEXIT 324 IBM VM/370 CMS User's Guide 71 76
Pg. of GC20-1819-2 Rev Barch 30, 1979 by Supp. SD23-9024-1 for 5748-118 Part 4. Learning to Use the HELP Facility The CBS HELP facility enables the user to interactively display coamand and message information on a terminal. The co •• and and aessage inforaation is contained in files either supplied by IB! or created by the user. "Section 18. HELP File Baaing Conventions and Creation" describes the naaing conventions for HELP facility files and techniques that the HELP facility provides for creating user HELP description fileso Part 4. Learning to Use the HELP Facility 324.1
Pg. of GC20-1819-2 Rev March 30, 1979 by SUppa SD23-9024-1 for 5748-118 HELP File Creation Users creating additional files for the HELP facility own file or use the format words the HELP facility format do the following: I • Draw boxes to enclose tables, illustrations or text I • Place co.ments within a file can for.at their supports. These I. Indicate that certain input lines are to be included in the for.atted I output only under certain conditions I • Cause concatenation of input lines and left-and right-justification I of output I • Indent only the next input line the specified number of spaces I. Indent a series of input lines the specified nu.ber of spaces I • Indent the specified number of spaces all but the first line in a I series of input lines I. Insert blank lines between output lines I • Change the final output representation of any input character The HELP for.at words are su •• arized in Figure 23.1. Descriptions and examples of their use follow. 324.4 IBM VM/370 eMS User's Guide
Pg. of GC20-1819-2 Rev "arch 30, 1979 by Supp. SD23-9024-1 for 5748-XX8 Section 18. HELP File Naming Conventions and Creation 324.5