mkcatdefs.1 (2010 09)

ManualsBrandsHP ManualsSoftwareHP-UX Manpages

mkcatdefs(1) mkcatdefs(1)

NAME

mkcatdefs - preprocess a message source ﬁle

SYNOPSIS

mkcatdefs [-h][-m [-p

preﬁx][-e extension ]] catname source_ﬁle ...

DESCRIPTION

The

mkcatdefs command preprocesses a message source ﬁle to do one or more of the following opera-

tions. These operations ease maintenance of compilable programs, scripts, or both:

• Convert symbolic identiﬁers for message sets and messages into numeric constants required by

the

gencat command. The gencat command creates the catname .cat ﬁle accessed by the

catopen(), catgets(), and catclose() functions and by the

dspmsg utility.

• Create a catname _msg.h ﬁle that deﬁnes macros to map symbolic identiﬁers to corresponding

numeric constants in the .cat ﬁle. Program source code that speciﬁes an include statement for

catname _msg.h can therefore use symbolic identiﬁers rather than numeric constants to identify

the messages to be retrieved from the message catalog.

If the

-m option is speciﬁed with

-e h, the header ﬁle also contains macros that deﬁne symbolic

identiﬁers for default message strings. A call to the

catgets() function or execution of the

dspmsg command in a program should include a default message string to be printed if a mes-

sage catalog cannot be found or opened for the locale in which the program is running. When the

catname_msg.h ﬁle includes macros for default message strings, program source code can

include an identiﬁer for the default message string in the catgets() call or in an execution call

for the dspmsg utility. This practice helps prevent unintentional inconsistencies between a mes-

sage string in the message source ﬁle and the same string speciﬁed in program calls.

• Create an include ﬁle, similar to catname _msg.h, but for use in scripts rather than programs. If

-e sh is speciﬁed, the include ﬁle is named catname _msg.sh and can be included in a script that

executes in the POSIX, Bourne, or Korn shell. If -e csh is speciﬁed, the include ﬁle is named

catname _msg.csh and can be included in a script that executes in the C shell.

Include ﬁles for scripts deﬁne variables only for the default message strings to be displayed when

a catalog is not found or cannot be opened.

See gencat (1) for a description of fundamental rules that govern the format of a message source ﬁle. The

only difference between

gencat and mkcatdefs is that with gencat you must input a number to

identify each message set and message, while mkcatdefs accepts either a number or a symbolic name.

Options

-e extension If the -m option is also speciﬁed, identiﬁes the type of include ﬁle to contain the

default message strings and their symbolic identiﬁers. The value for extension can

be one of the following:

h Generate macros into a catname _msg.h ﬁle. (Default)

sh Generate variable assignments into a catname _msg.sh ﬁle. This ﬁle can be

included by POSIX, Bourne, and Korn shell scripts for use with the dspmsg

command.

csh Generate variable assignments into a catname _msg.csh ﬁle. This ﬁle can be

included by C shell scripts for use with the dspmsg command.

-h Suppresses the generation of the catname _msg.h ﬁle if -m is not speciﬁed or -m is

speciﬁed along with -e sh or -e csh.

Suppresses the macros that map symbolic identiﬁers for messages and sets to

numeric constants if

-m is speciﬁed either without the -e option or with -e h.

(The catname _msg.h ﬁle is generated but contains only the macros that deﬁne sym-

bolic identiﬁers for default message strings.)

-m Causes the output header ﬁle or shell script include ﬁle to contain default message

strings and their symbolic identiﬁers.

-p prefix Speciﬁes a preﬁx used in the identiﬁer for a default message string. If the preﬁx is

not speciﬁed with the -p option, the string "DEF_" is prepended to the message

identiﬁer to form the identiﬁer for the default message string.

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

Summary of content (6 pages)

PAGE 1
mkcatdefs(1) mkcatdefs(1) NAME mkcatdefs - preprocess a message source file SYNOPSIS mkcatdefs [-h] [-m [-p prefix] [-e extension ]] catname source_file ... DESCRIPTION The mkcatdefs command preprocesses a message source file to do one or more of the following operations. These operations ease maintenance of compilable programs, scripts, or both: • Convert symbolic identifiers for message sets and messages into numeric constants required by the gencat command. The gencat command creates the catname .
PAGE 2
mkcatdefs(1) mkcatdefs(1) Explicitly specifying a catalog-specific prefix is recommended if programs and scripts access multiple message catalogs. Otherwise, there is a risk that the include files generated for the different catalogs might define the same symbol for different message strings.
PAGE 3
mkcatdefs(1) mkcatdefs(1) See the EXAMPLES section for an illustration of techniques that provide insulation from changes in how numeric constants are mapped to symbolic identifiers for message sets and messages. EXTERNAL INFLUENCES Environment Variables LANG provides a default value for the internationalization variables that are unset or null. If LANG is unset or null, it defaults to C (see lang (5)).
PAGE 4
mkcatdefs(1) mkcatdefs(1) Note that mkcatdefs also created the symbol MF_SYMB by prepending MF_ to catname using uppercase letters. The mkcatdefs command assumes that the name of the generated catalog should be catname .cat, and generates this symbol for your use with the catopen function. Because this include file contains include statements for limits.h and nl_types.h, you do not need to explicitly include these files in your application program. (The nl_types.
PAGE 5
mkcatdefs(1) mkcatdefs(1) #define GREET 1 #define BYE 2 #define ENTER 3 /* definitions for set RESULTS */ #define RESULTS 2 #define NADA 1 #define FOUND 2 /* definitions for set PROBLEMS */ #define PROBLEMS 3 #define SERVCONN 1 #define BUSYDAY 2 #endif /* Default messages generated from PFF.src */ #define #define #define you are #define kind of #define #define #define #endif DEF_GREET "Welcome to the Product Fact Finder program!\n" DEF_BYE "Good-bye. Please come again.
PAGE 6
mkcatdefs(1) mkcatdefs(1) . . dspmsg -s 1 PFF.cat 1 "${DEF_GREET}" . . . The dspmsg command in this script displays the message string: % ./test_dspmsg.sh Welcome to the Product Fact Finder program! A default message string is typically English text, whereas a translated message is displayed if a translated version of the catalog is available for the locale. The advantage of using symbols for default message strings is to ensure that only one copy of the original message strings needs to be maintained.