skip book previous and next navigation links
go up to top of book: HP OpenVMS System Manager's Manual, Volume 1:... HP OpenVMS System Manager's Manual, Volume 1:...
go to beginning of chapter: Customizing the Operating System Customizing the Operating System
go to previous page: Registering Images that Have System Version Dependencies Registering Images that Have System Version Dependencies
go to next page: Customizing MailCustomizing Mail
end of book navigation links

Customizing the Help Message Database  



The Help Message utility (MSGHLP) allows users to quickly access online descriptions of system messages from the DCL prompt. Users with write access to HP-supplied .MSGHLP$DATA files can customize the Help Message database in more radical ways than general users can. The following sections describe how to perform the following customization tasks:

Task For More Information
Accessing $STATUS values for uninstalled messages
Accessing $STATUS Values for Uninstalled Messages
Creating system-level Help Message database search paths
Creating System-Level Database Search Paths
Deleting HP-messages
Deleting HP-Supplied Messages from the Database
Adding comments to HP-supplied messages
Adding Comments to HP-Supplied Messages
Changing text in HP-supplied messages
Changing HP-Supplied Data
Adding messages to HP-supplied database files
Adding Messages to HP-Supplied Database Files

Before performing these tasks, you should be familiar with the Help Message utility. For a complete description of Help Message features, basic tasks, and the HELP/MESSAGE command and qualifiers, refer to the OpenVMS System Messages: Companion Guide for Help Message Users . Also refer to that manual for a description of the files that you must manipulate to customize the Help Message database.


NoteCurrently, user-supplied comments or additions to HP-supplied .MSGHLP$DATA files are not preserved through the next upgrade. However, your own .MSGHLP$DATA files are not affected by future releases.

You can reuse .MSGHLP files to insert your own messages into future HP-supplied database files. Depending on the data format in future databases, you might also be able to reuse some .MSGHLP files to insert comments.


Accessing $STATUS Values for Uninstalled Messages   

Any messages that are not installed as part of the OpenVMS operating system cannot be equated with a value stored in $STATUS until they are recognized by the system. When the Help Message utility attempts to translate the value stored in $STATUS or a value specified with the /STATUS qualifier, the search can fail if the value does not equate to an installed message or a message that was linked into the Help Message utility when it was created by HP. You can make your system recognize such uninstalled messages. These messages include user-supplied messages, third-party messages, and messages from layered products and certain other OpenVMS facilities.

How to Perform This Task

  1. Use the Help Message qualifier /SECTION_FILE=* to include all the OpenVMS-supplied message section files that have not already been linked into the main Help Message program, MSGHLP$MAIN.EXE:
    $ HELP/MESSAGE/SECTION_FILE=*
    This command generates a user-modifiable object library, SYS$LIBRARY:MSGHLP$MESSAGE_SECTIONS.OLB. Each module in this library contains a pointer to a message section .EXE file. You can use the /SECTION_FILE qualifier to insert additional modules into this library. (See the following steps.)
    NoteThis HELP/MESSAGE command produces results similar to, but entirely separate from those effected by the SET MESSAGE filespec command. The Help Message utility does not interact with the Message utility. If you want both utilities to translate the same set of message sections, you must separately code each utility to do so. It is perfectly acceptable to have each utility point to different message section files.

    When you use the /SECTION_FILE qualifier to create the object library or add modules to it, the MSGHLP$MESSAGE_SECTIONS.EXE file is also automatically created from all the modules in the object library and is placed in your default directory. When you finish modifying the object library, you must copy the final .EXE file to SYS$COMMON:[SYSLIB] (logical name SYS$LIBRARY).

    Thereafter, if Help Message cannot translate a status code and the SYS$LIBRARY:MSGHLP$MESSAGE_SECTION.EXE image exists, Help Message activates it and searches all message section files to which it points. The impact on Help Message search time depends upon the number of files searched.
  2. Use the following command as many times as you want to add pointer modules for any other specific message section files to SYS$LIBRARY:MSGHLP$MESSAGE_SECTIONS.OLB and MSGHLP$MESSAGE_SECTIONS.EXE:HELP/MESSAGE/SECTION_FILE=file-name.EXE The default file specification is SYS$MESSAGE:.EXE.
  3. Review the contents of the resulting SYS$LIBRARY:MSGHLP$MESSAGE_SECTIONS.OLB file:
    $ LIBRARY/LIST MSGHLP$MESSAGE_SECTIONS.OLB
    The names of the modules in the .OLB file are derived from strings specified in the /SECTION_FILE qualifier.

    Help Message can search a maximum of 42 message section files. Files are searched in this order:
  4. If you want, remove any references to message section files in the .OLB file to control which 42 message section files are included in the Help Message search. You might delete a file that you rarely use earlier in the alphabet to ensure that a file later in the alphabet is among the 42 files searched. For example, to delete the NCP (Network Control Program) messages from the .OLB file, use this command:
    $ LIBRARY/DELETE=NETWRKMSG SYS$LIBRARY:MSGHLP$MESSAGE_SECTIONS.OLB 
    If you delete a module from the .OLB file, you must execute the HELP/MESSAGE command with the /SECTION_FILE qualifier to generate an updated .EXE file. The qualifier argument can specify either a new file or a file that is already listed in the .OLB file.
  5. When your .OLB file reflects the message section files you want Help Message to search, copy the final .EXE file from your account to SYS$LIBRARY:.

Example

The following example demonstrates this sequence of events:

  1. Link all OpenVMS-supplied message section files.
  2. Review the resulting .OLB file.
  3. Delete the VVIEFMSG module from the .OLB file.
  4. Add the file USERS:[TOOLS]NEW_MSGS.EXE to the list in the .OLB file.
  5. Review the revised contents of the .OLB file.
  6. Copy the final .EXE file from the local account to SYS$LIBRARY:.

Note that the output from the LIBRARY/LIST commands is omitted from the example.

$ HELP/MESSAGE/SECTION_FILE=*
$ LIBRARY/LIST SYS$LIBRARY:MSGHLP$MESSAGE_SECTIONS.OLB
$ LIBRARY/DELETE=VVIEFMSG SYS$LIBRARY:MSGHLP$MESSAGE_SECTIONS.OLB 
$ HELP/MESSAGE/SECTION_FILE=NEW_MSGS.EXE
 
$ LIBRARY/LIST SYS$LIBRARY:MSGHLP$MESSAGE_SECTIONS.OLB
$ COPY MSGHLP$MESSAGE_SECTIONS.EXE SYS$LIBRARY:MSGHLP$MESSAGE_SECTIONS.EXE

Creating System-Level Database Search Paths  

Help Message database files need not reside on the system disk. You can create system logical names to define one or more Help Message search paths to access multiple .MSGHLP$DATA files in different locations.

When Help Message is installed, the OpenVMS messages database file is installed by default at SYS$COMMON:[SYSHLP]MSGHLP$LIBRARY.MSGHLP$DATA. However, this file can optionally be installed on or moved to another disk. The alternate location must be pointed to by logical name MSGHLP$LIBRARY. Use this command to define the logical name: DEFINE/SYSTEM MSGHLP$LIBRARY disk:[directory]MSGHLP$LIBRARY

By default, Help Message attempts to look up messages in the default location unless the logical name MSGHLP$LIBRARY is defined. If you do not use the default database location, include the logical name definition command in SYS$MANAGER:SYLOGICALS.COM so that the database is defined each time the system is booted.


NoteIf you move MSGHLP$LIBRARY.MSGHLP$DATA to a new location after installation, be sure to set the proper protections on the file and directory so that the database cannot be accidentally deleted or modified. The protections at installation are (RWE, RWE, RE, RE) for the directory and (RWE, RWE, RWE, RE) for the file.

You and other system users can create additional .MSGHLP$DATA files, as described in the OpenVMS System Messages: Companion Guide for Help Message Users . None of the .MSGHLP$DATA files need reside on the system disk. You can add new files to a systemwide default database search path defined by MSGHLP$LIBRARY, or you can create specialized search paths to include different configurations of .MSGHLP$DATA files.

A search path definition can include individual file names or can point to one or more directories. If you specify a directory with no file name, Help Message searches all .MSGHLP$DATA files currently found in that directory. Pointing to a directory instead of individual files can minimize your bookkeeping when .MSGHLP$DATA files are added or removed.

To use system resources more efficiently, you can create different search paths for different user groups, depending on which .MSGHLP$DATA files they need to access. You can also set up different directories for different types of messages or for different user groups. For example, you could use three unique logical names to define three different search paths tailored to different user groups: DEFINE/SYSTEM logical-name-1 file-a,file-b,file-cDEFINE/SYSTEM logical-name-2 file-a,directory-zDEFINE/SYSTEM logical-name-3 file-x,file-a,directory-y


NoteThe first file you list in a search path is the default database for /INSERT and /DELETE operations that operate on that search path. By default, all other operations access all files in a search path. Specifying a directory first in a search path risks setting up a default moving target for /INSERT and /DELETE operations if files are added to or deleted from the directory.

Users can select an alternate to the system default database by specifying the /LIBRARY qualifier in the HELP/MESSAGE command. Individual users can also create their own logical name search paths at the process level.

Example

The following example defines a Help Message search path that accesses .MSGHLP$DATA database files in three locations: the HP-supplied OpenVMS messages at USERS:[TOOLS], the user-supplied file USERS:[NEW_PROJ]OUR_MESSAGES.MSGHLP$DATA, and all .MSGHLP$DATA files in directory TEST:[TRY_ME].

$ DEFINE/SYSTEM MSGHLP$LIBRARY USERS:[TOOLS]MSGHLP$LIBRARY,-
_$ USERS:[NEW_PROJ]OUR_MESSAGES.MSGHLP$DATA,TEST:[TRY_ME]

Deleting HP-Supplied Messages from the Database  

You can delete HP-supplied messages from the database to conserve system resources or improve response time.

How to Perform This Task

  1. Use the /EXTRACT qualifier to create a .MSGHLP file containing the messages you want to delete from the database. (Refer to the OpenVMS System Messages: Companion Guide for Help Message Users for a full description of how to select the contents of the .MSGHLP file.) Some examples follow.

    Use the following syntax to extract all the messages for a specified facility:HELP/MESSAGE/FACILITY=facility-name/EXTRACT=filename.MSGHLPUse this syntax to extract one or more messages specified by the search string: HELP/MESSAGE/EXTRACT=filename.MSGHLP search-string
  2. Check the contents of the resulting .MSGHLP file to be sure that it contains only the data that you want to delete from the database. Edit out any messages that you do not want to delete from the database.
  3. Use /DELETE to delete the contents of the .MSGHLP file from the database. Include /LIBRARY if the MSGHLP$LIBRARY.MSGHLP$DATA file is not the default database or if it is not the first file in the search path defined by logical name MSGHLP$LIBRARY. HELP/MESSAGE/DELETE=filename.MSGHLPHELP/MESSAGE/DELETE=filename.MSGHLP/LIBRARY=disk:[directory]filename.MSGHLP$DATASave the .MSGHLP file if you might ever want to add the deleted messages back into the database prior to the next upgrade. You can store the file on tape to conserve disk space. If you delete and then reinsert messages, these messages are treated like user-supplied messages and are displayed with change bars.

    Any HP-supplied messages that you delete are currently reinserted into the database at the next upgrade. You can delete the messages again using a saved .MSGHLP file or you can create a new .MSGHLP file. Note that if you keep a .MSGHLP file for future deletion purposes only, you need save only the lines prefixed by 1 and 2.
  4. To save disk space, you can compress the .MSGHLP$DATA file to close up any free space created by the deletions. Use the following command sequence to compress the file: CONVERT disk:[directory]filename.MSGHLP$DATA disk:[directory]filename.MSGHLP$DATAPURGE disk:[directory]filename.MSGHLP$DATA

Example

The following example extracts and then deletes all messages for the DDTM (DECdtm services) facility from the default database. The last two commands compress the HP-supplied database file to conserve disk space after the deletions.

$ HELP/MESSAGE/FACILITY=DDTM/EXTRACT=DDTM.MSGHLP
$ HELP/MESSAGE/DELETE=DDTM.MSGHLP
$ CONVERT SYS$COMMON:[SYSHLP]MSGHLP$LIBRARY.MSGHLP$DATA -
_$ SYS$COMMON:[SYSHLP]MSGHLP$LIBRARY.MSGHLP$DATA
$ PURGE SYS$COMMON:[SYSHLP]MSGHLP$LIBRARY.MSGHLP$DATA

Adding Comments to HP-Supplied Messages  

You can add comments to HP-supplied messages documentation. Comments display with change bars immediately following the HP-supplied description. This feature is a handy way to publicize a site-specific solution for a common problem.


NoteCurrently, user-supplied comments to HP-supplied .MSGHLP$DATA files are not preserved through the next upgrade. However, if the HP-supplied message descriptions do not change during the upgrade, you can reuse .MSGHLP files to reinsert comments after the upgrade.

How to Perform This Task

  1. Extract the message to which you want to add a comment. The following example extracts hypothetical message NOSNO:
    $ HELP/MESSAGE/EXTRACT=NOSNO.MSGHLP NOSNO
  2. Edit the .MSGHLP file to add your comment. The .MSGHLP file format uses a unique numerical prefix to designate the message, facility, explanation, and user action sections of the message description. Add your comments at the end using a "5" prefix.
    1NOSNO, can't ski; no snow
    2XCSKI, XCSKI Program
    3Your attempt to ski failed because there is no snow. 
    4Wait until there is snow and attempt the operation again.
    5If you don't want to wait, go to a location where there is
    5snow and ski there. 
    5
    5Or, try ice skating instead!
    Tips for modifying files:
  3. Update the database by inserting the updated message:
    $ HELP/MESSAGE/INSERT=NOSNO.MSGHLP
    The comment is now displayed following the HP-supplied message description.

Example

$ HELP/MESSAGE/EXTRACT=ACCVIO.MSGHLP ACCVIO
[Edit ACCVIO.MSGHLP to add your comment.]
 
$ HELP/MESSAGE/INSERT=ACCVIO.MSGHLP

Changing HP-Supplied Data  

You cannot use the procedure described in Adding Comments to HP-Supplied Messages to alter HP-supplied information. The recommended way to permanently change HP-supplied information is to send your comments to the OSSG Documentation Group (see the Preface for Internet and mail addresses) or contact a HP support representative.

The sequence described in this section allows you to modify HP-supplied data, with the following results:

How to Perform This Task

  1. Extract the message having the text or description you want to change: HELP/MESSAGE/EXTRACT=filename.MSGHLP search-string
  2. Check the .MSGHLP file to ensure that your search did not pick up any messages that you do not want to change. Delete any such messages that you want to preserve out of the .MSGHLP file.
  3. Delete the HP-supplied version of the message from the Help Message database by specifying the .MSGHLP file as input. The following command deletes all messages in the .MSGHLP file from the default .MSGHLP$DATA file:HELP/MESSAGE/INSERT=filename.MSGHLP
  4. Edit the .MSGHLP file to make your changes.
  5. Insert the revised message description into the Help Message database: HELP/MESSAGE/INSERT=filename.MSGHLPYour version of the message now appears in the database with change bars to indicate that it is not an HP-supplied message.

Example

$ HELP/MESSAGE/EXTRACT=NOFILES.MSGHLP NOFILES
$ HELP/MESSAGE/DELETE=NOFILES.MSGHLP
[Edit NOFILES.MSGHLP to change the text.]
 
$ HELP/MESSAGE/INSERT=NOFILES.MSGHLP

Adding Messages to HP-Supplied Database Files  

The OpenVMS System Messages: Companion Guide for Help Message Users describes how to create your own .MSGHLP$DATA files to add new messages to the Help Message database. Keeping your messages in a separate file can simplify your messages bookkeeping and ensure that your messages are preserved through future upgrades.

With write access to HP-supplied .MSGHLP$DATA files, you can alternatively insert your own messages into the HP -MSGHLP$LIBRARY.MSGHLP$DATA file. However, messages inserted using this technique will currently be overwritten at the next upgrade. You can, however, save your input .MSGHLP files and repeat the insertion process at the next upgrade.

How to Perform This Task

  1. Create a .MSGHLP file with your message descriptions in it. ( Adding Comments to HP-Supplied Messages includes an example of the .MSGHLP file format.)
  2. Specify your .MSGHLP file as input to update the HP -.MSGHLP$DATA file. Assuming that MSGHLP$LIBRARY.MSGHLP$DATA is the default, all you must enter is:HELP/MESSAGE/INSERT=filename.MSGHLP

Example

$ HELP/MESSAGE/INSERT=MYMESSAGES.MSGHLP

go to previous page: Registering Images that Have System Version Dependencies Registering Images that Have System Version Dependencies
go to next page: Customizing MailCustomizing Mail