Print this page
11622 clean up rarer mandoc lint warnings
| Split |
Close |
| Expand all |
| Collapse all |
--- old/usr/src/man/man1/localedef.1
+++ new/usr/src/man/man1/localedef.1
1 1 .\"
2 2 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
3 3 .\" permission to reproduce portions of its copyrighted documentation.
4 4 .\" Original documentation from The Open Group can be obtained online at
5 5 .\" http://www.opengroup.org/bookstore/.
6 6 .\"
7 7 .\" The Institute of Electrical and Electronics Engineers and The Open
8 8 .\" Group, have given us permission to reprint portions of their
9 9 .\" documentation.
10 10 .\"
11 11 .\" In the following statement, the phrase ``this text'' refers to portions
12 12 .\" of the system documentation.
13 13 .\"
14 14 .\" Portions of this text are reprinted and reproduced in electronic form
15 15 .\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
16 16 .\" Standard for Information Technology -- Portable Operating System
17 17 .\" Interface (POSIX), The Open Group Base Specifications Issue 6,
18 18 .\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
19 19 .\" Engineers, Inc and The Open Group. In the event of any discrepancy
20 20 .\" between these versions and the original IEEE and The Open Group
21 21 .\" Standard, the original IEEE and The Open Group Standard is the referee
22 22 .\" document. The original Standard can be obtained online at
23 23 .\" http://www.opengroup.org/unix/online.html.
24 24 .\"
25 25 .\" This notice shall appear on any product containing this material.
26 26 .\"
27 27 .\" The contents of this file are subject to the terms of the
28 28 .\" Common Development and Distribution License (the "License").
29 29 .\" You may not use this file except in compliance with the License.
30 30 .\"
31 31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
32 32 .\" or http://www.opensolaris.org/os/licensing.
33 33 .\" See the License for the specific language governing permissions
34 34 .\" and limitations under the License.
35 35 .\"
36 36 .\" When distributing Covered Code, include this CDDL HEADER in each
37 37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
38 38 .\" If applicable, add the following below this CDDL HEADER, with the
39 39 .\" fields enclosed by brackets "[]" replaced with your own identifying
40 40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
|
↓ open down ↓ |
40 lines elided |
↑ open up ↑ |
41 41 .\"
42 42 .\"
43 43 .\" Copyright (c) 1992, X/Open Company Limited All Rights Reserved
44 44 .\" Portions Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved
45 45 .\" Portions Copyright 2013 DEY Storage Systems, Inc.
46 46 .\"
47 47 .TH LOCALEDEF 1 "April 9, 2016"
48 48 .SH NAME
49 49 localedef \- define locale environment
50 50 .SH SYNOPSIS
51 -.LP
52 51 .nf
53 -\fBlocaledef\fR [\fB-c\fR] [\fB-v\fR] [\fB-U\fR\] [\fB-f\fR \fIcharmap\fR]
52 +\fBlocaledef\fR [\fB-c\fR] [\fB-v\fR] [\fB-U\fR] [\fB-f\fR \fIcharmap\fR]
54 53 [\fB-w\fR \fIwidthfile\fR] [\fB-i\fR \fIsourcefile\fR]
55 54 [\fB-u\fR \fIcode_set_name\fR] \fIlocalename\fR
56 55 .fi
57 56
58 57 .SH DESCRIPTION
59 -.LP
60 58 The \fBlocaledef\fR utility converts source definitions for locale categories
61 59 into a format usable by the functions and utilities whose operational behavior
62 60 is determined by the setting of the locale environment variables; see
63 61 \fBenviron\fR(5).
64 62 .sp
65 63 .LP
66 64 The utility reads source definitions for one or more locale categories
67 65 belonging to the same locale from the file named in the \fB-i\fR option (if
68 66 specified) or from standard input.
69 67 .sp
70 68 .LP
71 69 Each category source definition is identified by the corresponding environment
72 70 variable name and terminated by an \fBEND\fR \fIcategory-name\fR statement. The
73 71 following categories are supported.
74 72 .sp
75 73 .ne 2
76 74 .na
77 75 \fB\fBLC_CTYPE\fR\fR
78 76 .ad
79 77 .RS 15n
80 78 Defines character classification and case conversion.
81 79 .RE
82 80
83 81 .sp
84 82 .ne 2
85 83 .na
86 84 \fB\fBLC_COLLATE\fR\fR
87 85 .ad
88 86 .RS 15n
89 87 Defines collation rules.
90 88 .RE
91 89
92 90 .sp
93 91 .ne 2
94 92 .na
95 93 \fB\fBLC_MONETARY\fR\fR
96 94 .ad
97 95 .RS 15n
98 96 Defines the format and symbols used in formatting of monetary information.
99 97 .RE
100 98
101 99 .sp
102 100 .ne 2
103 101 .na
104 102 \fB\fBLC_NUMERIC\fR\fR
105 103 .ad
106 104 .RS 15n
107 105 Defines the decimal delimiter, grouping and grouping symbol for non-monetary
108 106 numeric editing.
109 107 .RE
110 108
111 109 .sp
112 110 .ne 2
113 111 .na
114 112 \fB\fBLC_TIME\fR\fR
115 113 .ad
116 114 .RS 15n
117 115 Defines the format and content of date and time information.
118 116 .RE
119 117
|
↓ open down ↓ |
50 lines elided |
↑ open up ↑ |
120 118 .sp
121 119 .ne 2
122 120 .na
123 121 \fB\fBLC_MESSAGES\fR\fR
124 122 .ad
125 123 .RS 15n
126 124 Defines the format and values of affirmative and negative responses.
127 125 .RE
128 126
129 127 .SH OPTIONS
130 -.LP
131 128 The following options are supported:
132 129 .sp
133 130 .ne 2
134 131 .na
135 132 \fB\fB-c\fR\fR
136 133 .ad
137 134 .RS 23n
138 135 Creates permanent output even if warning messages have been issued.
139 136 .RE
140 137
141 138 .sp
142 139 .ne 2
143 140 .na
144 141 \fB\fB-v\fR\fR
145 142 .ad
146 143 .RS 23n
147 144 Emit verbose debugging output on standard output.
148 145 .RE
149 146
150 147 .sp
151 148 .ne 2
152 149 .na
153 150 \fB\fB-U\fR\fR
154 151 .ad
155 152 .RS 23n
156 153 Ignore the presence of character symbols that have no matching character
157 154 definition. This facilitates the use of a common locale definition file
158 155 to be used across multiple encodings, even when some symbols are not
159 156 present in a given encoding.
160 157 .sp
161 158 Support for this option is an illumos extension.
162 159 .RE
163 160
164 161 .sp
165 162 .ne 2
166 163 .na
167 164 \fB\fB-f\fR \fIcharmap\fR\fR
168 165 .ad
169 166 .RS 23n
170 167 Specifies the pathname of a file containing a mapping of character symbols and
171 168 collating element symbols to actual character encodings. This option must be
172 169 specified if symbolic names (other than collating symbols defined in a
173 170 \fBcollating-symbol\fR keyword) are used. If the \fB-f\fR option is not
174 171 present, the default character mapping will be used.
175 172 .RE
176 173
177 174 .sp
178 175 .ne 2
179 176 .na
180 177 \fB\fB-w\fR \fIwidthfile\fR\fR
181 178 .ad
182 179 .RS 23n
183 180 The path name of the file containing character screen width definitions.
184 181 If not supplied, then default screen widths will be assumed, which will
185 182 generally not account for East Asian encodings requiring more than a single
186 183 character cell to display, nor for combining or accent marks that occupy
187 184 no additional screen width.
188 185 .sp
189 186 The support for width files is an illumos extension.
190 187 .RE
191 188
192 189 .sp
193 190 .ne 2
194 191 .na
195 192 \fB\fB-i\fR \fIsourcefile\fR\fR
196 193 .ad
197 194 .RS 23n
198 195 The path name of a file containing the source definitions. If this option is
199 196 not present, source definitions will be read from standard input.
200 197 .RE
201 198
202 199 .sp
203 200 .ne 2
|
↓ open down ↓ |
63 lines elided |
↑ open up ↑ |
204 201 .na
205 202 \fB\fB-u\fR \fIcode_set_name\fR\fR
206 203 .ad
207 204 .RS 23n
208 205 Specifies the name of a codeset used as the target mapping of character symbols
209 206 and collating element symbols whose encoding values are defined in terms of the
210 207 ISO/IEC 10646-1: 2000 standard position constant values. See NOTES.
211 208 .RE
212 209
213 210 .SH OPERANDS
214 -.LP
215 211 The following operand is supported:
216 212 .sp
217 213 .ne 2
218 214 .na
219 215 \fB\fIlocalename\fR\fR
220 216 .ad
221 217 .RS 14n
222 218 Identifies the locale. If the name contains one or more slash characters,
223 219 \fIlocalename\fR will be interpreted as a path name where the created locale
224 220 definitions will be stored. This capability may be restricted to users with
225 221 appropriate privileges. (As a consequence of specifying one \fIlocalename\fR,
226 222 although several categories can be processed in one execution, only categories
227 223 belonging to the same locale can be processed.)
228 224 .RE
229 225
230 226 .SH OUTPUT
231 -.LP
232 227 \fBlocaledef\fR creates a directory of files that represents the locale's
233 228 data. The contents of this directory should generally be copied into the
234 229 appropriate subdirectory of /usr/lib/locale in order the definitions to
235 230 be visible to programs linked with libc.
236 231 .sp
237 232 .SH ENVIRONMENT VARIABLES
238 -.LP
239 233 See \fBenviron\fR(5) for definitions of the following environment variables
240 234 that affect the execution of \fBlocaledef\fR: \fBLANG\fR, \fBLC_ALL\fR,
241 235 \fBLC_COLLATE\fR, \fBLC_CTYPE\fR, \fBLC_MESSAGES\fR, and \fBNLSPATH\fR.
242 236 .SH EXIT STATUS
243 -.LP
244 237 The following exit values are returned:
245 238 .sp
246 239 .ne 2
247 240 .na
248 241 \fB\fB0\fR\fR
249 242 .ad
250 243 .RS 6n
251 244 No errors occurred and the locales were successfully created.
252 245 .RE
253 246
254 247 .sp
255 248 .ne 2
256 249 .na
257 250 \fB\fB1\fR\fR
258 251 .ad
259 252 .RS 6n
260 253 Warnings occurred and the locales were successfully created.
261 254 .RE
262 255
263 256 .sp
264 257 .ne 2
265 258 .na
266 259 \fB\fB2\fR\fR
267 260 .ad
268 261 .RS 6n
269 262 The locale specification exceeded implementation limits or the coded character
270 263 set or sets used were not supported by the implementation, and no locale was
271 264 created.
272 265 .RE
273 266
274 267 .sp
275 268 .ne 2
276 269 .na
277 270 \fB\fB>3\fR\fR
278 271 .ad
279 272 .RS 6n
280 273 Warnings or errors occurred and no output was created.
281 274 .RE
282 275
283 276 .sp
284 277 .LP
285 278 If an error is detected, no permanent output will be created.
286 279 .SH FILES
|
↓ open down ↓ |
33 lines elided |
↑ open up ↑ |
287 280 .ne 2
288 281 .na
289 282 \fB/usr/lib/locale/\fR\fIlocalename\fR\fB/\fR
290 283 .ad
291 284 .sp .6
292 285 .RS 4n
293 286 The directory containing locale data.
294 287 .RE
295 288
296 289 .SH ATTRIBUTES
297 -.LP
298 290 See \fBattributes\fR(5) for descriptions of the following attributes:
299 291 .sp
300 292
301 293 .sp
302 294 .TS
303 295 box;
304 296 c | c
305 297 l | l .
306 298 ATTRIBUTE TYPE ATTRIBUTE VALUE
307 299 _
308 300 Interface Stability Standard
309 301 .TE
310 302
311 303 .SH SEE ALSO
312 -.LP
313 304 \fBlocale\fR(1), \fBiconv_open\fR(3C), \fBnl_langinfo\fR(3C),
314 305 \fBstrftime\fR(3C), \fBattributes\fR(5), \fBcharmap\fR(5), \fBenviron\fR(5),
315 306 \fBextensions\fR(5), \fBlocale\fR(5), \fBstandards\fR(5)
316 307 .SH WARNINGS
317 -.LP
318 308 If warnings occur, permanent output will be created if the \fB-c\fR option was
319 309 specified. The following conditions will cause warning messages to be issued:
320 310 .RS +4
321 311 .TP
322 312 .ie t \(bu
323 313 .el o
324 314 If a symbolic name not found in the \fIcharmap\fR file is used for the
325 315 descriptions of the \fBLC_CTYPE\fR or \fBLC_COLLATE\fR categories (for other
326 316 categories, this will be an error condition).
327 317 .RE
328 318 .RS +4
329 319 .TP
330 320 .ie t \(bu
331 321 .el o
332 322 If optional keywords not supported by the implementation are present in the
333 323 source.
334 324 .RE
335 325 .SH NOTES
336 -.LP
337 326 When the \fB-u\fR option is used, the \fIcode_set_name\fR option-argument is
338 327 interpreted as a name of a codeset to which the ISO/IEC 10646-1: 2000 standard
339 328 position constant values are converted. Both the ISO/IEC 10646-1: 2000 standard
340 329 position constant values and other formats (decimal, hexadecimal, or octal) are
341 330 valid as encoding values within the charmap file. The codeset can be any
342 331 codeset that is supported by the \fBiconv_open\fR(3C) function on the system.
343 332 .sp
344 333 .LP
345 334 When conflicts occur between the charmap specification of \fIcode_set_name\fR,
346 335 \fImb_cur_max\fR, or \fImb_cur_min\fR and the corresponding value for the
347 336 codeset represented by the \fB-u\fR option-argument \fIcode_set_name\fR, the
348 337 \fBlocaledef\fR utility fails as an error.
349 338 .sp
350 339 .LP
351 340 When conflicts occur between the charmap encoding values specified for symbolic
352 341 names of characters of the portable character set and the character encoding
353 342 values defined by the US-ASCII, the result is unspecified.
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX