1 .\" Copyright (c) 1992, X/Open Company Limited All Rights Reserved
2 .\" Portions Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved
3 .\" Portions Copyright 2013 DEY Storage Systems, Inc.
4 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
5 .\" permission to reproduce portions of its copyrighted documentation.
6 .\" Original documentation from The Open Group can be obtained online at
7 .\" http://www.opengroup.org/bookstore/.
8 .\" The Institute of Electrical and Electronics Engineers and The Open Group,
9 .\" have given us permission to reprint portions of their documentation. In
10 .\" the following statement, the phrase "this text" refers to portions of the
11 .\" system documentation. Portions of this text are reprinted and reproduced
12 .\" in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1,
13 .\" 2004 Edition, Standard for Information Technology -- Portable Operating
14 .\" System Interface (POSIX), The Open Group Base Specifications Issue 6,
15 .\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
16 .\" Engineers, Inc and The Open Group. In the event of any discrepancy between
17 .\" these versions and the original IEEE and The Open Group Standard, the
18 .\" original IEEE and The Open Group Standard is the referee document. The
19 .\" original Standard can be obtained online at
20 .\" http://www.opengroup.org/unix/online.html.
21 .\" This notice shall appear on any product containing this material.
22 .\" The contents of this file are subject to the terms of the Common
23 .\" Development and Distribution License (the "License"). You may not use
24 .\" this file except in compliance with the License.
25 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or
26 .\" http://www.opensolaris.org/os/licensing. See the License for the specific
27 .\" language governing permissions and limitations under the License.
28 .\" When distributing Covered Code, include this CDDL HEADER in each file and
29 .\" include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable,
30 .\" add the following below this CDDL HEADER, with the fields enclosed by
31 .\" brackets "[]" replaced with your own identifying information:
32 .\" Portions Copyright [yyyy] [name of copyright owner]
41 .Nd define locale environment
46 .Op Fl i Ar sourcefile
53 utility converts source definitions for locale categories
54 into a format usable by the functions and utilities whose operational behavior
55 is determined by the setting of the locale environment variables; see
58 The utility reads source definitions for one or more locale categories
59 belonging to the same locale from the file named in the
61 option (if specified) or from standard input.
63 Each category source definition is identified by the corresponding environment
64 variable name and terminated by an
68 The following categories are supported:
69 .Bl -tag -width ".Ev LC_MONETARY"
71 Defines character classification and case conversion.
73 Defines collation rules.
75 Defines the format and symbols used in formatting of monetary information.
77 Defines the decimal delimiter, grouping and grouping symbol for non-monetary
80 Defines the format and content of date and time information.
82 Defines the format and values of affirmative and negative responses.
85 The following options are supported:
86 .Bl -tag -width indent
88 Use big-endian byte order for output.
90 Creates permanent output even if warning messages have been issued.
94 Rather than the default of creating the
96 directory and creating files like
99 etc.\& in that directory,
100 the output file names have the format
101 .Dq <localename>.<category>
102 and are dumped to the current directory.
104 Specifies the pathname of a file containing a mapping of character symbols and
105 collating element symbols to actual character encodings.
106 This option must be specified if symbolic names (other than collating symbols
112 option is not present, the default character mapping will be used.
113 .It Fl i Ar sourcefile
114 The path name of a file containing the source definitions.
115 If this option is not present, source definitions will be read from
118 Use little-endian byte order for output.
120 Specifies the name of a codeset used as the target mapping of character symbols
121 and collating element symbols whose encoding values are defined in terms of the
122 ISO/IEC 10646-1:2000 standard position constant values.
126 Ignore the presence of character symbols that have no matching character
128 This facilitates the use of a common locale definition file to be used across multiple
129 encodings, even when some symbols are not present in a given encoding.
131 Emit verbose debugging output on standard output.
132 .It Fl w Ar widthfile
133 The path name of the file containing character screen width definitions.
134 If not supplied, then default screen widths will be assumed, which will
135 generally not account for East Asian encodings requiring more than a single
136 character cell to display, nor for combining or accent marks that occupy
137 no additional screen width.
139 Specifies a version string describing the version of the locale definition.
140 This string can be retrieved with
142 and is intended to allow applications to detect locale definition changes.
143 Currently it is stored only for the
148 The following operands are required:
149 .Bl -tag -width ".Ar localename"
151 Identifies the locale.
152 If the name contains one or more slash characters,
154 will be interpreted as a path name where the created locale
155 definitions will be stored.
156 This capability may be restricted to users with appropriate privileges.
157 (As a consequence of specifying one
159 although several categories can be processed in one execution, only categories
160 belonging to the same locale can be processed.)
164 creates a directory of files that represents the locale's data,
165 unless instructed otherwise by the
169 The contants of this directory should generally be copied into the
170 appropriate subdirectory of
171 .Pa /usr/share/locale
172 in order the definitions to be visible to programs linked with libc.
176 for definitions of the following environment variables that affect the
190 The following exit values are returned:
193 No errors occurred and the locales were successfully created.
195 Warnings occurred and the locales were successfully created.
197 The locale specification exceeded implementation limits or the coded character
198 set or sets used were not supported by the implementation, and no locale was
201 Warnings or errors occurred and no output was created.
204 If an error is detected, no permanent output will be created.
213 If warnings occur, permanent output will be created if the
215 option was specified.
216 The following conditions will cause warning messages to be issued:
219 If a symbolic name not found in the
221 file is used for the descriptions of the
225 categories (for other categories, this will be an error condition).
227 If optional keywords not supported by the implementation are present in the
235 option-argument is interpreted as a name of a codeset to which the
236 ISO/IEC 10646-1:2000 standard position constant values are converted.
237 Both the ISO/IEC 10646-1:2000 standard position constant values and
238 other formats (decimal, hexadecimal, or octal) are valid as encoding
239 values within the charmap file.
242 can be any codeset that is supported by the
246 When conflicts occur between the charmap specification of
251 and the corresponding value for the codeset represented by the
257 utility fails with an error.
259 When conflicts occur between the charmap encoding values specified for symbolic
260 names of characters of the portable character set and the character encoding
261 values defined by the US-ASCII, the result is unspecified.
269 .Aq Mt garrett@nexenta.com
272 .Aq Mt draco@marino.st
273 provided the alternations necessary to compile cleanly on
275 .An Baptiste Daroussin
276 .Aq Mt bapt@FreeBSD.org