dspmsg.1 (2010 09)

ManualsBrandsHP ManualsSoftwareHP-UX Manpages

dspmsg(1) dspmsg(1)

The following subsections discuss the CAT_MIDSET* and

CAT_MIDFMT* environment variables in more

detail.

Using the CAT_MIDSET* Environment Variables

The

CAT_MIDSET_catname and CAT_MIDSET environment variables are used to control how to activate

the message identiﬁer feature. You can use them to specify a space-separated list of numeric identiﬁers

for the sets containing messages that will be displayed with message identiﬁers. For example, if you set

one of these variables to "3 4", only messages in sets 3 and 4 will have their message identﬁers displayed.

The messages in other sets in the message catalog will be displayed without their message identiﬁers. If

you set one of these variables to "", this will disable display of message identiﬁers for all sets in the mes-

sage catalog.

The

dspmsg command checks for the CAT_MIDSET_catname and

CAT_MIDSET environment variables

only when the

-e option is speciﬁed. When this option is speciﬁed,

dspmsg ﬁrst determines if the

CAT_MIDSET_catname environment variable is set. If it is set, and message_number is in one of the sets

speciﬁed by the variable,

dspmsg

precedes the speciﬁed message with its message identiﬁer. If a

catalog-speciﬁc environment variable is not set, dspmsg searches for the CAT_MIDSET

environment

variable and uses its setting. If neither environment variable is set,

dspmsg does not display message

identiﬁers.

Usually, application programmers want to display message identiﬁers only for messages that are warning

or error conditions. If a message catalog is well designed, messages associated with these conditions

reside in different sets from those containing informational messages or background text strings. You can

set the

CAT_MIDSET_catname environment variable to list only the message sets that contain warnings

or errors and then use dspmsg -e to conﬁne display of message identiﬁers to those kinds of messages.

Using the CAT_MIDFMT* Environment Variables

The

CAT_MIDFMT_catname and CAT_MIDFMT environment variables control the format of the message

identiﬁer. One of these environment variables must be deﬁned to enable display of identiﬁers with the

-E option. These variables can be deﬁned to override the default format used for identiﬁers displayed

through the -e option. The dspmsg command ﬁrst checks the catalog-speciﬁc environment variable and

then, if the catalog-speciﬁc version is not found, checks for the

CAT_MIDFMT environment variable.

The value of the

CAT_MIDFMT* environment variables can include one or more of the following substitu-

tion directives (in any order):

%C The message catalog name without the ﬁle extension.

%S The identiﬁer for the message set. This is the numeric constant identiﬁer.

%M The message identiﬁer. This is the numeric constant identiﬁer.

%D The default format. If speciﬁed ﬁrst in the format string, the default format ("

%C%/%S%/%M:

"). If not speciﬁed ﬁrst in the format string, the %D substitution directive is ignored.

The format can include additional ASCII characters, such as the space or colon, as delimiters between

segments of the identiﬁer. However, you cannot include the percent (

%) character as a delimiter because

of its special meaning to the shell.

Following are some example formats and resulting message identiﬁers and strings. Assume for these

examples that the catalog name is du, the message set identiﬁer is 3, the message identiﬁer is 2, and the

message string is "Out of memory".

• "

%C/%S/%M: "

du/3/2: Out of memory

• "

%D"

du/3/2: Out of memory

• "

%C-%M: "

du-2: Out of memory

• "

%C %M: "

du 2: Out of memory

HP-UX 11i Version 3: September 2010 − 3 − Hewlett-Packard Company 3