Sun Microsystems, Inc. gratefully acknowledges The Open Group for
permission to reproduce portions of its copyrighted documentation.
Original documentation from The Open Group can be obtained online at
http://www.opengroup.org/bookstore/.
The Institute of Electrical and Electronics Engineers and The Open
Group, have given us permission to reprint portions of their
documentation.
In the following statement, the phrase ``this text'' refers to portions
of the system documentation.
Portions of this text are reprinted and reproduced in electronic form
in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
Standard for Information Technology -- Portable Operating System
Interface (POSIX), The Open Group Base Specifications Issue 6,
Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
Engineers, Inc and The Open Group. In the event of any discrepancy
between these versions and the original IEEE and The Open Group
Standard, the original IEEE and The Open Group Standard is the referee
document. The original Standard can be obtained online at
http://www.opengroup.org/unix/online.html.
This notice shall appear on any product containing this material.
The contents of this file are subject to the terms of the
Common Development and Distribution License (the "License").
You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
or http://www.opensolaris.org/os/licensing.
See the License for the specific language governing permissions
and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each
file and include the License file at usr/src/OPENSOLARIS.LICENSE.
If applicable, add the following below this CDDL HEADER, with the
fields enclosed by brackets "[]" replaced with your own identifying
information: Portions Copyright [yyyy] [name of copyright owner]
Copyright (c) 1992, X/Open Company Limited. All Rights Reserved.
Portions Copyright (c) 1995, Sun Microsystems, Inc. All Rights Reserved.
locale [-a | -m]
locale [-ck] name...
The locale utility writes information about the current locale environment, or all public locales, to the standard output. For the purposes of this section, a public locale is one provided by the implementation that is accessible to the application.
When locale is invoked without any arguments, it summarizes the current locale environment for each locale category as determined by the settings of the environment variables.
When invoked with operands, it writes values that have been assigned to the keywords in the locale categories, as follows:
Specifying a keyword name selects the named keyword and the category containing that keyword.
Specifying a category name selects the named category and all keywords in that category.
The following options are supported: -a
Writes information about all available public locales. The available locales include POSIX, representing the POSIX locale.
Writes the names of selected locale categories. The -c option increases readability when more than one category is selected (for example, via more than one keyword name or via a category name). It is valid both with and without the -k option.
Writes the names and values of selected keywords. The implementation may omit values for some keywords; see OPERANDS.
Writes names of available charmaps; see localedef(1).
The following operand is supported: name
The name of a locale category, the name of a keyword in a locale category, or the reserved name charmap. The named category or keyword will be selected for output. If a single name represents both a locale category name and a keyword name in the current locale, the results are unspecified; otherwise, both category and keyword names can be specified as name operands, in any sequence.
Example 1 Examples of the locale utility
In the following examples, the assumption is that locale environment variables are set as follows:
LANG=locale_x LC_COLLATE=locale_y
The command locale would result in the following output:
LANG=locale_x LC_CTYPE="locale_x" LC_NUMERIC="locale_x" LC_TIME="locale_x" LC_COLLATE=locale_y LC_MONETARY="locale_x" LC_MESSAGES="locale_x" LC_ALL=
The command
LC_ALL=POSIX locale -ck decimal_point
would produce:
LC_NUMERIC decimal_point="."
The following command shows an application of locale to determine whether a user-supplied response is affirmative:
if printf "%s\en" "$response" | /usr/bin/grep -Eq\e
"$(locale yesexpr)"
then
affirmative processing goes here
else
non-affirmative processing goes here
fi
See environ(5) for the descriptions of LANG, LC_ALL, LC_CTYPE, LC_MESSAGES, and NLSPATH.
The LANG, LC_*, and NLSPATH environment variables must specify the current locale environment to be written out. These environment variables will be used if the -a option is not specified.
The following exit values are returned: 0
All the requested information was found and output successfully.
An error occurred.
See attributes(5) for descriptions of the following attributes:
| ATTRIBUTE TYPE ATTRIBUTE VALUE |
| CSI Enabled |
| Interface Stability Standard |
localedef(1), attributes(5), charmap(5), environ(5), locale(5), standards(5)
If LC_CTYPE or keywords in the category LC_CTYPE are specified, only the values in the range 0x00-0x7f are written out.
If LC_COLLATE or keywords in the category LC_COLLATE are specified, no actual values are written out.