| blob | 639c6aab67dc2816bb3fba7fbca8a8450fa92b2f |
1 '\" te
2 .\" Copyright (c) 1992, X/Open Company Limited All Rights Reserved Portions Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved
3 .\" 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/.
4 .\" 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
5 .\" are reprinted and reproduced in electronic form in the Sun OS 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
6 .\" 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.
7 .\" This notice shall appear on any product containing this material.
8 .\" 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.
9 .\" 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
10 .\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
11 .TH LOCALE 5 "April 9, 2016"
12 .SH NAME
13 locale \- subset of a user's environment that depends on language and cultural
14 conventions
15 .SH DESCRIPTION
16 .LP
17 A \fBlocale\fR is the definition of the subset of a user's environment that
18 depends on language and cultural conventions. It is made up from one or more
19 categories. Each category is identified by its name and controls specific
20 aspects of the behavior of components of the system. Category names correspond
21 to the following environment variable names:
22 .sp
23 .ne 2
24 .na
25 \fB\fBLC_CTYPE\fR\fR
26 .ad
27 .RS 15n
28 Character classification and case conversion.
29 .RE
31 .sp
32 .ne 2
33 .na
34 \fB\fBLC_COLLATE\fR\fR
35 .ad
36 .RS 15n
37 Collation order.
38 .RE
40 .sp
41 .ne 2
42 .na
43 \fB\fBLC_TIME\fR\fR
44 .ad
45 .RS 15n
46 Date and time formats.
47 .RE
49 .sp
50 .ne 2
51 .na
52 \fB\fBLC_NUMERIC\fR\fR
53 .ad
54 .RS 15n
55 Numeric formatting.
56 .RE
58 .sp
59 .ne 2
60 .na
61 \fB\fBLC_MONETARY\fR\fR
62 .ad
63 .RS 15n
64 Monetary formatting.
65 .RE
67 .sp
68 .ne 2
69 .na
70 \fB\fBLC_MESSAGES\fR\fR
71 .ad
72 .RS 15n
73 Formats of informative and diagnostic messages and interactive responses.
74 .RE
76 .sp
77 .LP
78 The standard utilities base their behavior on the current locale, as defined
79 in the ENVIRONMENT VARIABLES section for each utility. The behavior of some of
80 the C-language functions will also be modified based on the current locale, as
81 defined by the last call to \fBsetlocale\fR(3C).
82 .sp
83 .LP
84 Locales other than those supplied by the implementation can be created by the
85 application via the \fBlocaledef\fR(1) utility. The value that is used to
86 specify a locale when using environment variables will be the string specified
87 as the \fIname\fR operand to \fBlocaledef\fR when the locale was created. The
88 strings "C" and "POSIX" are reserved as identifiers for the POSIX locale.
89 .sp
90 .LP
91 Applications can select the desired locale by invoking the \fBsetlocale()\fR
92 function with the appropriate value. If the function is invoked with an empty
93 string, such as:
94 .sp
95 .in +2
96 .nf
97 setlocale(LC_ALL, "");
98 .fi
99 .in -2
101 .sp
102 .LP
103 the value of the corresponding environment variable is used. If the environment
104 variable is unset or is set to the empty string, the \fBsetlocale()\fR
105 function sets the appropriate environment.
106 .SS "Locale Definition"
107 .LP
108 Locales can be described with the file format accepted by the \fBlocaledef\fR
109 utility.
110 .sp
111 .LP
112 The locale definition file must contain one or more locale category source
113 definitions, and must not contain more than one definition for the same locale
114 category.
115 .sp
116 .LP
117 A category source definition consists of a category header, a category body and
118 a category trailer. A category header consists of the character string naming
119 of the category, beginning with the characters \fBLC_\fR. The category trailer
120 consists of the string \fBEND\fR, followed by one or more blank characters and
121 the string used in the corresponding category header.
122 .sp
123 .LP
124 The category body consists of one or more lines of text. Each line contains an
125 identifier, optionally followed by one or more operands. Identifiers are either
126 keywords, identifying a particular locale element, or collating elements. Each
127 keyword within a locale must have a unique name (that is, two categories cannot
128 have a commonly-named keyword). No keyword can start with the characters
129 \fBLC_\fR. Identifiers must be separated from the operands by one or more blank
130 characters.
131 .sp
132 .LP
133 Operands must be characters, collating elements, or strings of characters.
134 Strings must be enclosed in double-quotes (\fB"\fR). Literal double-quotes
135 within strings must be preceded by the <\fIescape character\fR>, as described
136 below. When a keyword is followed by more than one operand, the operands must
137 be separated by semicolons (\fB;\fR). Blank characters are allowed both before
138 and after a semicolon.
139 .sp
140 .LP
141 The first category header in the file can be preceded by a line modifying the
142 comment character. It has the following format, starting in column 1:
143 .sp
144 .in +2
145 .nf
146 "comment_char %c\en",<\fIcomment character\fR>
147 .fi
148 .in -2
150 .sp
151 .LP
152 The comment character defaults to the number sign (\fB#\fR). Blank lines and
153 lines containing the <\fIcomment character\fR> in the first position are
154 ignored.
155 .sp
156 .LP
157 The first category header in the file can be preceded by a line modifying the
158 escape character to be used in the file. It has the following format, starting
159 in column 1:
160 .sp
161 .in +2
162 .nf
163 "escape_char %c\en",<\fIescape character\fR>
164 .fi
165 .in -2
166 .sp
168 .sp
169 .LP
170 The escape character defaults to backslash.
171 .sp
172 .LP
173 A line can be continued by placing an escape character as the last character on
174 the line; this continuation character will be discarded from the input.
175 Although the implementation need not accept any one portion of a continued line
176 with a length exceeding \fB{LINE_MAX}\fR bytes, it places no limits on the
177 accumulated length of the continued line. Comment lines cannot be continued on
178 a subsequent line using an escaped newline character.
179 .sp
180 .LP
181 Individual characters, characters in strings, and collating elements must be
182 represented using symbolic names, as defined below. In addition, characters can
183 be represented using the characters themselves or as octal, hexadecimal or
184 decimal constants. When non-symbolic notation is used, the resultant locale
185 definitions will in many cases not be portable between systems. The left angle
186 bracket (\fB<\fR) is a reserved symbol, denoting the start of a symbolic name;
187 when used to represent itself it must be preceded by the escape character. The
188 following rules apply to character representation:
189 .RS +4
190 .TP
191 1.
192 A character can be represented via a symbolic name, enclosed within angle
193 brackets \fB<\fR and \fB>\fR. The symbolic name, including the angle brackets,
194 must exactly match a symbolic name defined in the charmap file specified via
195 the \fBlocaledef\fR \fB-f\fR option, and will be replaced by a character value
196 determined from the value associated with the symbolic name in the charmap
197 file. The use of a symbolic name not found in the charmap file constitutes an
198 error, unless the category is \fBLC_CTYPE\fR or \fBLC_COLLATE\fR, in which
199 case it constitutes a warning condition (see \fBlocaledef\fR(1) for a
200 description of action resulting from errors and warnings). The specification of
201 a symbolic name in a \fBcollating-element\fR or \fBcollating-symbol\fR section
202 that duplicates a symbolic name in the charmap file (if present) is an error.
203 Use of the escape character or a right angle bracket within a symbolic name is
204 invalid unless the character is preceded by the escape character.
205 .sp
206 Example:
207 .sp
208 .in +2
209 .nf
210 <C>;<c-cedilla> "<M><a><y>"
211 .fi
212 .in -2
213 .sp
215 .RE
216 .RS +4
217 .TP
218 2.
219 A character can be represented by the character itself, in which case the
220 value of the character is implementation-dependent. Within a string, the
221 double-quote character, the escape character and the right angle bracket
222 character must be escaped (preceded by the escape character) to be interpreted
223 as the character itself. Outside strings, the characters
224 .sp
225 .in +2
226 .nf
227 \fB, ; < >\fR \fIescape_char\fR
228 .fi
229 .in -2
230 .sp
232 must be escaped to be interpreted as the character itself.
233 .sp
234 Example:
235 .sp
236 .in +2
237 .nf
238 c "May"
239 .fi
240 .in -2
241 .sp
243 .RE
244 .RS +4
245 .TP
246 3.
247 A character can be represented as an octal constant. An octal constant is
248 specified as the escape character followed by two or more octal digits. Each
249 constant represents a byte value. Multi-byte values can be represented by
250 concatenated constants specified in byte order with the last constant
251 specifying the least significant byte of the character.
252 .sp
253 Example:
254 .sp
255 .in +2
256 .nf
257 \e143;\e347;\e143\e150 "\e115\e141\e171"
258 .fi
259 .in -2
260 .sp
262 .RE
263 .RS +4
264 .TP
265 4.
266 A character can be represented as a hexadecimal constant. A hexadecimal
267 constant is specified as the escape character followed by an \fBx\fR followed
268 by two or more hexadecimal digits. Each constant represents a byte value.
269 Multi-byte values can be represented by concatenated constants specified in
270 byte order with the last constant specifying the least significant byte of the
271 character.
272 .sp
273 Example:
274 .sp
275 .in +2
276 .nf
277 \ex63;\exe7;\ex63\ex68 "\ex4d\ex61\ex79"
278 .fi
279 .in -2
280 .sp
282 .RE
283 .RS +4
284 .TP
285 5.
286 A character can be represented as a decimal constant. A decimal constant is
287 specified as the escape character followed by a \fBd\fR followed by two or more
288 decimal digits. Each constant represents a byte value. Multi-byte values can be
289 represented by concatenated constants specified in byte order with the last
290 constant specifying the least significant byte of the character.
291 .sp
292 Example:
293 .sp
294 .in +2
295 .nf
296 \ed99;\ed231;\ed99\ed104 "\ed77\ed97\ed121"
297 .fi
298 .in -2
299 .sp
301 Only characters existing in the character set for which the locale definition
302 is created can be specified, whether using symbolic names, the characters
303 themselves, or octal, decimal or hexadecimal constants. If a charmap file is
304 present, only characters defined in the charmap can be specified using octal,
305 decimal or hexadecimal constants. Symbolic names not present in the charmap
306 file can be specified and will be ignored, as specified under item 1 above.
307 .RE
308 .SS "LC_CTYPE"
309 .LP
310 The \fBLC_CTYPE\fR category defines character classification, case conversion
311 and other character attributes. In addition, a series of characters can be
312 represented by three adjacent periods representing an ellipsis symbol
313 (\fB\&...\fR). The ellipsis specification is interpreted as meaning that all
314 values between the values preceding and following it represent valid
315 characters. The ellipsis specification is valid only within a single encoded
316 character set, that is, within a group of characters of the same size. An
317 ellipsis is interpreted as including in the list all characters with an encoded
318 value higher than the encoded value of the character preceding the ellipsis and
319 lower than the encoded value of the character following the ellipsis.
320 .sp
321 .LP
322 Example:
323 .sp
324 .in +2
325 .nf
326 \ex30;...;\ex39;
327 .fi
328 .in -2
329 .sp
331 .sp
332 .LP
333 includes in the character class all characters with encoded values between the
334 endpoints.
335 .sp
336 .LP
337 The following keywords are recognized. In the descriptions, the term
338 ``automatically included'' means that it is not an error either to include or
339 omit any of the referenced characters.
340 .sp
341 .LP
342 The character classes \fBdigit\fR, \fBxdigit\fR, \fBlower\fR, \fBupper\fR, and
343 \fBspace\fR have a set of automatically included characters. These only need to
344 be specified if the character values (that is, encoding) differ from the
345 implementation default values.
346 .sp
347 .ne 2
348 .na
349 \fB\fBupper\fR\fR
350 .ad
351 .RS 18n
352 Define characters to be classified as upper-case letters.
353 .sp
354 In the POSIX locale, the 26 upper-case letters are included:
355 .sp
356 .in +2
357 .nf
358 A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
359 .fi
360 .in -2
361 .sp
363 In a locale definition file, no character specified for the keywords
364 \fBcntrl\fR, \fBdigit\fR, \fBpunct\fR, or \fBspace\fR can be specified. The
365 upper-case letters \fBA\fR to \fBZ\fR are automatically included in this class.
366 .RE
368 .sp
369 .ne 2
370 .na
371 \fB\fBlower\fR\fR
372 .ad
373 .RS 18n
374 Define characters to be classified as lower-case letters. In the POSIX locale,
375 the 26 lower-case letters are included:
376 .sp
377 .in +2
378 .nf
379 a b c d e f g h i j k l m n o p q r s t u v w x y z
380 .fi
381 .in -2
382 .sp
384 In a locale definition file, no character specified for the keywords
385 \fBcntrl\fR, \fBdigit\fR, \fBpunct\fR, or \fBspace\fR can be specified. The
386 lower-case letters \fBa\fR to \fBz\fR of the portable character set are
387 automatically included in this class.
388 .RE
390 .sp
391 .ne 2
392 .na
393 \fB\fBalpha\fR\fR
394 .ad
395 .RS 18n
396 Define characters to be classified as letters.
397 .sp
398 In the POSIX locale, all characters in the classes \fBupper\fR and \fBlower\fR
399 are included.
400 .sp
401 In a locale definition file, no character specified for the keywords
402 \fBcntrl\fR, \fBdigit\fR, \fBpunct\fR, or \fBspace\fR can be specified.
403 Characters classified as either \fBupper\fR or \fBlower\fR are automatically
404 included in this class.
405 .RE
407 .sp
408 .ne 2
409 .na
410 \fB\fBdigit\fR\fR
411 .ad
412 .RS 18n
413 Define the characters to be classified as numeric digits.
414 .sp
415 In the POSIX locale, only
416 .sp
417 .in +2
418 .nf
419 0 1 2 3 4 5 6 7 8 9
420 .fi
421 .in -2
422 .sp
424 are included.
425 .sp
426 In a locale definition file, only the digits \fB0\fR, \fB1\fR, \fB2\fR,
427 \fB3\fR, \fB4\fR, \fB5\fR, \fB6\fR, \fB7\fR, \fB8\fR, and \fB9\fR can be
428 specified, and in contiguous ascending sequence by numerical value. The digits
429 \fB0\fR to \fB9\fR of the portable character set are automatically included in
430 this class.
431 .sp
432 The definition of character class \fBdigit\fR requires that only ten
433 characters; the ones defining digits can be specified; alternative digits (for
434 example, Hindi or Kanji) cannot be specified here.
435 .RE
437 .sp
438 .ne 2
439 .na
440 \fB\fBalnum\fR\fR
441 .ad
442 .RS 18n
443 Define characters to be classified as letters and numeric digits. Only the
444 characters specified for the \fBalpha\fR and \fBdigit\fR keywords are
445 specified. Characters specified for the keywords \fBalpha\fR and \fBdigit\fR
446 are automatically included in this class.
447 .RE
449 .sp
450 .ne 2
451 .na
452 \fB\fBspace\fR\fR
453 .ad
454 .RS 18n
455 Define characters to be classified as white-space characters.
456 .sp
457 In the POSIX locale, at a minimum, the characters \fBSPACE\fR, \fBFORMFEED\fR,
458 \fBNEWLINE\fR, \fBCARRIAGE RETURN\fR, \fBTAB\fR, and \fBVERTICAL TAB\fR are
459 included.
460 .sp
461 In a locale definition file, no character specified for the keywords
462 \fBupper\fR, \fBlower\fR, \fBalpha\fR, \fBdigit\fR, \fBgraph\fR, or
463 \fBxdigit\fR can be specified. The characters \fBSPACE\fR, \fBFORMFEED\fR,
464 \fBNEWLINE\fR, \fBCARRIAGE RETURN\fR, \fBTAB\fR, and \fBVERTICAL TAB\fR of the
465 portable character set, and any characters included in the class \fBblank\fR
466 are automatically included in this class.
467 .RE
469 .sp
470 .ne 2
471 .na
472 \fB\fBcntrl\fR\fR
473 .ad
474 .RS 18n
475 Define characters to be classified as control characters.
476 .sp
477 In the POSIX locale, no characters in classes \fBalpha\fR or \fBprint\fR are
478 included.
479 .sp
480 In a locale definition file, no character specified for the keywords
481 \fBupper\fR, \fBlower\fR, \fBalpha\fR, \fBdigit\fR, \fBpunct\fR, \fBgraph\fR,
482 \fBprint\fR, or \fBxdigit\fR can be specified.
483 .RE
485 .sp
486 .ne 2
487 .na
488 \fB\fBpunct\fR\fR
489 .ad
490 .RS 18n
491 Define characters to be classified as punctuation characters.
492 .sp
493 In the POSIX locale, neither the space character nor any characters in classes
494 \fBalpha\fR, \fBdigit\fR, or \fBcntrl\fR are included.
495 .sp
496 In a locale definition file, no character specified for the keywords
497 \fBupper\fR, \fBlower\fR, \fBalpha\fR, \fBdigit\fR, \fBcntrl\fR, \fBxdigit\fR
498 or as the space character can be specified.
499 .RE
501 .sp
502 .ne 2
503 .na
504 \fB\fBgraph\fR\fR
505 .ad
506 .RS 18n
507 Define characters to be classified as printable characters, not including the
508 space character.
509 .sp
510 In the POSIX locale, all characters in classes \fBalpha\fR, \fBdigit\fR, and
511 \fBpunct\fR are included; no characters in class \fBcntrl\fR are included.
512 .sp
513 In a locale definition file, characters specified for the keywords \fBupper\fR,
514 \fBlower\fR, \fBalpha\fR, \fBdigit\fR, \fBxdigit\fR, and \fBpunct\fR are
515 automatically included in this class. No character specified for the keyword
516 \fBcntrl\fR can be specified.
517 .RE
519 .sp
520 .ne 2
521 .na
522 \fB\fBprint\fR\fR
523 .ad
524 .RS 18n
525 Define characters to be classified as printable characters, including the space
526 character.
527 .sp
528 In the POSIX locale, all characters in class \fBgraph\fR are included; no
529 characters in class \fBcntrl\fR are included.
530 .sp
531 In a locale definition file, characters specified for the keywords \fBupper\fR,
532 \fBlower\fR, \fBalpha\fR, \fBdigit\fR, \fBxdigit\fR, \fBpunct\fR, and the space
533 character are automatically included in this class. No character specified for
534 the keyword \fBcntrl\fR can be specified.
535 .RE
537 .sp
538 .ne 2
539 .na
540 \fB\fBxdigit\fR\fR
541 .ad
542 .RS 18n
543 Define the characters to be classified as hexadecimal digits.
544 .sp
545 In the POSIX locale, only:
546 .sp
547 .in +2
548 .nf
549 0 1 2 3 4 5 6 7 8 9 A B C D E F a b c d e f
550 .fi
551 .in -2
552 .sp
554 are included.
555 .sp
556 In a locale definition file, only the characters defined for the class
557 \fBdigit\fR can be specified, in contiguous ascending sequence by numerical
558 value, followed by one or more sets of six characters representing the
559 hexadecimal digits 10 to 15 inclusive, with each set in ascending order (for
560 example \fBA\fR, \fBB\fR, \fBC\fR, \fBD\fR, \fBE\fR, \fBF\fR, \fBa\fR, \fBb\fR,
561 \fBc\fR, \fBd\fR, \fBe\fR, \fBf\fR). The digits \fB0\fR to \fB9\fR, the
562 upper-case letters \fBA\fR to \fBF\fR and the lower-case letters \fBa\fR to
563 \fBf\fR of the portable character set are automatically included in this class.
564 .sp
565 The definition of character class \fBxdigit\fR requires that the characters
566 included in character class \fBdigit\fR be included here also.
567 .RE
569 .sp
570 .ne 2
571 .na
572 \fB\fBblank\fR\fR
573 .ad
574 .RS 18n
575 Define characters to be classified as blank characters.
576 .sp
577 In the POSIX locale, only the space and tab characters are included.
578 .sp
579 In a locale definition file, the characters space and tab are automatically
580 included in this class.
581 .RE
583 .sp
584 .ne 2
585 .na
586 \fB\fBcharclass\fR\fR
587 .ad
588 .RS 18n
589 Define one or more locale-specific character class names as strings separated
590 by semi-colons. Each named character class can then be defined subsequently in
591 the \fBLC_CTYPE\fR definition. A character class name consists of at least one
592 and at most \fB{CHARCLASS_NAME_MAX}\fR bytes of alphanumeric characters from
593 the portable filename character set. The first character of a character class
594 name cannot be a digit. The name cannot match any of the \fBLC_CTYPE\fR
595 keywords defined in this document.
596 .RE
598 .sp
599 .ne 2
600 .na
601 \fB\fBcharclass-name\fR\fR
602 .ad
603 .RS 18n
604 Define characters to be classified as belonging to the named locale-specific
605 character class. In the POSIX locale, the locale-specific named character
606 classes need not exist. If a class name is defined by a \fBcharclass\fR
607 keyword, but no characters are subsequently assigned to it, this is not an
608 error; it represents a class without any characters belonging to it. The
609 \fBcharclass-name\fR can be used as the \fIproperty\fR argument to the
610 \fBwctype\fR(3C) function, in regular expression and shell pattern-matching
611 bracket expressions, and by the \fBtr\fR(1) command.
612 .RE
614 .sp
615 .ne 2
616 .na
617 \fB\fBtoupper\fR\fR
618 .ad
619 .RS 18n
620 Define the mapping of lower-case letters to upper-case letters.
621 .sp
622 In the POSIX locale, at a minimum, the 26 lower-case characters:
623 .sp
624 .in +2
625 .nf
626 a b c d e f g h i j k l m n o p q r s t u v w x y z
627 .fi
628 .in -2
629 .sp
631 are mapped to the corresponding 26 upper-case characters:
632 .sp
633 .in +2
634 .nf
635 A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
636 .fi
637 .in -2
638 .sp
640 In a locale definition file, the operand consists of character pairs, separated
641 by semicolons. The characters in each character pair are separated by a comma
642 and the pair enclosed by parentheses. The first character in each pair is the
643 lower-case letter, the second the corresponding upper-case letter. Only
644 characters specified for the keywords \fBlower\fR and \fBupper\fR can be
645 specified. The lower-case letters \fBa\fR to \fBz\fR, and their corresponding
646 upper-case letters \fBA\fR to \fBZ\fR, of the portable character set are
647 automatically included in this mapping, but only when the \fBtoupper\fR keyword
648 is omitted from the locale definition.
649 .RE
651 .sp
652 .ne 2
653 .na
654 \fB\fBtolower\fR\fR
655 .ad
656 .RS 18n
657 Define the mapping of upper-case letters to lower-case letters.
658 .sp
659 In the POSIX locale, at a minimum, the 26 upper-case characters:
660 .sp
661 .in +2
662 .nf
663 A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
664 .fi
665 .in -2
666 .sp
668 are mapped to the corresponding 26 lower-case characters:
669 .sp
670 .in +2
671 .nf
672 a b c d e f g h i j k l m n o p q r s t u v w x y z
673 .fi
674 .in -2
675 .sp
677 In a locale definition file, the operand consists of character pairs, separated
678 by semicolons. The characters in each character pair are separated by a comma
679 and the pair enclosed by parentheses. The first character in each pair is the
680 upper-case letter, the second the corresponding lower-case letter. Only
681 characters specified for the keywords \fBlower\fR and \fBupper\fR can be
682 specified. If the \fBtolower\fR keyword is omitted from the locale definition,
683 the mapping will be the reverse mapping of the one specified for \fBtoupper\fR.
684 .RE
686 .SS "LC_COLLATE"
687 .LP
688 The \fBLC_COLLATE\fR category provides a collation sequence definition for
689 numerous utilities (such as \fBsort\fR(1), \fBuniq\fR(1), and so forth),
690 regular expression matching (see \fBregex\fR(5)), and the \fBstrcoll\fR(3C),
691 \fBstrxfrm\fR(3C), \fBwcscoll\fR(3C), and \fBwcsxfrm\fR(3C) functions.
692 .sp
693 .LP
694 A collation sequence definition defines the relative order between collating
695 elements (characters and multi-character collating elements) in the locale.
696 This order is expressed in terms of collation values, that is, by assigning
697 each element one or more collation values (also known as collation weights).
698 The following capabilities are provided:
699 .RS +4
700 .TP
701 1.
702 \fBMulti-character collating elements\fR. Specification of multi-character
703 collating elements (that is, sequences of two or more characters to be collated
704 as an entity).
705 .RE
706 .RS +4
707 .TP
708 2.
709 \fBUser-defined ordering of collating elements\fR. Each collating element is
710 assigned a collation value defining its order in the character (or basic)
711 collation sequence. This ordering is used by regular expressions and pattern
712 matching and, unless collation weights are explicity specified, also as the
713 collation weight to be used in sorting.
714 .RE
715 .RS +4
716 .TP
717 3.
718 \fBMultiple weights and equivalence classes\fR. Collating elements can be
719 assigned one or more (up to the limit \fB{COLL_WEIGHTS_MAX}\fR \fB)\fR
720 collating weights for use in sorting. The first weight is hereafter referred to
721 as the primary weight.
722 .RE
723 .RS +4
724 .TP
725 4.
726 \fBOne-to-Many mapping\fR. A single character is mapped into a string of
727 collating elements.
728 .RE
729 .RS +4
730 .TP
731 5.
732 \fBEquivalence class definition\fR. Two or more collating elements have the
733 same collation value (primary weight).
734 .RE
735 .RS +4
736 .TP
737 6.
738 \fBOrdering by weights\fR. When two strings are compared to determine their
739 relative order, the two strings are first broken up into a series of collating
740 elements. The elements in each successive pair of elements are then compared
741 according to the relative primary weights for the elements. If equal, and more
742 than one weight has been assigned, the pairs of collating elements are
743 recompared according to the relative subsequent weights, until either a pair of
744 collating elements compare unequal or the weights are exhausted.
745 .RE
746 .sp
747 .LP
748 The following keywords are recognized in a collation sequence definition. They
749 are described in detail in the following sections.
750 .sp
751 .ne 2
752 .na
753 \fB\fBcopy\fR\fR
754 .ad
755 .RS 21n
756 Specify the name of an existing locale which is used as the definition of this
757 category. If this keyword is specified, no other keyword is specified.
758 .RE
760 .sp
761 .ne 2
762 .na
763 \fB\fBcollating-element\fR\fR
764 .ad
765 .RS 21n
766 Define a collating-element symbol representing a multi-character collating
767 element. This keyword is optional.
768 .RE
770 .sp
771 .ne 2
772 .na
773 \fB\fBcollating-symbol\fR\fR
774 .ad
775 .RS 21n
776 Define a collating symbol for use in collation order statements. This keyword
777 is optional.
778 .RE
780 .sp
781 .ne 2
782 .na
783 \fB\fBorder_start\fR\fR
784 .ad
785 .RS 21n
786 Define collation rules. This statement is followed by one or more collation
787 order statements, assigning character collation values and collation weights to
788 collating elements.
789 .RE
791 .sp
792 .ne 2
793 .na
794 \fB\fBorder_end\fR\fR
795 .ad
796 .RS 21n
797 Specify the end of the collation-order statements.
798 .RE
800 .SS "collating-element \fIkeyword\fR"
801 .LP
802 In addition to the collating elements in the character set, the
803 \fBcollating-element\fR keyword is used to define multi-character collating
804 elements. The syntax is:
805 .sp
806 .in +2
807 .nf
808 \fB"collating-element %s from \e"%s\e"\en",\fR<\fIcollating-symbol\fR>,<\fIstring\fR>
809 .fi
810 .in -2
812 .sp
813 .LP
814 The <\fIcollating-symbol\fR> operand is a symbolic name, enclosed between angle
815 brackets (\fB<\fR and \fB>\fR), and must not duplicate any symbolic name in the
816 current charmap file (if any), or any other symbolic name defined in this
817 collation definition. The string operand is a string of two or more characters
818 that collates as an entity. A <\fIcollating-element\fR> defined via this
819 keyword is only recognized with the \fBLC_COLLATE\fR category.
820 .sp
821 .LP
822 Example:
823 .br
824 .in +2
825 \fBcollating-element\fR <\fBch\fR> from "<\fBc\fR><\fBh\fR>"
826 .in -2
827 .br
828 .in +2
829 \fBcollating-element\fR <\fBe-acute\fR> from "<\fBacute\fR><\fBe\fR>"
830 .in -2
831 .br
832 .in +2
833 \fBcollating-element\fR <\fBll\fR> from "\fBll\fR"
834 .in -2
835 .SS "collating-symbol \fIkeyword\fR"
836 .LP
837 This keyword will be used to define symbols for use in collation sequence
838 statements; that is, between the \fBorder_start\fR and the \fBorder_end\fR
839 keywords. The syntax is:
840 .sp
841 .in +2
842 .nf
843 \fB"collating-symbol %s\en",\fR<\fIcollating-symbol\fR>
844 .fi
845 .in -2
847 .sp
848 .LP
849 The \fB<\fR\fIcollating-symbol\fR\fB>\fR is a symbolic name, enclosed between
850 angle brackets (\fB<\fR and \fB>\fR), and must not duplicate any symbolic name
851 in the current charmap file (if any), or any other symbolic name defined in
852 this collation definition.
853 .sp
854 .LP
855 A \fBcollating-symbol\fR defined via this keyword is only recognized with the
856 \fBLC_COLLATE\fR category.
857 .sp
858 .LP
859 Example:
860 .br
861 .in +2
862 \fBcollating-symbol\fR <\fBUPPER_CASE\fR>
863 .in -2
864 .br
865 .in +2
866 \fBcollating-symbol\fR <\fBHIGH\fR>
867 .in -2
868 .sp
869 .LP
870 The \fBcollating-symbol\fR keyword defines a symbolic name that can be
871 associated with a relative position in the character order sequence. While such
872 a symbolic name does not represent any collating element, it can be used as a
873 weight.
874 .SS "order_start \fIkeyword\fR"
875 .LP
876 The \fBorder_start\fR keyword must precede collation order entries and also
877 defines the number of weights for this collation sequence definition and other
878 collation rules.
879 .sp
880 .LP
881 The syntax of the \fBorder_start\fR keyword is:
882 .sp
883 .in +2
884 .nf
885 \fB"order_start %s;%s;...;%s\en",\fR<\fIsort-rules\fR>,<\fIsort-rules\fR>
886 .fi
887 .in -2
889 .sp
890 .LP
891 The operands to the \fBorder_start\fR keyword are optional. If present, the
892 operands define rules to be applied when strings are compared. The number of
893 operands define how many weights each element is assigned. If no operands are
894 present, one \fBforward\fR operand is assumed. If present, the first operand
895 defines rules to be applied when comparing strings using the first (primary)
896 weight; the second when comparing strings using the second weight, and so on.
897 Operands are separated by semicolons (\fB;\fR). Each operand consists of one or
898 more collation directives, separated by commas (\fB,\fR). If the number of
899 operands exceeds the \fB{COLL_WEIGHTS_MAX}\fR limit, the utility will issue a
900 warning message. The following directives will be supported:
901 .sp
902 .ne 2
903 .na
904 \fB\fBforward\fR\fR
905 .ad
906 .RS 12n
907 Specifies that comparison operations for the weight level proceed from start of
908 string towards the end of string.
909 .RE
911 .sp
912 .ne 2
913 .na
914 \fB\fBbackward\fR\fR
915 .ad
916 .RS 12n
917 Specifies that comparison operations for the weight level proceed from end of
918 string towards the beginning of string.
919 .RE
921 .sp
922 .ne 2
923 .na
924 \fB\fBposition\fR\fR
925 .ad
926 .RS 12n
927 Specifies that comparison operations for the weight level will consider the
928 relative position of elements in the strings not subject to \fBIGNORE.\fR The
929 string containing an element not subject to \fBIGNORE\fR after the fewest
930 collating elements subject to \fBIGNORE\fR from the start of the compare will
931 collate first. If both strings contain a character not subject to \fBIGNORE\fR
932 in the same relative position, the collating values assigned to the elements
933 will determine the ordering. In case of equality, subsequent characters not
934 subject to \fBIGNORE\fR are considered in the same manner.
935 .RE
937 .sp
938 .LP
939 The directives \fBforward\fR and \fBbackward\fR are mutually exclusive.
940 .sp
941 .LP
942 Example:
943 .sp
944 .in +2
945 .nf
946 order_start forward;backward
947 .fi
948 .in -2
949 .sp
951 .sp
952 .LP
953 If no operands are specified, a single \fBforward\fR operand is assumed.
954 .SS "Collation Order"
955 .LP
956 The \fBorder_start\fR keyword is followed by collating identifier entries. The
957 syntax for the collating element entries is:
958 .sp
959 .in +2
960 .nf
961 \fB"%s %s;%s;...;%s\en"\fR<\fIcollating-identifier\fR>,<\fIweight\fR>,<\fIweight\fR>\fB,...\fR
962 .fi
963 .in -2
965 .sp
966 .LP
967 Each \fIcollating-identifier\fR consists of either a character described in
968 \fBLocale Definition\fR above, a <\fIcollating-element\fR>, a
969 <\fIcollating-symbol\fR>, an ellipsis, or the special symbol \fBUNDEFINED\fR.
970 The order in which collating elements are specified determines the character
971 order sequence, such that each collating element compares less than the
972 elements following it. The \fBNUL\fR character compares lower than any other
973 character.
974 .sp
975 .LP
976 A <\fIcollating-element\fR> is used to specify multi-character collating
977 elements, and indicates that the character sequence specified via the
978 <\fIcollating-element\fR> is to be collated as a unit and in the relative order
979 specified by its place.
980 .sp
981 .LP
982 A <\fIcollating-symbol\fR> is used to define a position in the relative order
983 for use in weights. No weights are specified with a <\fIcollating-symbol\fR>.
984 .sp
985 .LP
986 The ellipsis symbol specifies that a sequence of characters will collate
987 according to their encoded character values. It is interpreted as indicating
988 that all characters with a coded character set value higher than the value of
989 the character in the preceding line, and lower than the coded character set
990 value for the character in the following line, in the current coded character
991 set, will be placed in the character collation order between the previous and
992 the following character in ascending order according to their coded character
993 set values. An initial ellipsis is interpreted as if the preceding line
994 specified the NUL character, and a trailing ellipsis as if the following line
995 specified the highest coded character set value in the current coded character
996 set. An ellipsis is treated as invalid if the preceding or following lines do
997 not specify characters in the current coded character set. The use of the
998 ellipsis symbol ties the definition to a specific coded character set and may
999 preclude the definition from being portable between implementations.
1000 .sp
1001 .LP
1002 The symbol \fBUNDEFINED\fR is interpreted as including all coded character set
1003 values not specified explicitly or via the ellipsis symbol. Such characters are
1004 inserted in the character collation order at the point indicated by the symbol,
1005 and in ascending order according to their coded character set values. If no
1006 \fBUNDEFINED\fR symbol is specified, and the current coded character set
1007 contains characters not specified in this section, the utility will issue a
1008 warning message and place such characters at the end of the character collation
1009 order.
1010 .sp
1011 .LP
1012 The optional operands for each collation-element are used to define the
1013 primary, secondary, or subsequent weights for the collating element. The first
1014 operand specifies the relative primary weight, the second the relative
1015 secondary weight, and so on. Two or more collation-elements can be assigned the
1016 same weight; they belong to the same \fIequivalence class\fR if they have the
1017 same primary weight. Collation behaves as if, for each weight level, elements
1018 subject to \fBIGNORE\fR are removed, unless the \fBposition\fR collation
1019 directive is specified for the corresponding level with the \fBorder_start\fR
1020 keyword. Then each successive pair of elements is compared according to the
1021 relative weights for the elements. If the two strings compare equal, the
1022 process is repeated for the next weight level, up to the limit
1023 {\fBCOLL_WEIGHTS_MAX\fR}.
1024 .sp
1025 .LP
1026 Weights are expressed as characters described in \fBLocale Definition\fR
1027 above, <\fIcollating-symbol\fR>s, <\fIcollating-element\fR>s, an ellipsis, or
1028 the special symbol \fBIGNORE.\fR A single character, a <\fIcollating-symbol\fR>
1029 or a <\fIcollating-element\fR> represent the relative position in the character
1030 collating sequence of the character or symbol, rather than the character or
1031 characters themselves. Thus, rather than assigning absolute values to weights,
1032 a particular weight is expressed using the relative order value assigned to a
1033 collating element based on its order in the character collation sequence.
1034 .sp
1035 .LP
1036 One-to-many mapping is indicated by specifying two or more concatenated
1037 characters or symbolic names. For example, if the character <\fBeszet\fR> is
1038 given the string "<\fBs\fR><\fBs\fR>" as a weight, comparisons are performed as
1039 if all occurrences of the character <\fBeszet\fR> are replaced by
1040 <\fBs\fR><\fBs\fR> (assuming that <\fBs\fR> has the collating weight
1041 <\fBs\fR>). If it is necessary to define <\fBeszet\fR> and <\fBs\fR><\fBs\fR>
1042 as an equivalence class, then a collating element must be defined for the
1043 string \fBss\fR.
1044 .sp
1045 .LP
1046 All characters specified via an ellipsis will by default be assigned unique
1047 weights, equal to the relative order of characters. Characters specified via an
1048 explicit or implicit \fBUNDEFINED\fR special symbol will by default be assigned
1049 the same primary weight (that is, belong to the same equivalence class). An
1050 ellipsis symbol as a weight is interpreted to mean that each character in the
1051 sequence has unique weights, equal to the relative order of their character in
1052 the character collation sequence. The use of the ellipsis as a weight is
1053 treated as an error if the collating element is neither an ellipsis nor the
1054 special symbol \fBUNDEFINED\fR.
1055 .sp
1056 .LP
1057 The special keyword \fBIGNORE\fR as a weight indicates that when strings are
1058 compared using the weights at the level where \fBIGNORE\fR is specified, the
1059 collating element is ignored; that is, as if the string did not contain the
1060 collating element. In regular expressions and pattern matching, all characters
1061 that are subject to \fBIGNORE\fR in their primary weight form an equivalence
1062 class.
1063 .sp
1064 .LP
1065 An empty operand is interpreted as the collating element itself.
1066 .sp
1067 .LP
1068 For example, the order statement:
1069 .sp
1070 .in +2
1071 .nf
1072 <a> <a>;<a>
1073 .fi
1074 .in -2
1075 .sp
1077 .sp
1078 .LP
1079 is equal to:
1080 .sp
1081 .in +2
1082 .nf
1083 <a>
1084 .fi
1085 .in -2
1086 .sp
1088 .sp
1089 .LP
1090 An ellipsis can be used as an operand if the collating element was an ellipsis,
1091 and is interpreted as the value of each character defined by the ellipsis.
1092 .sp
1093 .LP
1094 The collation order as defined in this section defines the interpretation of
1095 bracket expressions in regular expressions.
1096 .sp
1097 .LP
1098 Example:
1099 .sp
1101 .sp
1102 .TS
1103 l l
1104 l l .
1105 \fBorder_start\fR \fBforward;backward\fR
1106 \fBUNDEFINED\fR \fBIGNORE;IGNORE\fR
1107 \fB<LOW>\fR
1108 \fB<space>\fR \fB<LOW>;<space>\fR
1109 \fB\&.\|.\|.\fR \fB<LOW>;.\|.\|.\fR
1110 \fB<a>\fR \fB<a>;<a>\fR
1111 \fB<a-acute>\fR \fB<a>;<a-acute>\fR
1112 \fB<a-grave>\fR \fB<a>;<a-grave>\fR
1113 \fB<A>\fR \fB<a>;<A>\fR
1114 \fB<A-acute>\fR \fB<a>;<A-acute>\fR
1115 \fB<A-grave>\fR \fB<a>;<A-grave>\fR
1116 \fB<ch>\fR \fB<ch>;<ch>\fR
1117 \fB<Ch>\fR \fB<ch>;<Ch>\fR
1118 \fB<s>\fR \fB<s>;<s>\fR
1119 \fB<eszet>\fR \fB"<s><s>";"<eszet><eszet>"\fR
1120 \fBorder_end\fR
1121 .TE
1123 .sp
1124 .LP
1125 This example is interpreted as follows:
1126 .RS +4
1127 .TP
1128 1.
1129 The \fBUNDEFINED\fR means that all characters not specified in this
1130 definition (explicitly or via the ellipsis) are ignored for collation purposes;
1131 for regular expression purposes they are ordered first.
1132 .RE
1133 .RS +4
1134 .TP
1135 2.
1136 All characters between <\fBspace\fR> and <\fBa\fR> have the same primary
1137 equivalence class and individual secondary weights based on their ordinal
1138 encoded values.
1139 .RE
1140 .RS +4
1141 .TP
1142 3.
1143 All characters based on the upper- or lower-case character \fBa\fR belong to
1144 the same primary equivalence class.
1145 .RE
1146 .RS +4
1147 .TP
1148 4.
1149 The multi-character collating element <\fBch\fR> is represented by the
1150 collating symbol <\fBch\fR> and belongs to the same primary equivalence class
1151 as the multi-character collating element <\fBCh\fR>.
1152 .RE
1153 .SS "order_end \fIkeyword\fR"
1154 .LP
1155 The collating order entries must be terminated with an \fBorder_end\fR keyword.
1156 .SS "LC_MONETARY"
1157 .LP
1158 The \fBLC_MONETARY\fR category defines the rules and symbols that are used to
1159 format monetary numeric information. This information is available through the
1160 \fBlocaleconv\fR(3C) function
1161 .sp
1162 .LP
1163 The following items are defined in this category of the locale. The item names
1164 are the keywords recognized by the \fBlocaledef\fR(1) utility when defining a
1165 locale. They are also similar to the member names of the \fBlconv\fR structure
1166 defined in <\fBlocale.h\fR>. The \fBlocaleconv\fR function returns
1167 \fB{CHAR_MAX}\fR for unspecified integer items and the empty string (\fB""\fR)
1168 for unspecified or size zero string items.
1169 .sp
1170 .LP
1171 In a locale definition file the operands are strings. For some keywords, the
1172 strings can contain only integers. Keywords that are not provided, string
1173 values set to the empty string (\fB""\fR), or integer keywords set to \fB-1\fR,
1174 are used to indicate that the value is not available in the locale.
1175 .sp
1176 .ne 2
1177 .na
1178 \fB\fBint_curr_symbol\fR\fR
1179 .ad
1180 .RS 22n
1181 The international currency symbol. The operand is a four-character string, with
1182 the first three characters containing the alphabetic international currency
1183 symbol in accordance with those specified in the ISO 4217 standard. The fourth
1184 character is the character used to separate the international currency symbol
1185 from the monetary quantity.
1186 .RE
1188 .sp
1189 .ne 2
1190 .na
1191 \fB\fBcurrency_symbol\fR\fR
1192 .ad
1193 .RS 22n
1194 The string used as the local currency symbol.
1195 .RE
1197 .sp
1198 .ne 2
1199 .na
1200 \fB\fBmon_decimal_point\fR\fR
1201 .ad
1202 .RS 22n
1203 The operand is a string containing the symbol that is used as the decimal
1204 delimiter (radix character) in monetary formatted quantities.
1205 .RE
1207 .sp
1208 .ne 2
1209 .na
1210 \fB\fBmon_thousands_sep\fR\fR
1211 .ad
1212 .RS 22n
1213 The operand is a string containing the symbol that is used as a separator for
1214 groups of digits to the left of the decimal delimiter in formatted monetary
1215 quantities.
1216 .RE
1218 .sp
1219 .ne 2
1220 .na
1221 \fB\fBmon_grouping\fR\fR
1222 .ad
1223 .RS 22n
1224 Define the size of each group of digits in formatted monetary quantities. The
1225 operand is a sequence of integers separated by semicolons. Each integer
1226 specifies the number of digits in each group, with the initial integer defining
1227 the size of the group immediately preceding the decimal delimiter, and the
1228 following integers defining the preceding groups. If the last integer is not
1229 \fB-1\fR, then the size of the previous group (if any) will be repeatedly used
1230 for the remainder of the digits. If the last integer is \fB-1\fR, then no
1231 further grouping will be performed.
1232 .sp
1233 The following is an example of the interpretation of the \fBmon_grouping\fR
1234 keyword. Assuming that the value to be formatted is \fB123456789\fR and the
1235 \fBmon_thousands_sep\fR is \fB\&'\fR, then the following table shows the
1236 result. The third column shows the equivalent string in the ISO C standard that
1237 would be used by the \fBlocaleconv\fR function to accommodate this grouping.
1238 .sp
1239 .in +2
1240 .nf
1241 mon_grouping Formatted Value ISO C String
1243 3;-1 123456'789 "\e3\e177"
1244 3 123'456'789 "\e3"
1245 3;2;-1 1234'56'789 "\e3\e2\e177"
1246 3;2 12'34'56'789 "\e3\e2"
1247 -1 1234567898 "\e177"
1248 .fi
1249 .in -2
1250 .sp
1252 In these examples, the octal value of \fB{CHAR_MAX}\fR is 177.
1253 .RE
1255 .sp
1256 .ne 2
1257 .na
1258 \fB\fBpositive_sign\fR\fR
1259 .ad
1260 .RS 22n
1261 A string used to indicate a non-negative-valued formatted monetary quantity.
1262 .RE
1264 .sp
1265 .ne 2
1266 .na
1267 \fB\fBnegative_sign\fR\fR
1268 .ad
1269 .RS 22n
1270 A string used to indicate a negative-valued formatted monetary quantity.
1271 .RE
1273 .sp
1274 .ne 2
1275 .na
1276 \fB\fBint_frac_digits\fR\fR
1277 .ad
1278 .RS 22n
1279 An integer representing the number of fractional digits (those to the right of
1280 the decimal delimiter) to be written in a formatted monetary quantity using
1281 \fBint_curr_symbol\fR.
1282 .RE
1284 .sp
1285 .ne 2
1286 .na
1287 \fB\fBfrac_digits\fR\fR
1288 .ad
1289 .RS 22n
1290 An integer representing the number of fractional digits (those to the right of
1291 the decimal delimiter) to be written in a formatted monetary quantity using
1292 \fBcurrency_symbol\fR.
1293 .RE
1295 .sp
1296 .ne 2
1297 .na
1298 \fB\fBp_cs_precedes\fR\fR
1299 .ad
1300 .RS 22n
1301 In an application conforming to the SUSv3 standard, an integer set to \fB1\fR
1302 if the \fBcurrency_symbol\fR precedes the value for a monetary quantity with a
1303 non-negative value, and set to \fB0\fR if the symbol succeeds the value.
1304 .sp
1305 In an application \fBnot\fR conforming to the SUSv3 standard, an integer set to
1306 \fB1\fR if the \fBcurrency_symbol\fR or \fBint_currency_symbol\fR precedes the
1307 value for a monetary quantity with a non-negative value, and set to \fB0\fR if
1308 the symbol succeeds the value.
1309 .RE
1311 .sp
1312 .ne 2
1313 .na
1314 \fB\fBp_sep_by_space\fR\fR
1315 .ad
1316 .RS 22n
1317 In an application conforming to the SUSv3 standard, an integer set to \fB0\fR
1318 if no space separates the \fBcurrency_symbol\fR from the value for a monetary
1319 quantity with a non-negative value, set to \fB1\fR if a space separates the
1320 symbol from the value, and set to \fB2\fR if a space separates the symbol and
1321 the sign string, if adjacent.
1322 .sp
1323 In an application \fBnot\fR conforming to the SUSv3 standard, an integer set to
1324 \fB0\fR if no space separates the \fBcurrency_symbol\fR or
1325 \fBint_curr_symbol\fR from the value for a monetary quantity with a
1326 non-negative value, set to \fB1\fR if a space separates the symbol from the
1327 value, and set to \fB2\fR if a space separates the symbol and the sign string,
1328 if adjacent.
1329 .RE
1331 .sp
1332 .ne 2
1333 .na
1334 \fB\fBn_cs_precedes\fR\fR
1335 .ad
1336 .RS 22n
1337 In an application conforming to the SUSv3 standard, an integer set to \fB1\fR
1338 if the \fBcurrency_symbol\fR precedes the value for a monetary quantity with a
1339 negative value, and set to \fB0\fR if the symbol succeeds the value.
1340 .sp
1341 In an application \fBnot\fR conforming to the SUSv3 standard, an integer set to
1342 \fB1\fR if the \fBcurrency_symbol\fR or \fBint_currency_symbol\fR precedes the
1343 value for a monetary quantity with a negative value, and set to \fB0\fR if the
1344 symbol succeeds the value.
1345 .RE
1347 .sp
1348 .ne 2
1349 .na
1350 \fB\fBn_sep_by_space\fR\fR
1351 .ad
1352 .RS 22n
1353 In an application conforming to the SUSv3 standard, an integer set to \fB0\fR
1354 if no space separates the \fBcurrency_symbol\fR from the value for a monetary
1355 quantity with a negative value, set to \fB1\fR if a space separates the symbol
1356 from the value, and set to \fB2\fR if a space separates the symbol and the sign
1357 string, if adjacent.
1358 .sp
1359 In an application \fBnot\fR conforming to the SUSv3 standard, an integer set to
1360 \fB0\fR if no space separates the \fBcurrency_symbol\fR or
1361 \fBint_curr_symbol\fR from the value for a monetary quantity with a negative
1362 value, set to \fB1\fR if a space separates the symbol from the value, and set
1363 to \fB2\fR if a space separates the symbol and the sign string, if adjacent.
1364 .RE
1366 .sp
1367 .ne 2
1368 .na
1369 \fB\fBp_sign_posn\fR\fR
1370 .ad
1371 .RS 22n
1372 An integer set to a value indicating the positioning of the \fBpositive_sign\fR
1373 for a monetary quantity with a non-negative value. The following integer values
1374 are recognized for both \fBp_sign_posn\fR and \fBn_sign_posn\fR:
1375 .sp
1376 In an application conforming to the SUSv3 standard:
1377 .sp
1378 .ne 2
1379 .na
1380 \fB\fB0\fR\fR
1381 .ad
1382 .RS 5n
1383 Parentheses enclose the quantity and the \fBcurrency_symbol\fR.
1384 .RE
1386 .sp
1387 .ne 2
1388 .na
1389 \fB\fB1\fR\fR
1390 .ad
1391 .RS 5n
1392 The sign string precedes the quantity and the \fBcurrency_symbol\fR.
1393 .RE
1395 .sp
1396 .ne 2
1397 .na
1398 \fB\fB2\fR\fR
1399 .ad
1400 .RS 5n
1401 The sign string succeeds the quantity and the \fBcurrency_symbol\fR.
1402 .RE
1404 .sp
1405 .ne 2
1406 .na
1407 \fB\fB3\fR\fR
1408 .ad
1409 .RS 5n
1410 The sign string precedes the \fBcurrency_symbol\fR.
1411 .RE
1413 .sp
1414 .ne 2
1415 .na
1416 \fB\fB4\fR\fR
1417 .ad
1418 .RS 5n
1419 The sign string succeeds the \fBcurrency_symbol\fR.
1420 .RE
1422 In an application \fBnot\fR conforming to the SUSv3 standard:
1423 .sp
1424 .ne 2
1425 .na
1426 \fB\fB0\fR\fR
1427 .ad
1428 .RS 5n
1429 Parentheses enclose the quantity and the \fBcurrency_symbol\fR or
1430 \fBint_curr_symbol\fR.
1431 .RE
1433 .sp
1434 .ne 2
1435 .na
1436 \fB\fB1\fR\fR
1437 .ad
1438 .RS 5n
1439 The sign string precedes the quantity and the \fBcurrency_symbol\fR or
1440 \fBint_curr_symbol\fR.
1441 .RE
1443 .sp
1444 .ne 2
1445 .na
1446 \fB\fB2\fR\fR
1447 .ad
1448 .RS 5n
1449 The sign string succeeds the quantity and the \fBcurrency_symbol\fR or
1450 \fBint_curr_symbol\fR.
1451 .RE
1453 .sp
1454 .ne 2
1455 .na
1456 \fB\fB3\fR\fR
1457 .ad
1458 .RS 5n
1459 The sign string precedes the \fBcurrency_symbol\fR or \fBint_curr_symbol\fR.
1460 .RE
1462 .sp
1463 .ne 2
1464 .na
1465 \fB\fB4\fR\fR
1466 .ad
1467 .RS 5n
1468 The sign string succeeds the \fBcurrency_symbol\fR or \fBint_curr_symbol\fR.
1469 .RE
1471 .RE
1473 .sp
1474 .ne 2
1475 .na
1476 \fB\fBn_sign_posn\fR\fR
1477 .ad
1478 .RS 22n
1479 An integer set to a value indicating the positioning of the \fBnegative_sign\fR
1480 for a negative formatted monetary quantity.
1481 .RE
1483 .sp
1484 .ne 2
1485 .na
1486 \fB\fBint_p_cs_precedes\fR\fR
1487 .ad
1488 .RS 22n
1489 An integer set to \fB1\fR if the \fBint_curr_symbol\fR precedes the value for a
1490 monetary quantity with a non-negative value, and set to \fB0\fR if the symbol
1491 succeeds the value.
1492 .RE
1494 .sp
1495 .ne 2
1496 .na
1497 \fB\fBint_n_cs_precedes\fR\fR
1498 .ad
1499 .RS 22n
1500 An integer set to \fB1\fR if the \fBint_curr_symbol\fR precedes the value for a
1501 monetary quantity with a negative value, and set to \fB0\fR if the symbol
1502 succeeds the value.
1503 .RE
1505 .sp
1506 .ne 2
1507 .na
1508 \fB\fBint_p_sep_by_space\fR\fR
1509 .ad
1510 .RS 22n
1511 An integer set to \fB0\fR if no space separates the \fBint_curr_symbol\fR from
1512 the value for a monetary quantity with a non-negative value, set to \fB1\fR if
1513 a space separates the symbol from the value, and set to \fB2\fR if a space
1514 separates the symbol and the sign string, if adjacent.
1515 .RE
1517 .sp
1518 .ne 2
1519 .na
1520 \fB\fBint_n_sep_by_space\fR\fR
1521 .ad
1522 .RS 22n
1523 An integer set to \fB0\fR if no space separates the \fBint_curr_symbol\fR from
1524 the value for a monetary quantity with a negative value, set to \fB1\fR if a
1525 space separates the symbol from the value, and set to \fB2\fR if a space
1526 separates the symbol and the sign string, if adjacent.
1527 .RE
1529 .sp
1530 .ne 2
1531 .na
1532 \fB\fBint_p_sign_posn\fR\fR
1533 .ad
1534 .RS 22n
1535 An integer set to a value indicating the positioning of the \fBpositive_sign\fR
1536 for a positive monetary quantity formatted with the international format. The
1537 following integer values are recognized for \fBint_p_sign_posn\fR and
1538 \fBint_n_sign_posn\fR:
1539 .sp
1540 .ne 2
1541 .na
1542 \fB\fB0\fR\fR
1543 .ad
1544 .RS 5n
1545 Parentheses enclose the quantity and the \fB\fR\fBint_curr_symbol\fR.
1546 .RE
1548 .sp
1549 .ne 2
1550 .na
1551 \fB\fB1\fR\fR
1552 .ad
1553 .RS 5n
1554 The sign string precedes the quantity and the \fBint_curr_symbol\fR.
1555 .RE
1557 .sp
1558 .ne 2
1559 .na
1560 \fB\fB2\fR\fR
1561 .ad
1562 .RS 5n
1563 The sign string precedes the quantity and the \fBint_curr_symbol\fR.
1564 .RE
1566 .sp
1567 .ne 2
1568 .na
1569 \fB\fB3\fR\fR
1570 .ad
1571 .RS 5n
1572 The sign string precedes the \fBint_curr_symbol\fR.
1573 .RE
1575 .sp
1576 .ne 2
1577 .na
1578 \fB\fB4\fR\fR
1579 .ad
1580 .RS 5n
1581 The sign string succeeds the \fBint_curr_symbol\fR.
1582 .RE
1584 .RE
1586 .sp
1587 .ne 2
1588 .na
1589 \fB\fBint_n_sign_posn\fR\fR
1590 .ad
1591 .RS 22n
1592 An integer set to a value indicating the positioning of the \fBnegative_sign\fR
1593 for a negative monetary quantity formatted with the international format.
1594 .RE
1596 .sp
1597 .LP
1598 The following table shows the result of various combinations:
1599 .sp
1601 .sp
1602 .TS
1603 l l l l l l
1604 l l l l l l .
1605 \fBp_sep_by_space\fR
1606 2 1 0
1607 \fBp_cs_precedes\fR= 1 \fBp_sign_posn\fR= 0 \fB($1.25)\fR \fB($1.25)\fR \fB($1.25)\fR
1608 \fBp_sign_posn\fR= 1 \fB+$1.25\fR \fB+$1.25\fR \fB+$1.25\fR
1609 \fBp_sign_posn\fR= 2 \fB$1.25+\fR \fB$1.25+\fR \fB$1.25+\fR
1610 \fBp_sign_posn\fR= 3 \fB+$1.25\fR \fB+$1.25\fR \fB+$1.25\fR
1611 \fBp_sign_posn\fR= 4 \fB$+1.25\fR \fB$+1.25\fR \fB$+1.25\fR
1612 \fBp_cs_precedes\fR= 0 \fBp_sign_posn\fR= 0 \fB(1.25 $)\fR \fB(1.25 $)\fR \fB(1.25$)\fR
1613 \fBp_sign_posn\fR= 1 \fB+1.25 $\fR \fB+1.25 $\fR \fB+1.25$\fR
1614 \fBp_sign_posn\fR= 2 \fB1.25$ +\fR \fB1.25 $+\fR \fB1.25$+\fR
1615 \fBp_sign_posn\fR= 3 \fB1.25+ $\fR \fB1.25 +$\fR \fB1.25+$\fR
1616 \fBp_sign_posn\fR= 4 \fB1.25$ +\fR \fB1.25 $+\fR \fB1.25$+\fR
1617 .TE
1619 .sp
1620 .LP
1621 The monetary formatting definitions for the POSIX locale follow. The code
1622 listing depicts the \fBlocaledef\fR(1) input, the table representing the same
1623 information with the addition of \fBlocaleconv\fR(3C) and \fBnl_langinfo\fR(3C)
1624 formats. All values are unspecified in the POSIX locale.
1625 .sp
1626 .in +2
1627 .nf
1628 LC_MONETARY
1629 # This is the POSIX locale definition for
1630 # the LC_MONETARY category.
1631 #
1632 int_curr_symbol ""
1633 currency_symbol ""
1634 mon_decimal_point ""
1635 mon_thousands_sep ""
1636 mon_grouping -1
1637 positive_sign ""
1638 negative_sign ""
1639 int_frac_digits -1
1640 frac_digits -1
1641 p_cs_precedes -1
1642 p_sep_by_space -1
1643 n_cs_precedes -1
1644 n_sep_by_space -1
1645 p_sign_posn -1
1646 n_sign_posn -1
1647 int_p_cs_precedes -1
1648 int_p_sep_by_space -1
1649 int_n_cs_precedes -1
1650 int_n_sep_by_space -1
1651 int_p_sign_posn -1
1652 int_n_sign_posn -1
1653 #
1654 END LC_MONETARY
1655 .fi
1656 .in -2
1657 .sp
1659 .sp
1660 .LP
1661 The entry \fBn/a\fR indicates that the value is not available in the POSIX
1662 locale.
1663 .SS "LC_NUMERIC"
1664 .LP
1665 The \fBLC_NUMERIC\fR category defines the rules and symbols that will be used
1666 to format non-monetary numeric information. This information is available
1667 through the \fBlocaleconv\fR(3C) function.
1668 .sp
1669 .LP
1670 The following items are defined in this category of the locale. The item names
1671 are the keywords recognized by the \fBlocaledef\fR utility when defining a
1672 locale. They are also similar to the member names of the \fIlconv\fR structure
1673 defined in <\fBlocale.h\fR>. The \fBlocaleconv()\fR function returns
1674 \fB{CHAR_MAX}\fR for unspecified integer items and the empty string (\fB""\fR)
1675 for unspecified or size zero string items.
1676 .sp
1677 .LP
1678 In a locale definition file the operands are strings. For some keywords, the
1679 strings only can contain integers. Keywords that are not provided, string
1680 values set to the empty string (\fB""\fR), or integer keywords set to \fB-1\fR,
1681 will be used to indicate that the value is not available in the locale. The
1682 following keywords are recognized:
1683 .sp
1684 .ne 2
1685 .na
1686 \fB\fBdecimal_point\fR\fR
1687 .ad
1688 .RS 17n
1689 The operand is a string containing the symbol that is used as the decimal
1690 delimiter (radix character) in numeric, non-monetary formatted quantities. This
1691 keyword cannot be omitted and cannot be set to the empty string. In contexts
1692 where standards limit the \fBdecimal_point\fR to a single byte, the result of
1693 specifying a multi-byte operand is unspecified.
1694 .RE
1696 .sp
1697 .ne 2
1698 .na
1699 \fB\fBthousands_sep\fR\fR
1700 .ad
1701 .RS 17n
1702 The operand is a string containing the symbol that is used as a separator for
1703 groups of digits to the left of the decimal delimiter in numeric, non-monetary
1704 formatted monetary quantities. In contexts where standards limit the
1705 \fBthousands_sep\fR to a single byte, the result of specifying a multi-byte
1706 operand is unspecified.
1707 .RE
1709 .sp
1710 .ne 2
1711 .na
1712 \fB\fBgrouping\fR\fR
1713 .ad
1714 .RS 17n
1715 Define the size of each group of digits in formatted non-monetary quantities.
1716 The operand is a sequence of integers separated by semicolons. Each integer
1717 specifies the number of digits in each group, with the initial integer defining
1718 the size of the group immediately preceding the decimal delimiter, and the
1719 following integers defining the preceding groups. If the last integer is not
1720 \fB\(mi1\fR, then the size of the previous group (if any) will be repeatedly
1721 used for the remainder of the digits. If the last integer is \fB-1\fR, then no
1722 further grouping will be performed. The non-monetary numeric formatting
1723 definitions for the POSIX locale follow. The code listing depicts the
1724 \fBlocaledef\fR input, the table representing the same information with the
1725 addition of \fBlocaleconv\fR values, and \fBnl_langinfo\fR constants.
1726 .sp
1727 .in +2
1728 .nf
1729 LC_NUMERIC
1730 # This is the POSIX locale definition for
1731 # the LC_NUMERIC category.
1732 #
1733 decimal_point "<period>"
1734 thousands_sep ""
1735 grouping -1
1736 #
1737 END LC_NUMERIC
1738 .fi
1739 .in -2
1740 .sp
1742 .RE
1744 .sp
1746 .sp
1747 .TS
1748 l l l l l
1749 l l l l l .
1750 \fBPOSIX locale\fR \fBlanginfo\fR \fBlocaleconv()\fR \fBlocaledef\fR
1751 \fBItem\fR \fBValue\fR \fBConstant\fR \fBValue\fR \fBValue\fR
1752 _
1753 \fBdecimal_point\fR \fB"."\fR \fBRADIXCHAR\fR \fB"."\fR \fB\&.\fR
1754 \fBthousands_sep\fR \fBn/a\fR \fBTHOUSEP\fR \fB""\fR \fB""\fR
1755 \fBgrouping\fR \fBn/a\fR \fB-\fR \fB""\fR \fB\(mi1\fR
1756 .TE
1758 .sp
1759 .LP
1760 The entry \fBn/a\fR indicates that the value is not available in the POSIX
1761 locale.
1762 .SS "LC_TIME"
1763 .LP
1764 The \fBLC_TIME\fR category defines the interpretation of the field descriptors
1765 supported by \fBdate\fR(1) and affects the behavior of the \fBstrftime\fR(3C),
1766 \fBwcsftime\fR(3C), \fBstrptime\fR(3C), and \fBnl_langinfo\fR(3C) functions.
1767 Because the interfaces for C-language access and locale definition differ
1768 significantly, they are described separately. For locale definition, the
1769 following mandatory keywords are recognized:
1770 .sp
1771 .ne 2
1772 .na
1773 \fB\fBabday\fR\fR
1774 .ad
1775 .RS 15n
1776 Define the abbreviated weekday names, corresponding to the \fB%a\fR field
1777 descriptor (conversion specification in the \fBstrftime()\fR, \fBwcsftime()\fR,
1778 and \fBstrptime()\fR functions). The operand consists of seven
1779 semicolon-separated strings, each surrounded by double-quotes. The first string
1780 is the abbreviated name of the day corresponding to Sunday, the second the
1781 abbreviated name of the day corresponding to Monday, and so on.
1782 .RE
1784 .sp
1785 .ne 2
1786 .na
1787 \fB\fBday\fR\fR
1788 .ad
1789 .RS 15n
1790 Define the full weekday names, corresponding to the \fB%A\fR field descriptor.
1791 The operand consists of seven semicolon-separated strings, each surrounded by
1792 double-quotes. The first string is the full name of the day corresponding to
1793 Sunday, the second the full name of the day corresponding to Monday, and so on.
1794 .RE
1796 .sp
1797 .ne 2
1798 .na
1799 \fB\fBabmon\fR\fR
1800 .ad
1801 .RS 15n
1802 Define the abbreviated month names, corresponding to the \fB%b\fR field
1803 descriptor. The operand consists of twelve semicolon-separated strings, each
1804 surrounded by double-quotes. The first string is the abbreviated name of the
1805 first month of the year (January), the second the abbreviated name of the
1806 second month, and so on.
1807 .RE
1809 .sp
1810 .ne 2
1811 .na
1812 \fB\fBmon\fR\fR
1813 .ad
1814 .RS 15n
1815 Define the full month names, corresponding to the \fB%B\fR field descriptor.
1816 The operand consists of twelve semicolon-separated strings, each surrounded by
1817 double-quotes. The first string is the full name of the first month of the year
1818 (January), the second the full name of the second month, and so on.
1819 .RE
1821 .sp
1822 .ne 2
1823 .na
1824 \fB\fBd_t_fmt\fR\fR
1825 .ad
1826 .RS 15n
1827 Define the appropriate date and time representation, corresponding to the
1828 \fB%c\fR field descriptor. The operand consists of a string, and can contain
1829 any combination of characters and field descriptors. In addition, the string
1830 can contain the escape sequences \e\e, \fB\ea\fR, \fB\eb\fR, \fB\ef\fR,
1831 \fB\en\fR, \fB\er\fR, \fB\et\fR, \fB\ev\fR\&.
1832 .RE
1834 .sp
1835 .ne 2
1836 .na
1837 \fB\fBdate_fmt\fR\fR
1838 .ad
1839 .RS 15n
1840 Define the appropriate date and time representation, corresponding to the
1841 \fB%C\fR field descriptor. The operand consists of a string, and can contain
1842 any combination of characters and field descriptors. In addition, the string
1843 can contain the escape sequences \fB\e\e\fR, \fB\ea\fR, \fB\eb\fR, \fB\ef\fR,
1844 \fB\en\fR, \fB\er\fR, \fB\et\fR, \fB\ev\fR\&.
1845 .RE
1847 .sp
1848 .ne 2
1849 .na
1850 \fB\fBd_fmt\fR\fR
1851 .ad
1852 .RS 15n
1853 Define the appropriate date representation, corresponding to the \fB%x\fR field
1854 descriptor. The operand consists of a string, and can contain any combination
1855 of characters and field descriptors. In addition, the string can contain the
1856 escape sequences \fB\e\e\fR, \fB\ea\fR, \fB\eb\fR, \fB\ef\fR, \fB\en\fR,
1857 \fB\er\fR, \fB\et\fR, \fB\ev\fR\&.
1858 .RE
1860 .sp
1861 .ne 2
1862 .na
1863 \fB\fBt_fmt\fR\fR
1864 .ad
1865 .RS 15n
1866 Define the appropriate time representation, corresponding to the \fB%X\fR field
1867 descriptor. The operand consists of a string, and can contain any combination
1868 of characters and field descriptors. In addition, the string can contain the
1869 escape sequences \fB\e\e\fR, \fB\ea\fR, \fB\eb\fR, \fB\ef\fR, \fB\en\fR,
1870 \fB\er\fR, \fB\et\fR, \fB\ev\fR\&.
1871 .RE
1873 .sp
1874 .ne 2
1875 .na
1876 \fB\fBam_pm\fR\fR
1877 .ad
1878 .RS 15n
1879 Define the appropriate representation of the \fIante meridiem\fR and \fIpost
1880 meridiem\fR strings, corresponding to the \fB%p\fR field descriptor. The
1881 operand consists of two strings, separated by a semicolon, each surrounded by
1882 double-quotes. The first string represents the \fIante meridiem\fR designation,
1883 the last string the \fIpost meridiem\fR designation.
1884 .RE
1886 .sp
1887 .ne 2
1888 .na
1889 \fB\fBt_fmt_ampm\fR\fR
1890 .ad
1891 .RS 15n
1892 Define the appropriate time representation in the 12-hour clock format with
1893 \fBam_pm\fR, corresponding to the \fB%r\fR field descriptor. The operand
1894 consists of a string and can contain any combination of characters and field
1895 descriptors. If the string is empty, the 12-hour format is not supported in the
1896 locale.
1897 .RE
1899 .sp
1900 .ne 2
1901 .na
1902 \fB\fBera\fR\fR
1903 .ad
1904 .RS 15n
1905 Define how years are counted and displayed for each era in a locale. The
1906 operand consists of semicolon-separated strings. Each string is an era
1907 description segment with the format:
1908 .sp
1909 \fIdirection\fR:\fIoffset\fR:\fIstart_date\fR:\fIend_date\fR:\fIera_name\fR:\fIera_format\fR
1910 .sp
1911 according to the definitions below. There can be as many era description
1912 segments as are necessary to describe the different eras.
1913 .sp
1914 The start of an era might not be the earliest point For example, the Christian
1915 era B.C. starts on the day before January 1, A.D. 1, and increases with earlier
1916 time.
1917 .sp
1918 .ne 2
1919 .na
1920 \fB\fIdirection\fR\fR
1921 .ad
1922 .RS 14n
1923 Either a \fB+\fR or a \fB-\fR character. The \fB+\fR character indicates that
1924 years closer to the \fIstart_date\fR have lower numbers than those closer to
1925 the \fIend_date\fR. The \fB-\fR character indicates that years closer to the
1926 \fIstart_date\fR have higher numbers than those closer to the \fIend_date\fR.
1927 .RE
1929 .sp
1930 .ne 2
1931 .na
1932 \fB\fIoffset\fR\fR
1933 .ad
1934 .RS 14n
1935 The number of the year closest to the \fIstart_date\fR in the era,
1936 corresponding to the \fB%Eg\fR and \fB%Ey\fR field descriptors.
1937 .RE
1939 .sp
1940 .ne 2
1941 .na
1942 \fB\fIstart_date\fR\fR
1943 .ad
1944 .RS 14n
1945 A date in the form \fIyyyy\fR/\fImm\fR/\fBdd\fR, where \fIyyyy\fR, \fImm\fR,
1946 and \fBdd\fR are the year, month and day numbers respectively of the start of
1947 the era. Years prior to A.D. 1 are represented as negative numbers.
1948 .RE
1950 .sp
1951 .ne 2
1952 .na
1953 \fB\fIend_date\fR\fR
1954 .ad
1955 .RS 14n
1956 The ending date of the era, in the same format as the \fIstart_date\fR, or one
1957 of the two special values -* or +*. The value -* indicates that the ending date
1958 is the beginning of time. The value +* indicates that the ending date is the
1959 end of time.
1960 .RE
1962 .sp
1963 .ne 2
1964 .na
1965 \fB\fIera_name\fR\fR
1966 .ad
1967 .RS 14n
1968 A string representing the name of the era, corresponding to the \fB%EC\fR field
1969 descriptor.
1970 .RE
1972 .sp
1973 .ne 2
1974 .na
1975 \fB\fIera_format\fR\fR
1976 .ad
1977 .RS 14n
1978 A string for formatting the year in the era, corresponding to the \fB%EG\fR and
1979 \fB%EY\fR field descriptors.
1980 .RE
1982 .RE
1984 .sp
1985 .ne 2
1986 .na
1987 \fB\fBera_d_fmt\fR\fR
1988 .ad
1989 .RS 15n
1990 Define the format of the date in alternative era notation, corresponding to the
1991 \fB%Ex\fR field descriptor.
1992 .RE
1994 .sp
1995 .ne 2
1996 .na
1997 \fB\fBera_t_fmt\fR\fR
1998 .ad
1999 .RS 15n
2000 Define the locale's appropriate alternative time format, corresponding to the
2001 \fB%EX\fR field descriptor.
2002 .RE
2004 .sp
2005 .ne 2
2006 .na
2007 \fB\fBera_d_t_fmt\fR\fR
2008 .ad
2009 .RS 15n
2010 Define the locale's appropriate alternative date and time format, corresponding
2011 to the \fB%Ec\fR field descriptor.
2012 .RE
2014 .sp
2015 .ne 2
2016 .na
2017 \fB\fBalt_digits\fR\fR
2018 .ad
2019 .RS 15n
2020 Define alternative symbols for digits, corresponding to the \fB%O\fR field
2021 descriptor modifier. The operand consists of semicolon-separated strings, each
2022 surrounded by double-quotes. The first string is the alternative symbol
2023 corresponding with zero, the second string the symbol corresponding with one,
2024 and so on. Up to 100 alternative symbol strings can be specified. The \fB%O\fR
2025 modifier indicates that the string corresponding to the value specified via the
2026 field descriptor will be used instead of the value.
2027 .RE
2029 .SS "LC_TIME \fIC-language\fR Access"
2030 .LP
2031 The following information can be accessed. These correspond to constants
2032 defined in <\fBlanginfo.h\fR> and used as arguments to the
2033 \fBnl_langinfo\fR(3C) function.
2034 .sp
2035 .ne 2
2036 .na
2037 \fB\fBABDAY_\fIx\fR\fR\fR
2038 .ad
2039 .RS 15n
2040 The abbreviated weekday names (for example Sun), where \fIx\fR is a number from
2041 1 to 7.
2042 .RE
2044 .sp
2045 .ne 2
2046 .na
2047 \fB\fBDAY_\fIx\fR\fR\fR
2048 .ad
2049 .RS 15n
2050 The full weekday names (for example Sunday), where \fIx\fR is a number from 1
2051 to 7.
2052 .RE
2054 .sp
2055 .ne 2
2056 .na
2057 \fB\fBABMON_\fIx\fR\fR\fR
2058 .ad
2059 .RS 15n
2060 The abbreviated month names (for example Jan), where \fIx\fR is a number from 1
2061 to 12.
2062 .RE
2064 .sp
2065 .ne 2
2066 .na
2067 \fB\fBMON_\fIx\fR\fR\fR
2068 .ad
2069 .RS 15n
2070 The full month names (for example January), where \fIx\fR is a number from 1 to
2071 12.
2072 .RE
2074 .sp
2075 .ne 2
2076 .na
2077 \fB\fBD_T_FMT\fR\fR
2078 .ad
2079 .RS 15n
2080 The appropriate date and time representation.
2081 .RE
2083 .sp
2084 .ne 2
2085 .na
2086 \fB\fBD_FMT\fR\fR
2087 .ad
2088 .RS 15n
2089 The appropriate date representation.
2090 .RE
2092 .sp
2093 .ne 2
2094 .na
2095 \fB\fBT_FMT\fR\fR
2096 .ad
2097 .RS 15n
2098 The appropriate time representation.
2099 .RE
2101 .sp
2102 .ne 2
2103 .na
2104 \fB\fBAM_STR\fR\fR
2105 .ad
2106 .RS 15n
2107 The appropriate ante-meridiem affix.
2108 .RE
2110 .sp
2111 .ne 2
2112 .na
2113 \fB\fBPM_STR\fR\fR
2114 .ad
2115 .RS 15n
2116 The appropriate post-meridiem affix.
2117 .RE
2119 .sp
2120 .ne 2
2121 .na
2122 \fB\fBT_FMT_AMPM\fR\fR
2123 .ad
2124 .RS 15n
2125 The appropriate time representation in the 12-hour clock format with
2126 \fBAM_STR\fR and \fBPM_STR.\fR
2127 .RE
2129 .sp
2130 .ne 2
2131 .na
2132 \fB\fBERA\fR\fR
2133 .ad
2134 .RS 15n
2135 The era description segments, which describe how years are counted and
2136 displayed for each era in a locale. Each era description segment has the
2137 format:
2138 .sp
2139 .in +2
2140 .nf
2141 \fIdirection\fR:\fIoffset\fR:\fIstart_date\fR:\fIend_date\fR:\fIera_name\fR:\fIera_format\fR
2142 .fi
2143 .in -2
2144 .sp
2146 according to the definitions below. There will be as many era description
2147 segments as are necessary to describe the different eras. Era description
2148 segments are separated by semicolons.
2149 .sp
2150 The start of an era might not be the earliest point For example, the Christian
2151 era B.C. starts on the day before January 1, A.D. 1, and increases with earlier
2152 time.
2153 .sp
2154 .ne 2
2155 .na
2156 \fB\fIdirection\fR\fR
2157 .ad
2158 .RS 14n
2159 Either a + or a - character. The + character indicates that years closer to the
2160 \fIstart_date\fR have lower numbers than those closer to the \fIend_date\fR.
2161 The - character indicates that years closer to the \fIstart_date\fR have higher
2162 numbers than those closer to the \fIend_date\fR.
2163 .RE
2165 .sp
2166 .ne 2
2167 .na
2168 \fB\fIoffset\fR\fR
2169 .ad
2170 .RS 14n
2171 The number of the year closest to the start_date in the era.
2172 .RE
2174 .sp
2175 .ne 2
2176 .na
2177 \fB\fIstart_date\fR\fR
2178 .ad
2179 .RS 14n
2180 A date in the form \fIyyyy\fR/\fImm\fR/\fIdd\fR, where \fIyyyy\fR, \fImm\fR,
2181 and \fBdd\fR are the year, month and day numbers respectively of the start of
2182 the era. Years prior to AD 1 are represented as negative numbers.
2183 .RE
2185 .sp
2186 .ne 2
2187 .na
2188 \fB\fIend_date\fR\fR
2189 .ad
2190 .RS 14n
2191 The ending date of the era, in the same format as the \fIstart_date\fR, or one
2192 of the two special values, \fB-*\fR or \fB+*\fR. The value \fB-*\fR indicates
2193 that the ending date is the beginning of time. The value \fB+*\fR indicates
2194 that the ending date is the end of time.
2195 .RE
2197 .sp
2198 .ne 2
2199 .na
2200 \fB\fIera_name\fR\fR
2201 .ad
2202 .RS 14n
2203 The era, corresponding to the \fB%EC\fR conversion specification.
2204 .RE
2206 .sp
2207 .ne 2
2208 .na
2209 \fB\fIera_format\fR\fR
2210 .ad
2211 .RS 14n
2212 The format of the year in the era, corresponding to the \fB%EY\fR and \fB%EY\fR
2213 conversion specifications.
2214 .RE
2216 .RE
2218 .sp
2219 .ne 2
2220 .na
2221 \fB\fBERA_D_FMT\fR\fR
2222 .ad
2223 .RS 15n
2224 The era date format.
2225 .RE
2227 .sp
2228 .ne 2
2229 .na
2230 \fB\fBERA_T_FMT\fR\fR
2231 .ad
2232 .RS 15n
2233 The locale's appropriate alternative time format, corresponding to the
2234 \fB%EX\fR field descriptor.
2235 .RE
2237 .sp
2238 .ne 2
2239 .na
2240 \fB\fBERA_D_T_FMT\fR\fR
2241 .ad
2242 .RS 15n
2243 The locale's appropriate alternative date and time format, corresponding to the
2244 \fB%Ec\fR field descriptor.
2245 .RE
2247 .sp
2248 .ne 2
2249 .na
2250 \fB\fBALT_DIGITS\fR\fR
2251 .ad
2252 .RS 15n
2253 The alternative symbols for digits, corresponding to the \fB%O\fR conversion
2254 specification modifier. The value consists of semicolon-separated symbols. The
2255 first is the alternative symbol corresponding to zero, the second is the symbol
2256 corresponding to one, and so on. Up to 100 alternative symbols may be
2257 specified. The following table displays the correspondence between the items
2258 described above and the conversion specifiers used by \fBdate\fR(1) and the
2259 \fBstrftime\fR(3C), \fBwcsftime\fR(3C), and \fBstrptime\fR(3C) functions.
2260 .RE
2262 .sp
2264 .sp
2265 .TS
2266 box;
2267 c | c | c
2268 c | c | c .
2269 \fBlocaledef\fR \fBlanginfo\fR \fBConversion\fR
2270 \fBKeyword\fR \fBConstant\fR \fBSpecifier\fR
2271 _
2272 \fBabday\fR \fBABDAY_\fR\fIx\fR \fB%a\fR
2273 \fBday\fR \fBDAY_\fR\fIx\fR \fB%A\fR
2274 \fBabmon\fR \fBABMON_\fR\fIx\fR \fB%b\fR
2275 \fBmon\fR \fBMON\fR \fB%B\fR
2276 \fBd_t_fmt\fR \fBD_T_FMT\fR \fB%c\fR
2277 \fBdate_fmt\fR \fBDATE_FMT\fR \fB%C\fR
2278 \fBd_fmt\fR \fBD_FMT\fR \fB%x\fR
2279 \fBt_fmt\fR \fBT_FMT\fR \fB%X\fR
2280 \fBam_pm\fR \fBAM_STR\fR \fB%p\fR
2281 \fBam_pm\fR \fBPM_STR\fR \fB%p\fR
2282 \fBt_fmt_ampm\fR \fBT_FMT_AMPM\fR \fB%r\fR
2283 \fBera\fR \fBERA\fR \fB%EC, %Eg,\fR
2284 \fB%EG, %Ey, %EY\fR
2285 \fBera_d_fmt\fR \fBERA_D_FMT\fR \fB%Ex\fR
2286 \fBera_t_fmt\fR \fBERA_T_FMT\fR \fB%EX\fR
2287 \fBera_d_t_fmt\fR \fBERA_D_T_FMT\fR \fB%Ec\fR
2288 \fBalt_digits\fR \fBALT_DIGITS\fR \fB%O\fR
2289 .TE
2291 .SS "LC_TIME \fIGeneral\fR Information"
2292 .LP
2293 Although certain of the field descriptors in the POSIX locale (such as the name
2294 of the month) are shown with initial capital letters, this need not be the case
2295 in other locales. Programs using these fields may need to adjust the
2296 capitalization if the output is going to be used at the beginning of a
2297 sentence.
2298 .sp
2299 .LP
2300 The \fBLC_TIME\fR descriptions of \fBabday\fR, \fBday\fR, \fBmon\fR, and
2301 \fBabmon\fR imply a Gregorian style calendar (7-day weeks, 12-month years, leap
2302 years, and so forth). Formatting time strings for other types of calendars is
2303 outside the scope of this document set.
2304 .sp
2305 .LP
2306 As specified under \fBdate\fR in \fBLocale Definition\fR and
2307 \fBstrftime\fR(3C), the field descriptors corresponding to the optional
2308 keywords consist of a modifier followed by a traditional field descriptor (for
2309 instance \fB%Ex\fR). If the optional keywords are not supported by the
2310 implementation or are unspecified for the current locale, these field
2311 descriptors are treated as the traditional field descriptor. For instance,
2312 assume the following keywords:
2313 .sp
2314 .in +2
2315 .nf
2316 alt_digits "0th" ; "1st" ; "2nd" ; "3rd" ; "4th" ; "5th" ; \e
2317 "6th" ; "7th" ; "8th" ; "9th" ; "10th">
2318 d_fmt "The %Od day of %B in %Y"
2319 .fi
2320 .in -2
2321 .sp
2323 .sp
2324 .LP
2325 On 7/4/1776, the \fB%x\fR field descriptor would result in "The 4th day of July
2326 in 1776" while 7/14/1789 would come out as "The 14 day of July in 1789" The
2327 above example is for illustrative purposes only. The \fB%O\fR modifier is
2328 primarily intended to provide for Kanji or Hindi digits in \fBdate\fR formats.
2329 .SS "LC_MESSAGES"
2330 .LP
2331 The \fBLC_MESSAGES\fR category defines the format and values for affirmative
2332 and negative responses.
2333 .sp
2334 .LP
2335 The following keywords are recognized as part of the locale definition file.
2336 The \fBnl_langinfo\fR(3C) function accepts upper-case versions of the first
2337 four keywords.
2338 .sp
2339 .ne 2
2340 .na
2341 \fB\fByesexpr\fR\fR
2342 .ad
2343 .RS 11n
2344 The operand consists of an extended regular expression (see \fBregex\fR(5))
2345 that describes the acceptable affirmative response to a question expecting an
2346 affirmative or negative response.
2347 .RE
2349 .sp
2350 .ne 2
2351 .na
2352 \fB\fBnoexpr\fR\fR
2353 .ad
2354 .RS 11n
2355 The operand consists of an extended regular expression that describes the
2356 acceptable negative response to a question expecting an affirmative or negative
2357 response.
2358 .RE
2360 .sp
2361 .ne 2
2362 .na
2363 \fB\fByesstr\fR\fR
2364 .ad
2365 .RS 11n
2366 The operand consists of a fixed string (not a regular expression) that can be
2367 used by an application for composition of a message that lists an acceptable
2368 affirmative response, such as in a prompt.
2369 .RE
2371 .sp
2372 .ne 2
2373 .na
2374 \fB\fBnostr\fR\fR
2375 .ad
2376 .RS 11n
2377 The operand consists of a fixed string that can be used by an application for
2378 composition of a message that lists an acceptable negative response. The format
2379 and values for affirmative and negative responses of the POSIX locale follow;
2380 the code listing depicting the \fBlocaledef\fR input, the table representing
2381 the same information with the addition of \fBnl_langinfo()\fR constants.
2382 .sp
2383 .in +2
2384 .nf
2385 LC_MESSAGES
2386 # This is the POSIX locale definition for
2387 # the LC_MESSAGES category.
2388 #
2389 yesexpr "<circumflex><left-square-bracket><y><Y>\e
2390 <right-square-bracket>"
2391 #
2392 noexpr "<circumflex><left-square-bracket><n><N>\e
2393 <right-square-bracket>"
2394 #
2395 yesstr "yes"
2396 nostr "no"
2397 END LC_MESSAGES
2398 .fi
2399 .in -2
2400 .sp
2402 .RE
2404 .sp
2406 .sp
2407 .TS
2408 box;
2409 l | l | l
2410 l | l | l .
2411 \fBlocaledef Keyword\fR \fBlanginfo Constant\fR \fBPOSIX Locale Value\fR
2412 \fByesexpr\fR \fBYESEXPR\fR \fB"^[yY]"\fR
2413 \fBnoexpr\fR \fBNOEXPR\fR \fB"^[nN]"\fR
2414 \fByesstr\fR \fBYESSTR\fR \fB"yes"\fR
2415 \fBnostr\fR \fBNOSTR\fR \fB"no"\fR
2416 .TE
2418 .sp
2419 .LP
2420 In an application conforming to the SUSv3 standard, the information on
2421 \fByesstr\fR and \fBnostr\fR is not available.
2422 .SH SEE ALSO
2423 .LP
2424 \fBdate\fR(1), \fBlocale\fR(1), \fBlocaledef\fR(1), \fBsort\fR(1), \fBtr\fR(1),
2425 \fBuniq\fR(1), \fBlocaleconv\fR(3C), \fBnl_langinfo\fR(3C),
2426 \fBsetlocale\fR(3C), \fBstrcoll\fR(3C), \fBstrftime\fR(3C), \fBstrptime\fR(3C),
2427 \fBstrxfrm\fR(3C), \fBwcscoll\fR(3C), \fBwcsftime\fR(3C), \fBwcsxfrm\fR(3C),
2428 \fBwctype\fR(3C), \fBattributes\fR(5), \fBcharmap\fR(5), \fBextensions\fR(5),
2429 \fBregex\fR(5)