localedef - Define the locale environment

Format

localedef [-c] [-f charmap] [-i sourcefile] [-m methodfile] [-w] [-A] [-L binderoptions] [-X] [-6] name

Description

localedef converts source definitions for locale categories into a format usable by functions and utilities.

localedef, which is installed as part of the Language Environment® element of z/OS®, utilizes c89, which is installed as part of z/OS Runtime Library Extensions.

c89 requires the installation of the C/C++ optional feature of z/OS (which provides among other things a C compiler).

A TSO/E utility called LOCALDEF is installed as part of Language Environment.
  • It is not supported by the z/OS shell.
  • The TSO/E BATCH versions of the utility do not support ASCII (-A) nor AMODE-64 (-6) options.
For information about the charmap file and locale definition source file formats, see The CHARMAP section in z/OS XL C/C++ Programming Guide.

Options

-c
Creates permanent output even if there were warning messages. Normally, localedef does not create permanent output when it has issued warning messages.
-f charmap
Specifies a charmap file that contains a mapping of character symbols and collating element symbols to actual character encodings.
-i sourcefile
Specifies the file that contains the source definitions. If there is no -i, localedef reads the source definitions from the standard input.
-m methodfile
Specifies the name of a method file that describes the methods to be overridden when constructing a locale. localedef reads the method file and uses entry points when constructing the locale objects. The code set methods specified are also used in parsing the file pointed to by the CharMap variable. This requires that you provide the overriding methods in a DLL which is explicitly loaded by localedef before processing the charmap file. User method files are supported only for ASCII locales. The -m option is invalid without the -A option.
-w
Produces warning messages for duplicate definitions.
-A
Instructs localedef to generate an ASCII locale object. The -X option is implied when this option is specified.
-L binderoptions
Instructs localedef to pass additional binder options (mostly for diagnostic purposes).
-X
Instructs localedef to generate an XPLINK AMODE 31 locale object (DLL).
-6
Instructs localedef to generate an XPLINK AMODE 64 locale object (DLL). The -X option is implied when this option is specified.
name
Is the target locale. If it contains no slashes, the locale is public and localedef converts name to a full path name using the NLSPATH environment variable. If name contains one or more slashes, localedef interprets it as a full path name of where to store the created definition.

See locale for related information.

Localization

localedef uses the following localization environment variables:
  • LANG
  • LC_ALL
  • LC_MESSAGES
  • NLSPATH

The LC_COLLATE and LC_CTYPE environment variables do not affect localedef. localedef always behaves as though these variables were set to the POSIX locale.

Exit values

0
No errors occurred; the locale was successfully created.
1
Warnings occurred; the locale was successfully created.
2
The locale specification exceeded implementation limits, or the coded character set used was not supported by implementation. No locale was created.
3
The capability to create new locales is not supported by the implementation. (POSIX2_LOCALEDEF is not defined.)
>3
Warnings or errors occurred; no output was created.
localedef issues warnings when:
  • The LC_CTYPE or LC_COLLATE category description uses a symbolic name that was not found in the charmap file.
  • The number of operands to the order keyword exceeds the COLL_WEIGHTS_MAX limit.

Portability

POSIX.2; UNIX System V.

Related information

locale