+'\" t -*- coding: UTF-8 -*-
.\" Copyright (C) 1994 Jochen Hein (Hein@Student.TU-Clausthal.de)
.\" Copyright (C) 2008 Petr Baudis (pasky@suse.cz)
.\" Copyright (C) 2014 Michael Kerrisk <mtk@manpages@gmail.com>
.\" 2008-06-17 Petr Baudis <pasky@suse.cz>
.\" LC_TIME: Describe first_weekday and first_workday
.\"
-.TH LOCALE 5 2014-03-18 "Linux" "Linux User Manual"
+.TH LOCALE 5 2015-01-22 "Linux" "Linux User Manual"
.SH NAME
locale \- describes a locale definition file
.SH DESCRIPTION
If the category should be copied,
the only valid keyword in the definition is
.B copy
-followed by the name of the locale which should be copied.
+followed by the name of the locale in double quotes which should be
+copied.
+.PP
+When defining a category from scratch, all field descriptors and strings
+should be defined as Unicode code points in angle brackets, unless
+otherwise stated below.
+For example, "€" is to be presented as "<U20AC>", "%a" as
+"<U0025><U0061>", and "Monday" as
+"<U0053><U0075><U006E><U0064><U0061><U0079>".
+Values defined as Unicode code points must be in double quotes, plain
+number values are not quoted (but
+.BR LC_CTYPE
+and
+.BR LC_COLLATE
+follow special formatting, see the system-provided locale files for
+examples).
.SS Locale category sections
The following category sections are defined by POSIX:
.IP * 3
.B LC_PAPER
.IP *
.B LC_TELEPHONE
+.PP
+See
+.BR locale (7)
+for a more detailed description of each category.
+
.SS LC_ADDRESS
-The definition for the
+The definition starts with the string
.B LC_ADDRESS
-category starts with the string
-.I LC_ADDRESS
in the first column.
The following keywords are allowed:
.\" .B LC_NAME
.\" .I name_fmt
.\" keyword.
+.\"
+.\" https://sourceware.org/bugzilla/show_bug.cgi?id=16983
.TP
%a
Care of person, or organization.
.\" BUG: %l escape sequence from ISO/IEC 14652:2002 is not
.\" supported by glibc
.\" Local township within town or city.
+.\"
+.\" https://sourceware.org/bugzilla/show_bug.cgi?id=16983
.TP
%z
Zip number, postal code.
.TP
.I country_name
followed by the country name in the language of the current document
-(e.g., "Deutschland for the
+(e.g., "Deutschland" for the
.IR de_DE
locale).
.TP
followed by the three-letter abbreviation of the country (ISO 3166).
.TP
.I country_num
-followed by the numeric country code (ISO 3166).
+followed by the numeric country code as plain numbers (ISO 3166).
.TP
.I country_car
followed by the code for the country car number.
.TP
.I country_isbn
-followed by the ISBN code (for books).
+followed by the ISBN code as plain numbers (for books).
.TP
.I lang_name
followed by the language name in the language of the current document.
followed by the two-letter abbreviation of the language (ISO 639).
.TP
.I lang_term
-followed by the three-letter abbreviation of the language (ISO 639-2).
+followed by the three-letter abbreviation of the language (ISO 639-2/T).
.TP
.I lang_lib
-followed by the three-letter abbreviation of the language for
-library use (ISO 639-2)
+followed by the three-letter abbreviation of the language for library
+use (ISO 639-2/B).
+Applications should in general prefer
+.IR lang_term
+over
+.IR lang_lib .
.PP
The
.B LC_ADDRESS
definition ends with the string
.IR "END LC_ADDRESS" .
.SS LC_CTYPE
-The definition for the
+The definition starts with the string
.B LC_CTYPE
-category starts with the string
-.I LC_CTYPE
in the first column.
The following keywords are allowed:
-.\" FIXME translit_start + translit_end are not documented
-.\" FIXME 'charclass' is not documented
-.\" FIXME 'charconv' is not documented
-.\" FIXME 'outdigit' is not documented
-.\" FIXME 'include' is not documented
-.\" FIXME 'map' (to_inpunct, to_outpunct) is not documented
+.\" FIXME The following LC_CTYPE keywords are not documented:
+.\" translit_start + translit_end
+.\" charclass
+.\" charconv
+.\" outdigit
+.\" include
+.\" map (to_inpunct, to_outpunct)
.TP
.I upper
followed by a list of uppercase letters.
The
.B LC_CTYPE
definition ends with the string
-.IR "END LC_CYTPE" .
+.IR "END LC_CTYPE" .
.SS LC_COLLATE
-.\" FIXME: the decsription of LC_COLLATE lacks a lot of details
-The
-.B LC_COLLATE
-category defines the rules for collating characters.
-Due to
-limitations of libc not all POSIX-options are implemented.
+Due to limitations of glibc not all POSIX-options are implemented.
The definition starts with the string
.B LC_COLLATE
in the first column.
The following keywords are allowed:
-.\" FIXME 'reorder-after' is not documented
-.\" FIXME 'reorder-end' is not documented
-.\" FIXME 'reorder-sections-after' is not documented
-.\" FIXME 'reorder-sections-end' is not documented
-.\" FIXME 'script' is not documented
-.\" FIXME 'symbol-equivalence' is not documented
+.\" FIXME The following LC_COLLATE keywords are not documented:
+.\" script
+.\" symbol-equivalence
.TP
.I collating-element
+followed by the definition of a collating-element symbol
+representing a multicharacter collating element.
.TP
.I collating-symbol
+followed by the definition of a collating symbol
+that can be used in collation order statements.
.PP
The order-definition starts with a line:
.TP
.I order_start
-.PP
followed by a list of keywords chosen from
.BR forward ,
.BR backward ,
.BR position .
The order definition consists of lines that describe the order
and is terminated with the keyword
-.TP
.IR order_end .
-.PP
-For more details see the sources in
-.I /usr/lib/nls/src
-notably the examples
-.BR POSIX ,
-.B Example
-and
-.B Example2
+.\" FIXME The following LC_COLLATE keywords are not documented:
+.\" reorder-after
+.\" reorder-end
+.\" reorder-sections-after
+.\" reorder-sections-end
.PP
The
.B LC_COLLATE
definition ends with the string
.IR "END LC_COLLATE" .
.SS LC_IDENTIFICATION
-This category contains meta-information about the locale definition.
-
The definition starts with the string
.B LC_IDENTIFICATION
in the first column.
+The values in this category are defined as plain strings.
+
The following keywords are allowed:
.TP
.I title
-followed by the title of ths locale document
+followed by the title of the locale document
(e.g., "Maori language locale for New Zealand").
.TP
.I source
of the organization that maintains this document.
.TP
.I fax
-followed by the FAX number (in international format)
+followed by the fax number (in international format)
of the organization that maintains this document.
.TP
.I language
a semicolon, and
.IP *
one of the
-.I LC_*
+.BI LC_ *
identifiers.
.PP
The
The following keywords are allowed:
.TP
.I measurement
-folowed by number identifying the standard used for measurement.
+followed by number identifying the standard used for measurement.
The following values are recognized:
.RS
.TP
.B LC_MONETARY
in the first column.
+Values for
+.IR int_curr_symbol ,
+.IR currency_symbol ,
+.IR mon_decimal_point ,
+.IR mon_thousands_sep ,
+.IR positive_sign ,
+and
+.IR negative_sign
+are defined as Unicode code points, the others as plain numbers.
+
The following keywords are allowed:
.TP
.I int_curr_symbol
when formatting monetary quantities.
.TP
.I mon_grouping
-followed by a string that describes the formatting of numeric
-quantities.
+followed by a sequence of integers separated by semicolons that
+describe the formatting of monetary quantities.
+See
+.I grouping
+below for details.
.TP
.I positive_sign
followed by a string that is used to indicate a positive sign for
.I n_sep_by_space
followed by an integer that indicates the separation of
.IR currency_symbol ,
-the sign string, and the value for a nonnegative formatted monetary quantity.
+the sign string, and the value for a negative formatted monetary quantity.
The same values are recognized as for
.IR p_sep_by_space .
.TP
.TP
.I int_p_sign_posn
followed by an integer that indicates where the
-.I negative_sign
+.I positive_sign
should be placed for a nonnegative
internationally formatted monetary quantity.
The same values are recognized as for
.B LC_NAME
in the first column.
-The following keywords are allowed:
+Various keywords are allowed, but only
+.IR name_fmt
+is mandatory.
+Other keywords are needed only if there is common convention to
+use the corresponding salutation in this locale.
+The allowed keywords are as follows:
.TP
.I name_fmt
followed by a string containing field descriptors that define
when formatting numeric quantities.
.TP
.I grouping
-followed by a string that describes the formatting of numeric
-quantities.
+followed by a sequence of integers as plain numbers separated by
+semicolons that describe the formatting of numeric quantities.
+.IP
+Each integer specifies the number of digits in a group.
+The first integer defines the size of the group immediately
+to the left of the decimal delimiter.
+Subsequent integers define succeeding groups to the
+left of the previous group.
+If the last integer is not \-1, then the size of the previous group
+(if any) is repeatedly used for the remainder of the digits.
+If the last integer is \-1, then no further grouping is performed.
.PP
The
.B LC_NUMERIC
.B LC_PAPER
in the first column.
+Values in this category are defined as plain numbers.
+
The following keywords are allowed:
.TP
.I height
.RS
.TP
%a
-Area code without nationwide prefix (the prefix is often "0").
+Area code without nationwide prefix (the prefix is often "00").
.TP
%A
Area code including nationwide prefix.
Country code.
.TP
%C
-Alternate carrier service code used for dialling abroad.
+Alternate carrier service code used for dialing abroad.
.TP
%t
If the preceding field descriptor resulted in an empty string,
.I tel_dom_fmt
followed by a string that contains field descriptors that identify
the format used to dial domestic numbers.
-The recognized field descriptrs are the same as for
+The recognized field descriptors are the same as for
.IR tel_int_fmt .
.TP
.I int_select
in the first column.
The following keywords are allowed:
-.\" FIXME 'era', 'era_d_fmt', 'era_d_t_fmt', 'era_t_fmt', are not documented
-.\" FIXME 'timezone' is not documented
+.\" FIXME The following LC_TIME keywords are not documented:
+.\" era
+.\" era_d_fmt
+.\" era_d_t_fmt
+.\" era_t_fmt
+.\" timezone
.TP
.I abday
followed by a list of abbreviated names of the days of the week.
as specified by
.I week
(Sunday by default).
+See NOTES.
.TP
.I day
followed by a list of names of the days of the week.
as specified by
.I week
(Sunday by default).
+See NOTES.
.TP
.I abmon
followed by a list of abbreviated month names.
followed by a list of month names.
.TP
.I am_pm
-The appropriate representation of the
+followed by the appropriate representation of the
.B am
and
.B pm
strings.
+This should be left empty for locales not using AM/PM convention.
.TP
.I d_t_fmt
-The appropriate date and time format.
+followed by the appropriate date and time format.
.TP
.I d_fmt
-The appropriate date format.
+followed by the appropriate date format.
.TP
.I t_fmt
-The appropriate time format.
+followed by the appropriate time format.
.TP
.I t_fmt_ampm
-The appropriate time format when using 12h clock format.
+followed by the appropriate time format when using 12h clock format.
+This should be left empty for locales not using AM/PM convention.
.TP
.I week
-followed by a list of three values:
+followed by a list of three values as plain numbers:
The number of days in a week (by default 7),
a date of beginning of the week (by default corresponds to Sunday),
and the minimal length of the first week in year (by default 4).
shall be used for Sunday and
.B 19971201
shall be used for Monday.
-Thus, countries using
-.B 19971130
-should have local Sunday name as the first day in the
-.I day
-list,
-while countries using
-.B 19971201
-should have Monday translation as the first item in the
-.I day
-list.
+See NOTES.
.TP
.IR first_weekday " (since glibc 2.2)"
-Number of the first day from the
+followed by the number of the first day from the
.I day
list to be shown in calendar applications.
The default value of
.B 1
-corresponds to either Sunday or Monday depending
+(plain number) corresponds to either Sunday or Monday depending
on the value of the second
.I week
list item.
+See NOTES.
.TP
.IR first_workday " (since glibc 2.2)"
-Number of the first working day from the
+followed by the number of the first working day from the
.I day
list.
+The default value is
+.BR 2
+(plain number).
+See NOTES.
.TP
.I cal_direction
.\" from localedata/locales/uk_UA
-followed by a value that indicates the direction for the
+followed by a plain number value that indicates the direction for the
display of calendar dates, as follows:
.RS
.TP
-1
-left-right from top
+.B 1
+Left-right from top.
.TP
-2
-top-down from left
+.B 2
+Top-down from left.
.TP
-3
-right-left from top
+.B 3
+Right-left from top.
.RE
.TP
.I date_fmt
definition ends with the string
.IR "END LC_TIME" .
.SH FILES
-/usr/lib/locale/
-\(em database for the current locale setting of that category
-.br
-/usr/lib/nls/charmap/* \(em charmap-files
+.TP
+.I /usr/lib/locale/locale-archive
+Usual default locale archive location.
+.TP
+.I /usr/share/i18n/locales
+Usual default path for locale definition files.
.SH CONFORMING TO
-POSIX.2, ISO/IEC 14652.
+POSIX.2, ISO/IEC TR 14652.
+.SH NOTES
+The collective GNU C library community wisdom regarding
+.IR abday ,
+.IR day ,
+.IR week ,
+.IR first_weekday ,
+and
+.I first_workday
+states at
+https://sourceware.org/glibc/wiki/Locales
+the following:
+.IP * 3
+The value of the second
+.I week
+list item specifies the base of the
+.I abday
+and
+.I day
+lists.
+.IP *
+.I first_weekday
+specifies the offset of the first day-of-week in the
+.I abday
+and
+.I day
+lists.
+.IP *
+For compatibility reasons, all glibc locales should set the value of the
+second
+.I week
+list item to
+.B 19971130
+(Sunday) and base the
+.I abday
+and
+.I day
+lists appropriately, and set
+.I first_weekday
+and
+.I first_workday
+to
+.B 1
+or
+.BR 2 ,
+depending on whether the week and work week actually starts on Sunday or
+Monday for the locale.
.SH BUGS
This manual page isn't complete.
.\" .SH AUTHOR
.BR setlocale (3),
.BR uselocale (3),
.BR charmap (5),
-.BR locale (7)
+.BR charsets (7),
+.BR locale (7),
+.BR unicode (7),
+.BR utf-8 (7)
+.SH COLOPHON
+This page is part of release 3.79 of the Linux
+.I man-pages
+project.
+A description of the project,
+information about reporting bugs,
+and the latest version of this page,
+can be found at
+\%http://www.kernel.org/doc/man\-pages/.