31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
32 .\" or http://www.opensolaris.org/os/licensing.
33 .\" See the License for the specific language governing permissions
34 .\" and limitations under the License.
35 .\"
36 .\" When distributing Covered Code, include this CDDL HEADER in each
37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
38 .\" If applicable, add the following below this CDDL HEADER, with the
39 .\" fields enclosed by brackets "[]" replaced with your own identifying
40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
41 .\"
42 .\"
43 .\" Copyright (c) 1992, X/Open Company Limited All Rights Reserved
44 .\" Portions Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved
45 .\" Portions Copyright 2013 DEY Storage Systems, Inc.
46 .\"
47 .TH LOCALEDEF 1 "April 9, 2016"
48 .SH NAME
49 localedef \- define locale environment
50 .SH SYNOPSIS
51 .LP
52 .nf
53 \fBlocaledef\fR [\fB-c\fR] [\fB-v\fR] [\fB-U\fR\] [\fB-f\fR \fIcharmap\fR]
54 [\fB-w\fR \fIwidthfile\fR] [\fB-i\fR \fIsourcefile\fR]
55 [\fB-u\fR \fIcode_set_name\fR] \fIlocalename\fR
56 .fi
57
58 .SH DESCRIPTION
59 .LP
60 The \fBlocaledef\fR utility converts source definitions for locale categories
61 into a format usable by the functions and utilities whose operational behavior
62 is determined by the setting of the locale environment variables; see
63 \fBenviron\fR(5).
64 .sp
65 .LP
66 The utility reads source definitions for one or more locale categories
67 belonging to the same locale from the file named in the \fB-i\fR option (if
68 specified) or from standard input.
69 .sp
70 .LP
71 Each category source definition is identified by the corresponding environment
72 variable name and terminated by an \fBEND\fR \fIcategory-name\fR statement. The
73 following categories are supported.
74 .sp
75 .ne 2
76 .na
77 \fB\fBLC_CTYPE\fR\fR
78 .ad
79 .RS 15n
110
111 .sp
112 .ne 2
113 .na
114 \fB\fBLC_TIME\fR\fR
115 .ad
116 .RS 15n
117 Defines the format and content of date and time information.
118 .RE
119
120 .sp
121 .ne 2
122 .na
123 \fB\fBLC_MESSAGES\fR\fR
124 .ad
125 .RS 15n
126 Defines the format and values of affirmative and negative responses.
127 .RE
128
129 .SH OPTIONS
130 .LP
131 The following options are supported:
132 .sp
133 .ne 2
134 .na
135 \fB\fB-c\fR\fR
136 .ad
137 .RS 23n
138 Creates permanent output even if warning messages have been issued.
139 .RE
140
141 .sp
142 .ne 2
143 .na
144 \fB\fB-v\fR\fR
145 .ad
146 .RS 23n
147 Emit verbose debugging output on standard output.
148 .RE
149
150 .sp
194 .na
195 \fB\fB-i\fR \fIsourcefile\fR\fR
196 .ad
197 .RS 23n
198 The path name of a file containing the source definitions. If this option is
199 not present, source definitions will be read from standard input.
200 .RE
201
202 .sp
203 .ne 2
204 .na
205 \fB\fB-u\fR \fIcode_set_name\fR\fR
206 .ad
207 .RS 23n
208 Specifies the name of a codeset used as the target mapping of character symbols
209 and collating element symbols whose encoding values are defined in terms of the
210 ISO/IEC 10646-1: 2000 standard position constant values. See NOTES.
211 .RE
212
213 .SH OPERANDS
214 .LP
215 The following operand is supported:
216 .sp
217 .ne 2
218 .na
219 \fB\fIlocalename\fR\fR
220 .ad
221 .RS 14n
222 Identifies the locale. If the name contains one or more slash characters,
223 \fIlocalename\fR will be interpreted as a path name where the created locale
224 definitions will be stored. This capability may be restricted to users with
225 appropriate privileges. (As a consequence of specifying one \fIlocalename\fR,
226 although several categories can be processed in one execution, only categories
227 belonging to the same locale can be processed.)
228 .RE
229
230 .SH OUTPUT
231 .LP
232 \fBlocaledef\fR creates a directory of files that represents the locale's
233 data. The contents of this directory should generally be copied into the
234 appropriate subdirectory of /usr/lib/locale in order the definitions to
235 be visible to programs linked with libc.
236 .sp
237 .SH ENVIRONMENT VARIABLES
238 .LP
239 See \fBenviron\fR(5) for definitions of the following environment variables
240 that affect the execution of \fBlocaledef\fR: \fBLANG\fR, \fBLC_ALL\fR,
241 \fBLC_COLLATE\fR, \fBLC_CTYPE\fR, \fBLC_MESSAGES\fR, and \fBNLSPATH\fR.
242 .SH EXIT STATUS
243 .LP
244 The following exit values are returned:
245 .sp
246 .ne 2
247 .na
248 \fB\fB0\fR\fR
249 .ad
250 .RS 6n
251 No errors occurred and the locales were successfully created.
252 .RE
253
254 .sp
255 .ne 2
256 .na
257 \fB\fB1\fR\fR
258 .ad
259 .RS 6n
260 Warnings occurred and the locales were successfully created.
261 .RE
262
263 .sp
277 \fB\fB>3\fR\fR
278 .ad
279 .RS 6n
280 Warnings or errors occurred and no output was created.
281 .RE
282
283 .sp
284 .LP
285 If an error is detected, no permanent output will be created.
286 .SH FILES
287 .ne 2
288 .na
289 \fB/usr/lib/locale/\fR\fIlocalename\fR\fB/\fR
290 .ad
291 .sp .6
292 .RS 4n
293 The directory containing locale data.
294 .RE
295
296 .SH ATTRIBUTES
297 .LP
298 See \fBattributes\fR(5) for descriptions of the following attributes:
299 .sp
300
301 .sp
302 .TS
303 box;
304 c | c
305 l | l .
306 ATTRIBUTE TYPE ATTRIBUTE VALUE
307 _
308 Interface Stability Standard
309 .TE
310
311 .SH SEE ALSO
312 .LP
313 \fBlocale\fR(1), \fBiconv_open\fR(3C), \fBnl_langinfo\fR(3C),
314 \fBstrftime\fR(3C), \fBattributes\fR(5), \fBcharmap\fR(5), \fBenviron\fR(5),
315 \fBextensions\fR(5), \fBlocale\fR(5), \fBstandards\fR(5)
316 .SH WARNINGS
317 .LP
318 If warnings occur, permanent output will be created if the \fB-c\fR option was
319 specified. The following conditions will cause warning messages to be issued:
320 .RS +4
321 .TP
322 .ie t \(bu
323 .el o
324 If a symbolic name not found in the \fIcharmap\fR file is used for the
325 descriptions of the \fBLC_CTYPE\fR or \fBLC_COLLATE\fR categories (for other
326 categories, this will be an error condition).
327 .RE
328 .RS +4
329 .TP
330 .ie t \(bu
331 .el o
332 If optional keywords not supported by the implementation are present in the
333 source.
334 .RE
335 .SH NOTES
336 .LP
337 When the \fB-u\fR option is used, the \fIcode_set_name\fR option-argument is
338 interpreted as a name of a codeset to which the ISO/IEC 10646-1: 2000 standard
339 position constant values are converted. Both the ISO/IEC 10646-1: 2000 standard
340 position constant values and other formats (decimal, hexadecimal, or octal) are
341 valid as encoding values within the charmap file. The codeset can be any
342 codeset that is supported by the \fBiconv_open\fR(3C) function on the system.
343 .sp
344 .LP
345 When conflicts occur between the charmap specification of \fIcode_set_name\fR,
346 \fImb_cur_max\fR, or \fImb_cur_min\fR and the corresponding value for the
347 codeset represented by the \fB-u\fR option-argument \fIcode_set_name\fR, the
348 \fBlocaledef\fR utility fails as an error.
349 .sp
350 .LP
351 When conflicts occur between the charmap encoding values specified for symbolic
352 names of characters of the portable character set and the character encoding
353 values defined by the US-ASCII, the result is unspecified.
|
31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
32 .\" or http://www.opensolaris.org/os/licensing.
33 .\" See the License for the specific language governing permissions
34 .\" and limitations under the License.
35 .\"
36 .\" When distributing Covered Code, include this CDDL HEADER in each
37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
38 .\" If applicable, add the following below this CDDL HEADER, with the
39 .\" fields enclosed by brackets "[]" replaced with your own identifying
40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
41 .\"
42 .\"
43 .\" Copyright (c) 1992, X/Open Company Limited All Rights Reserved
44 .\" Portions Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved
45 .\" Portions Copyright 2013 DEY Storage Systems, Inc.
46 .\"
47 .TH LOCALEDEF 1 "April 9, 2016"
48 .SH NAME
49 localedef \- define locale environment
50 .SH SYNOPSIS
51 .nf
52 \fBlocaledef\fR [\fB-c\fR] [\fB-v\fR] [\fB-U\fR] [\fB-f\fR \fIcharmap\fR]
53 [\fB-w\fR \fIwidthfile\fR] [\fB-i\fR \fIsourcefile\fR]
54 [\fB-u\fR \fIcode_set_name\fR] \fIlocalename\fR
55 .fi
56
57 .SH DESCRIPTION
58 The \fBlocaledef\fR utility converts source definitions for locale categories
59 into a format usable by the functions and utilities whose operational behavior
60 is determined by the setting of the locale environment variables; see
61 \fBenviron\fR(5).
62 .sp
63 .LP
64 The utility reads source definitions for one or more locale categories
65 belonging to the same locale from the file named in the \fB-i\fR option (if
66 specified) or from standard input.
67 .sp
68 .LP
69 Each category source definition is identified by the corresponding environment
70 variable name and terminated by an \fBEND\fR \fIcategory-name\fR statement. The
71 following categories are supported.
72 .sp
73 .ne 2
74 .na
75 \fB\fBLC_CTYPE\fR\fR
76 .ad
77 .RS 15n
108
109 .sp
110 .ne 2
111 .na
112 \fB\fBLC_TIME\fR\fR
113 .ad
114 .RS 15n
115 Defines the format and content of date and time information.
116 .RE
117
118 .sp
119 .ne 2
120 .na
121 \fB\fBLC_MESSAGES\fR\fR
122 .ad
123 .RS 15n
124 Defines the format and values of affirmative and negative responses.
125 .RE
126
127 .SH OPTIONS
128 The following options are supported:
129 .sp
130 .ne 2
131 .na
132 \fB\fB-c\fR\fR
133 .ad
134 .RS 23n
135 Creates permanent output even if warning messages have been issued.
136 .RE
137
138 .sp
139 .ne 2
140 .na
141 \fB\fB-v\fR\fR
142 .ad
143 .RS 23n
144 Emit verbose debugging output on standard output.
145 .RE
146
147 .sp
191 .na
192 \fB\fB-i\fR \fIsourcefile\fR\fR
193 .ad
194 .RS 23n
195 The path name of a file containing the source definitions. If this option is
196 not present, source definitions will be read from standard input.
197 .RE
198
199 .sp
200 .ne 2
201 .na
202 \fB\fB-u\fR \fIcode_set_name\fR\fR
203 .ad
204 .RS 23n
205 Specifies the name of a codeset used as the target mapping of character symbols
206 and collating element symbols whose encoding values are defined in terms of the
207 ISO/IEC 10646-1: 2000 standard position constant values. See NOTES.
208 .RE
209
210 .SH OPERANDS
211 The following operand is supported:
212 .sp
213 .ne 2
214 .na
215 \fB\fIlocalename\fR\fR
216 .ad
217 .RS 14n
218 Identifies the locale. If the name contains one or more slash characters,
219 \fIlocalename\fR will be interpreted as a path name where the created locale
220 definitions will be stored. This capability may be restricted to users with
221 appropriate privileges. (As a consequence of specifying one \fIlocalename\fR,
222 although several categories can be processed in one execution, only categories
223 belonging to the same locale can be processed.)
224 .RE
225
226 .SH OUTPUT
227 \fBlocaledef\fR creates a directory of files that represents the locale's
228 data. The contents of this directory should generally be copied into the
229 appropriate subdirectory of /usr/lib/locale in order the definitions to
230 be visible to programs linked with libc.
231 .sp
232 .SH ENVIRONMENT VARIABLES
233 See \fBenviron\fR(5) for definitions of the following environment variables
234 that affect the execution of \fBlocaledef\fR: \fBLANG\fR, \fBLC_ALL\fR,
235 \fBLC_COLLATE\fR, \fBLC_CTYPE\fR, \fBLC_MESSAGES\fR, and \fBNLSPATH\fR.
236 .SH EXIT STATUS
237 The following exit values are returned:
238 .sp
239 .ne 2
240 .na
241 \fB\fB0\fR\fR
242 .ad
243 .RS 6n
244 No errors occurred and the locales were successfully created.
245 .RE
246
247 .sp
248 .ne 2
249 .na
250 \fB\fB1\fR\fR
251 .ad
252 .RS 6n
253 Warnings occurred and the locales were successfully created.
254 .RE
255
256 .sp
270 \fB\fB>3\fR\fR
271 .ad
272 .RS 6n
273 Warnings or errors occurred and no output was created.
274 .RE
275
276 .sp
277 .LP
278 If an error is detected, no permanent output will be created.
279 .SH FILES
280 .ne 2
281 .na
282 \fB/usr/lib/locale/\fR\fIlocalename\fR\fB/\fR
283 .ad
284 .sp .6
285 .RS 4n
286 The directory containing locale data.
287 .RE
288
289 .SH ATTRIBUTES
290 See \fBattributes\fR(5) for descriptions of the following attributes:
291 .sp
292
293 .sp
294 .TS
295 box;
296 c | c
297 l | l .
298 ATTRIBUTE TYPE ATTRIBUTE VALUE
299 _
300 Interface Stability Standard
301 .TE
302
303 .SH SEE ALSO
304 \fBlocale\fR(1), \fBiconv_open\fR(3C), \fBnl_langinfo\fR(3C),
305 \fBstrftime\fR(3C), \fBattributes\fR(5), \fBcharmap\fR(5), \fBenviron\fR(5),
306 \fBextensions\fR(5), \fBlocale\fR(5), \fBstandards\fR(5)
307 .SH WARNINGS
308 If warnings occur, permanent output will be created if the \fB-c\fR option was
309 specified. The following conditions will cause warning messages to be issued:
310 .RS +4
311 .TP
312 .ie t \(bu
313 .el o
314 If a symbolic name not found in the \fIcharmap\fR file is used for the
315 descriptions of the \fBLC_CTYPE\fR or \fBLC_COLLATE\fR categories (for other
316 categories, this will be an error condition).
317 .RE
318 .RS +4
319 .TP
320 .ie t \(bu
321 .el o
322 If optional keywords not supported by the implementation are present in the
323 source.
324 .RE
325 .SH NOTES
326 When the \fB-u\fR option is used, the \fIcode_set_name\fR option-argument is
327 interpreted as a name of a codeset to which the ISO/IEC 10646-1: 2000 standard
328 position constant values are converted. Both the ISO/IEC 10646-1: 2000 standard
329 position constant values and other formats (decimal, hexadecimal, or octal) are
330 valid as encoding values within the charmap file. The codeset can be any
331 codeset that is supported by the \fBiconv_open\fR(3C) function on the system.
332 .sp
333 .LP
334 When conflicts occur between the charmap specification of \fIcode_set_name\fR,
335 \fImb_cur_max\fR, or \fImb_cur_min\fR and the corresponding value for the
336 codeset represented by the \fB-u\fR option-argument \fIcode_set_name\fR, the
337 \fBlocaledef\fR utility fails as an error.
338 .sp
339 .LP
340 When conflicts occur between the charmap encoding values specified for symbolic
341 names of characters of the portable character set and the character encoding
342 values defined by the US-ASCII, the result is unspecified.
|