This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
be41f0aa844b81b8a8c05838c02ac7065b6da73d
[perl5.git] / pod / perllocale.pod
1 =encoding utf8
2
3 =head1 NAME
4
5 perllocale - Perl locale handling (internationalization and localization)
6
7 =head1 DESCRIPTION
8
9 In the beginning there was ASCII, the "American Standard Code for
10 Information Interchange", which works quite well for Americans with
11 their English alphabet and dollar-denominated currency.  But it doesn't
12 work so well even for other English speakers, who may use different
13 currencies, such as the pound sterling (as the symbol for that currency
14 is not in ASCII); and it's hopelessly inadequate for many of the
15 thousands of the world's other languages.
16
17 To address these deficiencies, the concept of locales was invented
18 (formally the ISO C, XPG4, POSIX 1.c "locale system").  And applications
19 were and are being written that use the locale mechanism.  The process of
20 making such an application take account of its users' preferences in
21 these kinds of matters is called B<internationalization> (often
22 abbreviated as B<i18n>); telling such an application about a particular
23 set of preferences is known as B<localization> (B<l10n>).
24
25 Perl has been extended to support the locale system.  This
26 is controlled per application by using one pragma, one function call,
27 and several environment variables.
28
29 Unfortunately, there are quite a few deficiencies with the design (and
30 often, the implementations) of locales.  Unicode was invented (see
31 L<perlunitut> for an introduction to that) in part to address these
32 design deficiencies, and nowadays, there is a series of "UTF-8
33 locales", based on Unicode.  These are locales whose character set is
34 Unicode, encoded in UTF-8.  Starting in v5.20, Perl fully supports
35 UTF-8 locales, except for sorting and string comparisions.  (Use
36 L<Unicode::Collate> for these.)  Perl continues to support the old
37 non UTF-8 locales as well.
38
39 (Unicode is also creating C<CLDR>, the "Common Locale Data Repository",
40 L<http://cldr.unicode.org/> which includes more types of information than
41 are available in the POSIX locale system.  At the time of this writing,
42 there was no CPAN module that provides access to this XML-encoded data.
43 However, many of its locales have the POSIX-only data extracted, and are
44 available as UTF-8 locales at
45 L<http://unicode.org/Public/cldr/latest/>.)
46
47 =head1 WHAT IS A LOCALE
48
49 A locale is a set of data that describes various aspects of how various
50 communities in the world categorize their world.  These categories are
51 broken down into the following types (some of which include a brief
52 note here):
53
54 =over
55
56 =item Category LC_NUMERIC: Numeric formatting
57
58 This indicates how numbers should be formatted for human readability,
59 for example the character used as the decimal point.
60
61 =item Category LC_MONETARY: Formatting of monetary amounts
62
63 =for comment
64 The nbsp below makes this look better
65
66 E<160>
67
68 =item Category LC_TIME: Date/Time formatting
69
70 =for comment
71 The nbsp below makes this look better
72
73 E<160>
74
75 =item Category LC_MESSAGES: Error and other messages
76
77 This is used by Perl itself only for accessing operating system error
78 messages via L<$!|perlvar/$ERRNO> and L<$^E|perlvar/$EXTENDED_OS_ERROR>.
79
80 =item Category LC_COLLATE: Collation
81
82 This indicates the ordering of letters for comparison and sorting.
83 In Latin alphabets, for example, "b", generally follows "a".
84
85 =item Category LC_CTYPE: Character Types
86
87 This indicates, for example if a character is an uppercase letter.
88
89 =item Other categories
90
91 Some platforms have other categories, dealing with such things as
92 measurement units and paper sizes.  None of these are used directly by
93 Perl, but outside operations that Perl interacts with may use
94 these.  See L</Not within the scope of any "use locale" variant> below.
95
96 =back
97
98 More details on the categories used by Perl are given below in L</LOCALE
99 CATEGORIES>.
100
101 Together, these categories go a long way towards being able to customize
102 a single program to run in many different locations.  But there are
103 deficiencies, so keep reading.
104
105 =head1 PREPARING TO USE LOCALES
106
107 Perl itself will not use locales unless specifically requested to (but
108 again note that Perl may interact with code that does use them).  Even
109 if there is such a request, B<all> of the following must be true
110 for it to work properly:
111
112 =over 4
113
114 =item *
115
116 B<Your operating system must support the locale system>.  If it does,
117 you should find that the C<setlocale()> function is a documented part of
118 its C library.
119
120 =item *
121
122 B<Definitions for locales that you use must be installed>.  You, or
123 your system administrator, must make sure that this is the case. The
124 available locales, the location in which they are kept, and the manner
125 in which they are installed all vary from system to system.  Some systems
126 provide only a few, hard-wired locales and do not allow more to be
127 added.  Others allow you to add "canned" locales provided by the system
128 supplier.  Still others allow you or the system administrator to define
129 and add arbitrary locales.  (You may have to ask your supplier to
130 provide canned locales that are not delivered with your operating
131 system.)  Read your system documentation for further illumination.
132
133 =item *
134
135 B<Perl must believe that the locale system is supported>.  If it does,
136 C<perl -V:d_setlocale> will say that the value for C<d_setlocale> is
137 C<define>.
138
139 =back
140
141 If you want a Perl application to process and present your data
142 according to a particular locale, the application code should include
143 the S<C<use locale>> pragma (see L<The use locale pragma>) where
144 appropriate, and B<at least one> of the following must be true:
145
146 =over 4
147
148 =item 1
149
150 B<The locale-determining environment variables (see L</"ENVIRONMENT">)
151 must be correctly set up> at the time the application is started, either
152 by yourself or by whomever set up your system account; or
153
154 =item 2
155
156 B<The application must set its own locale> using the method described in
157 L<The setlocale function>.
158
159 =back
160
161 =head1 USING LOCALES
162
163 =head2 The use locale pragma
164
165 By default, Perl itself ignores the current locale.  The S<C<use locale>>
166 pragma tells Perl to use the current locale for some operations.
167 Starting in v5.16, there is an optional parameter to this pragma:
168
169     use locale ':not_characters';
170
171 This parameter allows better mixing of locales and Unicode (less useful
172 in v5.20 and later), and is
173 described fully in L</Unicode and UTF-8>, but briefly, it tells Perl to
174 not use the character portions of the locale definition, that is
175 the C<LC_CTYPE> and C<LC_COLLATE> categories.  Instead it will use the
176 native character set (extended by Unicode).  When using this parameter,
177 you are responsible for getting the external character set translated
178 into the native/Unicode one (which it already will be if it is one of
179 the increasingly popular UTF-8 locales).  There are convenient ways of
180 doing this, as described in L</Unicode and UTF-8>.
181
182 The current locale is set at execution time by
183 L<setlocale()|/The setlocale function> described below.  If that function
184 hasn't yet been called in the course of the program's execution, the
185 current locale is that which was determined by the L</"ENVIRONMENT"> in
186 effect at the start of the program, except that
187 C<L<LC_NUMERIC|/Category LC_NUMERIC: Numeric Formatting>> is always
188 initialized to the C locale (the C locale is mentioned under L<Finding
189 locales>).
190 If there is no valid environment, the current locale is whatever the
191 system default has been set to.  It is likely, but not necessarily, the
192 "C" locale.
193
194 The operations that are affected by locale are:
195
196 =over 4
197
198 =item B<Not within the scope of any C<"use locale"> variant>
199
200 Only operations originating outside Perl should be affected, as follows:
201
202 =over 4
203
204 =item *
205
206 The variable L<$!|perlvar/$ERRNO> (and its synonyms C<$ERRNO> and
207 C<$OS_ERROR>) when used as strings always are in terms of the current
208 locale.
209
210 =item *
211
212 The current locale is also used when going outside of Perl with
213 operations like L<system()|perlfunc/system LIST> or
214 L<qxE<sol>E<sol>|perlop/qxE<sol>STRINGE<sol>>, if those operations are
215 locale-sensitive.
216
217 =item *
218
219 Also Perl gives access to various C library functions through the
220 L<POSIX> module.  Some of those functions are always affected by the
221 current locale.  For example, C<POSIX::strftime()> uses C<LC_TIME>;
222 C<POSIX::strtod()> uses C<LC_NUMERIC>; C<POSIX::strcoll()> and
223 C<POSIX::strxfrm()> use C<LC_COLLATE>; and character classification
224 functions like C<POSIX::isalnum()> use C<LC_CTYPE>.  All such functions
225 will behave according to the current underlying locale, even if that
226 locale isn't exposed to Perl space.
227
228 =item *
229
230 Perl also provides lite wrappers for XS modules to use some C library
231 C<printf> functions.  These wrappers don't do anything with the locale,
232 and the underlying C library function is affected by the locale in
233 effect at the time of the wrapper call.
234 The affected functions are
235 L<perlapi/my_sprintf>,
236 L<perlapi/my_snprintf>,
237 and
238 L<perlapi/my_vsnprintf>.
239
240 =back
241
242 =item Lingering effects of C<S<use locale>>
243
244 Certain Perl operations that are set-up within the scope of a
245 C<use locale> variant retain that effect even outside the scope.
246 These include:
247
248 =over 4
249
250 =item *
251
252 The output format of a L<write()|perlfunc/write> is determined by an
253 earlier format declaration (L<perlfunc/format>), so whether or not the
254 output is affected by locale is determined by if the C<format()> is
255 within the scope of a C<use locale> variant, not whether the C<write()>
256 is.
257
258 =item *
259
260 Regular expression patterns can be compiled using
261 L<qrE<sol>E<sol>|perlop/qrE<sol>STRINGE<sol>msixpodual> with actual
262 matching deferred to later.  Again, it is whether or not the compilation
263 was done within the scope of C<use locale> that determines the match
264 behavior, not if the matches are done within such a scope or not.
265
266 =back
267
268 =item B<Under C<"use locale ':not_characters';">>
269
270 =over 4
271
272 =item *
273
274 All the non-Perl operations.
275
276 =item *
277
278 B<Format declarations> (L<perlfunc/format>) and hence any subsequent
279 C<write()>s use C<LC_NUMERIC>.
280
281 =item *
282
283 B<stringification and output> use C<LC_NUMERIC>.
284 These include the results of
285 C<print()>,
286 C<printf()>,
287 C<say()>,
288 and
289 C<sprintf()>.
290
291 =back
292
293 =for comment
294 The nbsp below makes this look better
295
296 E<160>
297
298 =item B<Under just plain C<"use locale";>>
299
300 =over 4
301
302 =item *
303
304 All the above operations
305
306 =item *
307
308 B<The comparison operators> (C<lt>, C<le>, C<cmp>, C<ge>, and C<gt>) use
309 C<LC_COLLATE>.  C<sort()> is also affected if used without an
310 explicit comparison function, because it uses C<cmp> by default.
311
312 B<Note:> C<eq> and C<ne> are unaffected by locale: they always
313 perform a char-by-char comparison of their scalar operands.  What's
314 more, if C<cmp> finds that its operands are equal according to the
315 collation sequence specified by the current locale, it goes on to
316 perform a char-by-char comparison, and only returns I<0> (equal) if the
317 operands are char-for-char identical.  If you really want to know whether
318 two strings--which C<eq> and C<cmp> may consider different--are equal
319 as far as collation in the locale is concerned, see the discussion in
320 L<Category LC_COLLATE: Collation>.
321
322 =item *
323
324 B<Regular expressions and case-modification functions> (C<uc()>, C<lc()>,
325 C<ucfirst()>, and C<lcfirst()>) use C<LC_CTYPE>
326
327 =back
328
329 =back
330
331 The default behavior is restored with the S<C<no locale>> pragma, or
332 upon reaching the end of the block enclosing C<use locale>.
333 Note that C<use locale> and C<use locale ':not_characters'> may be
334 nested, and that what is in effect within an inner scope will revert to
335 the outer scope's rules at the end of the inner scope.
336
337 The string result of any operation that uses locale
338 information is tainted, as it is possible for a locale to be
339 untrustworthy.  See L<"SECURITY">.
340
341 =head2 The setlocale function
342
343 You can switch locales as often as you wish at run time with the
344 C<POSIX::setlocale()> function:
345
346         # Import locale-handling tool set from POSIX module.
347         # This example uses: setlocale -- the function call
348         #                    LC_CTYPE -- explained below
349         # (Showing the testing for success/failure of operations is
350         # omitted in these examples to avoid distracting from the main
351         # point
352
353         use POSIX qw(locale_h);
354         use locale;
355         my $old_locale;
356
357         # query and save the old locale
358         $old_locale = setlocale(LC_CTYPE);
359
360         setlocale(LC_CTYPE, "fr_CA.ISO8859-1");
361         # LC_CTYPE now in locale "French, Canada, codeset ISO 8859-1"
362
363         setlocale(LC_CTYPE, "");
364         # LC_CTYPE now reset to default defined by LC_ALL/LC_CTYPE/LANG
365         # environment variables.  See below for documentation.
366
367         # restore the old locale
368         setlocale(LC_CTYPE, $old_locale);
369
370 The first argument of C<setlocale()> gives the B<category>, the second the
371 B<locale>.  The category tells in what aspect of data processing you
372 want to apply locale-specific rules.  Category names are discussed in
373 L</LOCALE CATEGORIES> and L</"ENVIRONMENT">.  The locale is the name of a
374 collection of customization information corresponding to a particular
375 combination of language, country or territory, and codeset.  Read on for
376 hints on the naming of locales: not all systems name locales as in the
377 example.
378
379 If no second argument is provided and the category is something other
380 than LC_ALL, the function returns a string naming the current locale
381 for the category.  You can use this value as the second argument in a
382 subsequent call to C<setlocale()>, B<but> on some platforms the string
383 is opaque, not something that most people would be able to decipher as
384 to what locale it means.
385
386 If no second argument is provided and the category is LC_ALL, the
387 result is implementation-dependent.  It may be a string of
388 concatenated locale names (separator also implementation-dependent)
389 or a single locale name.  Please consult your L<setlocale(3)> man page for
390 details.
391
392 If a second argument is given and it corresponds to a valid locale,
393 the locale for the category is set to that value, and the function
394 returns the now-current locale value.  You can then use this in yet
395 another call to C<setlocale()>.  (In some implementations, the return
396 value may sometimes differ from the value you gave as the second
397 argument--think of it as an alias for the value you gave.)
398
399 As the example shows, if the second argument is an empty string, the
400 category's locale is returned to the default specified by the
401 corresponding environment variables.  Generally, this results in a
402 return to the default that was in force when Perl started up: changes
403 to the environment made by the application after startup may or may not
404 be noticed, depending on your system's C library.
405
406 Note that Perl ignores the current C<LC_CTYPE> and C<LC_COLLATE> locales
407 within the scope of a C<use locale ':not_characters'>.
408
409 If C<set_locale()> fails for some reason (for example, an attempt to set
410 to a locale unknown to the system), the locale for the category is not
411 changed, and the function returns C<undef>.
412
413
414 For further information about the categories, consult L<setlocale(3)>.
415
416 =head2 Finding locales
417
418 For locales available in your system, consult also L<setlocale(3)> to
419 see whether it leads to the list of available locales (search for the
420 I<SEE ALSO> section).  If that fails, try the following command lines:
421
422         locale -a
423
424         nlsinfo
425
426         ls /usr/lib/nls/loc
427
428         ls /usr/lib/locale
429
430         ls /usr/lib/nls
431
432         ls /usr/share/locale
433
434 and see whether they list something resembling these
435
436         en_US.ISO8859-1     de_DE.ISO8859-1     ru_RU.ISO8859-5
437         en_US.iso88591      de_DE.iso88591      ru_RU.iso88595
438         en_US               de_DE               ru_RU
439         en                  de                  ru
440         english             german              russian
441         english.iso88591    german.iso88591     russian.iso88595
442         english.roman8                          russian.koi8r
443
444 Sadly, even though the calling interface for C<setlocale()> has been
445 standardized, names of locales and the directories where the
446 configuration resides have not been.  The basic form of the name is
447 I<language_territory>B<.>I<codeset>, but the latter parts after
448 I<language> are not always present.  The I<language> and I<country>
449 are usually from the standards B<ISO 3166> and B<ISO 639>, the
450 two-letter abbreviations for the countries and the languages of the
451 world, respectively.  The I<codeset> part often mentions some B<ISO
452 8859> character set, the Latin codesets.  For example, C<ISO 8859-1>
453 is the so-called "Western European codeset" that can be used to encode
454 most Western European languages adequately.  Again, there are several
455 ways to write even the name of that one standard.  Lamentably.
456
457 Two special locales are worth particular mention: "C" and "POSIX".
458 Currently these are effectively the same locale: the difference is
459 mainly that the first one is defined by the C standard, the second by
460 the POSIX standard.  They define the B<default locale> in which
461 every program starts in the absence of locale information in its
462 environment.  (The I<default> default locale, if you will.)  Its language
463 is (American) English and its character codeset ASCII or, rarely, a
464 superset thereof (such as the "DEC Multinational Character Set
465 (DEC-MCS)").  B<Warning>. The C locale delivered by some vendors
466 may not actually exactly match what the C standard calls for.  So
467 beware.
468
469 B<NOTE>: Not all systems have the "POSIX" locale (not all systems are
470 POSIX-conformant), so use "C" when you need explicitly to specify this
471 default locale.
472
473 =head2 LOCALE PROBLEMS
474
475 You may encounter the following warning message at Perl startup:
476
477         perl: warning: Setting locale failed.
478         perl: warning: Please check that your locale settings:
479                 LC_ALL = "En_US",
480                 LANG = (unset)
481             are supported and installed on your system.
482         perl: warning: Falling back to the standard locale ("C").
483
484 This means that your locale settings had LC_ALL set to "En_US" and
485 LANG exists but has no value.  Perl tried to believe you but could not.
486 Instead, Perl gave up and fell back to the "C" locale, the default locale
487 that is supposed to work no matter what.  This usually means your locale
488 settings were wrong, they mention locales your system has never heard
489 of, or the locale installation in your system has problems (for example,
490 some system files are broken or missing).  There are quick and temporary
491 fixes to these problems, as well as more thorough and lasting fixes.
492
493 =head2 Testing for broken locales
494
495 If you are building Perl from source, the Perl test suite file
496 F<lib/locale.t> can be used to test the locales on your system.
497 Setting the environment variable C<PERL_DEBUG_FULL_TEST> to 1
498 will cause it to output detailed results.  For example, on Linux, you
499 could say
500
501  PERL_DEBUG_FULL_TEST=1 ./perl -T -Ilib lib/locale.t > locale.log 2>&1
502
503 Besides many other tests, it will test every locale it finds on your
504 system to see if they conform to the POSIX standard.  If any have
505 errors, it will include a summary near the end of the output of which
506 locales passed all its tests, and which failed, and why.
507
508 =head2 Temporarily fixing locale problems
509
510 The two quickest fixes are either to render Perl silent about any
511 locale inconsistencies or to run Perl under the default locale "C".
512
513 Perl's moaning about locale problems can be silenced by setting the
514 environment variable PERL_BADLANG to a zero value, for example "0".
515 This method really just sweeps the problem under the carpet: you tell
516 Perl to shut up even when Perl sees that something is wrong.  Do not
517 be surprised if later something locale-dependent misbehaves.
518
519 Perl can be run under the "C" locale by setting the environment
520 variable LC_ALL to "C".  This method is perhaps a bit more civilized
521 than the PERL_BADLANG approach, but setting LC_ALL (or
522 other locale variables) may affect other programs as well, not just
523 Perl.  In particular, external programs run from within Perl will see
524 these changes.  If you make the new settings permanent (read on), all
525 programs you run see the changes.  See L<"ENVIRONMENT"> for
526 the full list of relevant environment variables and L<USING LOCALES>
527 for their effects in Perl.  Effects in other programs are
528 easily deducible.  For example, the variable LC_COLLATE may well affect
529 your B<sort> program (or whatever the program that arranges "records"
530 alphabetically in your system is called).
531
532 You can test out changing these variables temporarily, and if the
533 new settings seem to help, put those settings into your shell startup
534 files.  Consult your local documentation for the exact details.  For in
535 Bourne-like shells (B<sh>, B<ksh>, B<bash>, B<zsh>):
536
537         LC_ALL=en_US.ISO8859-1
538         export LC_ALL
539
540 This assumes that we saw the locale "en_US.ISO8859-1" using the commands
541 discussed above.  We decided to try that instead of the above faulty
542 locale "En_US"--and in Cshish shells (B<csh>, B<tcsh>)
543
544         setenv LC_ALL en_US.ISO8859-1
545
546 or if you have the "env" application you can do in any shell
547
548         env LC_ALL=en_US.ISO8859-1 perl ...
549
550 If you do not know what shell you have, consult your local
551 helpdesk or the equivalent.
552
553 =head2 Permanently fixing locale problems
554
555 The slower but superior fixes are when you may be able to yourself
556 fix the misconfiguration of your own environment variables.  The
557 mis(sing)configuration of the whole system's locales usually requires
558 the help of your friendly system administrator.
559
560 First, see earlier in this document about L<Finding locales>.  That tells
561 how to find which locales are really supported--and more importantly,
562 installed--on your system.  In our example error message, environment
563 variables affecting the locale are listed in the order of decreasing
564 importance (and unset variables do not matter).  Therefore, having
565 LC_ALL set to "En_US" must have been the bad choice, as shown by the
566 error message.  First try fixing locale settings listed first.
567
568 Second, if using the listed commands you see something B<exactly>
569 (prefix matches do not count and case usually counts) like "En_US"
570 without the quotes, then you should be okay because you are using a
571 locale name that should be installed and available in your system.
572 In this case, see L<Permanently fixing your system's locale configuration>.
573
574 =head2 Permanently fixing your system's locale configuration
575
576 This is when you see something like:
577
578         perl: warning: Please check that your locale settings:
579                 LC_ALL = "En_US",
580                 LANG = (unset)
581             are supported and installed on your system.
582
583 but then cannot see that "En_US" listed by the above-mentioned
584 commands.  You may see things like "en_US.ISO8859-1", but that isn't
585 the same.  In this case, try running under a locale
586 that you can list and which somehow matches what you tried.  The
587 rules for matching locale names are a bit vague because
588 standardization is weak in this area.  See again the
589 L<Finding locales> about general rules.
590
591 =head2 Fixing system locale configuration
592
593 Contact a system administrator (preferably your own) and report the exact
594 error message you get, and ask them to read this same documentation you
595 are now reading.  They should be able to check whether there is something
596 wrong with the locale configuration of the system.  The L<Finding locales>
597 section is unfortunately a bit vague about the exact commands and places
598 because these things are not that standardized.
599
600 =head2 The localeconv function
601
602 The C<POSIX::localeconv()> function allows you to get particulars of the
603 locale-dependent numeric formatting information specified by the current
604 C<LC_NUMERIC> and C<LC_MONETARY> locales.  (If you just want the name of
605 the current locale for a particular category, use C<POSIX::setlocale()>
606 with a single parameter--see L<The setlocale function>.)
607
608         use POSIX qw(locale_h);
609
610         # Get a reference to a hash of locale-dependent info
611         $locale_values = localeconv();
612
613         # Output sorted list of the values
614         for (sort keys %$locale_values) {
615             printf "%-20s = %s\n", $_, $locale_values->{$_}
616         }
617
618 C<localeconv()> takes no arguments, and returns B<a reference to> a hash.
619 The keys of this hash are variable names for formatting, such as
620 C<decimal_point> and C<thousands_sep>.  The values are the
621 corresponding, er, values.  See L<POSIX/localeconv> for a longer
622 example listing the categories an implementation might be expected to
623 provide; some provide more and others fewer.  You don't need an
624 explicit C<use locale>, because C<localeconv()> always observes the
625 current locale.
626
627 Here's a simple-minded example program that rewrites its command-line
628 parameters as integers correctly formatted in the current locale:
629
630     use POSIX qw(locale_h);
631
632     # Get some of locale's numeric formatting parameters
633     my ($thousands_sep, $grouping) =
634             @{localeconv()}{'thousands_sep', 'grouping'};
635
636     # Apply defaults if values are missing
637     $thousands_sep = ',' unless $thousands_sep;
638
639     # grouping and mon_grouping are packed lists
640     # of small integers (characters) telling the
641     # grouping (thousand_seps and mon_thousand_seps
642     # being the group dividers) of numbers and
643     # monetary quantities.  The integers' meanings:
644     # 255 means no more grouping, 0 means repeat
645     # the previous grouping, 1-254 means use that
646     # as the current grouping.  Grouping goes from
647     # right to left (low to high digits).  In the
648     # below we cheat slightly by never using anything
649     # else than the first grouping (whatever that is).
650     if ($grouping) {
651         @grouping = unpack("C*", $grouping);
652     } else {
653         @grouping = (3);
654     }
655
656     # Format command line params for current locale
657     for (@ARGV) {
658         $_ = int;    # Chop non-integer part
659         1 while
660         s/(\d)(\d{$grouping[0]}($|$thousands_sep))/$1$thousands_sep$2/;
661         print "$_";
662     }
663     print "\n";
664
665 =head2 I18N::Langinfo
666
667 Another interface for querying locale-dependent information is the
668 C<I18N::Langinfo::langinfo()> function, available at least in Unix-like
669 systems and VMS.
670
671 The following example will import the C<langinfo()> function itself and
672 three constants to be used as arguments to C<langinfo()>: a constant for
673 the abbreviated first day of the week (the numbering starts from
674 Sunday = 1) and two more constants for the affirmative and negative
675 answers for a yes/no question in the current locale.
676
677     use I18N::Langinfo qw(langinfo ABDAY_1 YESSTR NOSTR);
678
679     my ($abday_1, $yesstr, $nostr)
680                 = map { langinfo } qw(ABDAY_1 YESSTR NOSTR);
681
682     print "$abday_1? [$yesstr/$nostr] ";
683
684 In other words, in the "C" (or English) locale the above will probably
685 print something like:
686
687     Sun? [yes/no]
688
689 See L<I18N::Langinfo> for more information.
690
691 =head1 LOCALE CATEGORIES
692
693 The following subsections describe basic locale categories.  Beyond these,
694 some combination categories allow manipulation of more than one
695 basic category at a time.  See L<"ENVIRONMENT"> for a discussion of these.
696
697 =head2 Category LC_COLLATE: Collation
698
699 In the scope of S<C<use locale>> (but not a
700 C<use locale ':not_characters'>), Perl looks to the C<LC_COLLATE>
701 environment variable to determine the application's notions on collation
702 (ordering) of characters.  For example, "b" follows "a" in Latin
703 alphabets, but where do "E<aacute>" and "E<aring>" belong?  And while
704 "color" follows "chocolate" in English, what about in traditional Spanish?
705
706 The following collations all make sense and you may meet any of them
707 if you "use locale".
708
709         A B C D E a b c d e
710         A a B b C c D d E e
711         a A b B c C d D e E
712         a b c d e A B C D E
713
714 Here is a code snippet to tell what "word"
715 characters are in the current locale, in that locale's order:
716
717         use locale;
718         print +(sort grep /\w/, map { chr } 0..255), "\n";
719
720 Compare this with the characters that you see and their order if you
721 state explicitly that the locale should be ignored:
722
723         no locale;
724         print +(sort grep /\w/, map { chr } 0..255), "\n";
725
726 This machine-native collation (which is what you get unless S<C<use
727 locale>> has appeared earlier in the same block) must be used for
728 sorting raw binary data, whereas the locale-dependent collation of the
729 first example is useful for natural text.
730
731 As noted in L<USING LOCALES>, C<cmp> compares according to the current
732 collation locale when C<use locale> is in effect, but falls back to a
733 char-by-char comparison for strings that the locale says are equal. You
734 can use C<POSIX::strcoll()> if you don't want this fall-back:
735
736         use POSIX qw(strcoll);
737         $equal_in_locale =
738             !strcoll("space and case ignored", "SpaceAndCaseIgnored");
739
740 C<$equal_in_locale> will be true if the collation locale specifies a
741 dictionary-like ordering that ignores space characters completely and
742 which folds case.
743
744 Perl only supports single-byte locales for C<LC_COLLATE>.  This means
745 that a UTF-8 locale likely will just give you machine-native ordering.
746 Use L<Unicode::Collate> for the full implementation of the Unicode
747 Collation Algorithm.
748
749 If you have a single string that you want to check for "equality in
750 locale" against several others, you might think you could gain a little
751 efficiency by using C<POSIX::strxfrm()> in conjunction with C<eq>:
752
753         use POSIX qw(strxfrm);
754         $xfrm_string = strxfrm("Mixed-case string");
755         print "locale collation ignores spaces\n"
756             if $xfrm_string eq strxfrm("Mixed-casestring");
757         print "locale collation ignores hyphens\n"
758             if $xfrm_string eq strxfrm("Mixedcase string");
759         print "locale collation ignores case\n"
760             if $xfrm_string eq strxfrm("mixed-case string");
761
762 C<strxfrm()> takes a string and maps it into a transformed string for use
763 in char-by-char comparisons against other transformed strings during
764 collation.  "Under the hood", locale-affected Perl comparison operators
765 call C<strxfrm()> for both operands, then do a char-by-char
766 comparison of the transformed strings.  By calling C<strxfrm()> explicitly
767 and using a non locale-affected comparison, the example attempts to save
768 a couple of transformations.  But in fact, it doesn't save anything: Perl
769 magic (see L<perlguts/Magic Variables>) creates the transformed version of a
770 string the first time it's needed in a comparison, then keeps this version around
771 in case it's needed again.  An example rewritten the easy way with
772 C<cmp> runs just about as fast.  It also copes with null characters
773 embedded in strings; if you call C<strxfrm()> directly, it treats the first
774 null it finds as a terminator.  don't expect the transformed strings
775 it produces to be portable across systems--or even from one revision
776 of your operating system to the next.  In short, don't call C<strxfrm()>
777 directly: let Perl do it for you.
778
779 Note: C<use locale> isn't shown in some of these examples because it isn't
780 needed: C<strcoll()> and C<strxfrm()> are POSIX functions
781 which use the standard system-supplied C<libc> functions that
782 always obey the current C<LC_COLLATE> locale.
783
784 =head2 Category LC_CTYPE: Character Types
785
786 In the scope of S<C<use locale>> (but not a
787 C<use locale ':not_characters'>), Perl obeys the C<LC_CTYPE> locale
788 setting.  This controls the application's notion of which characters are
789 alphabetic.  This affects Perl's C<\w> regular expression metanotation,
790 which stands for alphanumeric characters--that is, alphabetic,
791 numeric, and including other special characters such as the underscore or
792 hyphen.  (Consult L<perlre> for more information about
793 regular expressions.)  Thanks to C<LC_CTYPE>, depending on your locale
794 setting, characters like "E<aelig>", "E<eth>", "E<szlig>", and
795 "E<oslash>" may be understood as C<\w> characters.
796
797 The C<LC_CTYPE> locale also provides the map used in transliterating
798 characters between lower and uppercase.  This affects the case-mapping
799 functions--C<fc()>, C<lc()>, C<lcfirst()>, C<uc()>, and C<ucfirst()>; case-mapping
800 interpolation with C<\F>, C<\l>, C<\L>, C<\u>, or C<\U> in double-quoted
801 strings and C<s///> substitutions; and case-independent regular expression
802 pattern matching using the C<i> modifier.
803
804 Finally, C<LC_CTYPE> affects the POSIX character-class test
805 functions--C<POSIX::isalpha()>, C<POSIX::islower()>, and so on.  For
806 example, if you move from the "C" locale to a 7-bit Scandinavian one,
807 you may find--possibly to your surprise--that "|" moves from the
808 C<POSIX::ispunct()> class to C<POSIX::isalpha()>.
809 Unfortunately, this creates big problems for regular expressions. "|" still
810 means alternation even though it matches C<\w>.
811
812 Starting in v5.20, Perl supports UTF-8 locales for C<LC_CTYPE>, but
813 otherwise Perl only supports single-byte locales, such as the ISO 8859
814 series.  This means that wide character locales, for example for Asian
815 languages, are not supported.  The UTF-8 locale support is actually a
816 superset of POSIX locales, because it is really full Unicode behavior
817 as if no locale were in effect at all (except for tainting; see
818 L</SECURITY>).  POSIX locales, even UTF-8 ones,
819 are lacking certain concepts in Unicode, such as the idea that changing
820 the case of a character could expand to be more than one character.
821 Perl in a UTF-8 locale, will give you that expansion.  Prior to v5.20,
822 Perl treated a UTF-8 locale on some platforms like an ISO 8859-1 one,
823 with some restrictions, and on other platforms more like the "C" locale.
824 For releases v5.16 and v5.18, C<S<use locale 'not_characters>> could be
825 used as a workaround for this (see L</Unicode and UTF-8>).
826
827 Note that there are quite a few things that are unaffected by the
828 current locale.  All the escape sequences for particular characters,
829 C<\n> for example, always mean the platform's native one.  This means,
830 for example, that C<\N> in regular expressions (every character
831 but new-line) works on the platform character set.
832
833 B<Note:> A broken or malicious C<LC_CTYPE> locale definition may result
834 in clearly ineligible characters being considered to be alphanumeric by
835 your application.  For strict matching of (mundane) ASCII letters and
836 digits--for example, in command strings--locale-aware applications
837 should use C<\w> with the C</a> regular expression modifier.  See L<"SECURITY">.
838
839 =head2 Category LC_NUMERIC: Numeric Formatting
840
841 After a proper C<POSIX::setlocale()> call, and within the scope of one
842 of the C<use locale> variants, Perl obeys the C<LC_NUMERIC>
843 locale information, which controls an application's idea of how numbers
844 should be formatted for human readability.
845 In most implementations the only effect is to
846 change the character used for the decimal point--perhaps from "."  to ",".
847 The functions aren't aware of such niceties as thousands separation and
848 so on. (See L<The localeconv function> if you care about these things.)
849
850  use POSIX qw(strtod setlocale LC_NUMERIC);
851  use locale;
852
853  setlocale LC_NUMERIC, "";
854
855  $n = 5/2;   # Assign numeric 2.5 to $n
856
857  $a = " $n"; # Locale-dependent conversion to string
858
859  print "half five is $n\n";       # Locale-dependent output
860
861  printf "half five is %g\n", $n;  # Locale-dependent output
862
863  print "DECIMAL POINT IS COMMA\n"
864           if $n == (strtod("2,5"))[0]; # Locale-dependent conversion
865
866 See also L<I18N::Langinfo> and C<RADIXCHAR>.
867
868 =head2 Category LC_MONETARY: Formatting of monetary amounts
869
870 The C standard defines the C<LC_MONETARY> category, but not a function
871 that is affected by its contents.  (Those with experience of standards
872 committees will recognize that the working group decided to punt on the
873 issue.)  Consequently, Perl essentially takes no notice of it.  If you
874 really want to use C<LC_MONETARY>, you can query its contents--see
875 L<The localeconv function>--and use the information that it returns in your
876 application's own formatting of currency amounts.  However, you may well
877 find that the information, voluminous and complex though it may be, still
878 does not quite meet your requirements: currency formatting is a hard nut
879 to crack.
880
881 See also L<I18N::Langinfo> and C<CRNCYSTR>.
882
883 =head2 LC_TIME
884
885 Output produced by C<POSIX::strftime()>, which builds a formatted
886 human-readable date/time string, is affected by the current C<LC_TIME>
887 locale.  Thus, in a French locale, the output produced by the C<%B>
888 format element (full month name) for the first month of the year would
889 be "janvier".  Here's how to get a list of long month names in the
890 current locale:
891
892         use POSIX qw(strftime);
893         for (0..11) {
894             $long_month_name[$_] =
895                 strftime("%B", 0, 0, 0, 1, $_, 96);
896         }
897
898 Note: C<use locale> isn't needed in this example: C<strftime()> is a POSIX
899 function which uses the standard system-supplied C<libc> function that
900 always obeys the current C<LC_TIME> locale.
901
902 See also L<I18N::Langinfo> and C<ABDAY_1>..C<ABDAY_7>, C<DAY_1>..C<DAY_7>,
903 C<ABMON_1>..C<ABMON_12>, and C<ABMON_1>..C<ABMON_12>.
904
905 =head2 Other categories
906
907 The remaining locale categories are not currently used by Perl itself.
908 But again note that things Perl interacts with may use these, including
909 extensions outside the standard Perl distribution, and by the
910 operating system and its utilities.  Note especially that the string
911 value of C<$!> and the error messages given by external utilities may
912 be changed by C<LC_MESSAGES>.  If you want to have portable error
913 codes, use C<%!>.  See L<Errno>.
914
915 =head1 SECURITY
916
917 Although the main discussion of Perl security issues can be found in
918 L<perlsec>, a discussion of Perl's locale handling would be incomplete
919 if it did not draw your attention to locale-dependent security issues.
920 Locales--particularly on systems that allow unprivileged users to
921 build their own locales--are untrustworthy.  A malicious (or just plain
922 broken) locale can make a locale-aware application give unexpected
923 results.  Here are a few possibilities:
924
925 =over 4
926
927 =item *
928
929 Regular expression checks for safe file names or mail addresses using
930 C<\w> may be spoofed by an C<LC_CTYPE> locale that claims that
931 characters such as "E<gt>" and "|" are alphanumeric.
932
933 =item *
934
935 String interpolation with case-mapping, as in, say, C<$dest =
936 "C:\U$name.$ext">, may produce dangerous results if a bogus LC_CTYPE
937 case-mapping table is in effect.
938
939 =item *
940
941 A sneaky C<LC_COLLATE> locale could result in the names of students with
942 "D" grades appearing ahead of those with "A"s.
943
944 =item *
945
946 An application that takes the trouble to use information in
947 C<LC_MONETARY> may format debits as if they were credits and vice versa
948 if that locale has been subverted.  Or it might make payments in US
949 dollars instead of Hong Kong dollars.
950
951 =item *
952
953 The date and day names in dates formatted by C<strftime()> could be
954 manipulated to advantage by a malicious user able to subvert the
955 C<LC_DATE> locale.  ("Look--it says I wasn't in the building on
956 Sunday.")
957
958 =back
959
960 Such dangers are not peculiar to the locale system: any aspect of an
961 application's environment which may be modified maliciously presents
962 similar challenges.  Similarly, they are not specific to Perl: any
963 programming language that allows you to write programs that take
964 account of their environment exposes you to these issues.
965
966 Perl cannot protect you from all possibilities shown in the
967 examples--there is no substitute for your own vigilance--but, when
968 C<use locale> is in effect, Perl uses the tainting mechanism (see
969 L<perlsec>) to mark string results that become locale-dependent, and
970 which may be untrustworthy in consequence.  Here is a summary of the
971 tainting behavior of operators and functions that may be affected by
972 the locale:
973
974 =over 4
975
976 =item  *
977
978 B<Comparison operators> (C<lt>, C<le>, C<ge>, C<gt> and C<cmp>):
979
980 Scalar true/false (or less/equal/greater) result is never tainted.
981
982 =item  *
983
984 B<Case-mapping interpolation> (with C<\l>, C<\L>, C<\u>, C<\U>, or C<\F>)
985
986 Result string containing interpolated material is tainted if
987 C<use locale> (but not S<C<use locale ':not_characters'>>) is in effect.
988
989 =item  *
990
991 B<Matching operator> (C<m//>):
992
993 Scalar true/false result never tainted.
994
995 All subpatterns, either delivered as a list-context result or as C<$1>
996 I<etc>., are tainted if C<use locale> (but not
997 S<C<use locale ':not_characters'>>) is in effect, and the subpattern
998 regular expression is matched case-insensitively (C</i>) or contains a
999 locale-dependent construct.  These constructs include C<\w>
1000 (to match an alphanumeric character), C<\W> (non-alphanumeric
1001 character), C<\s> (whitespace character), C<\S> (non whitespace
1002 character), and the POSIX character classes, such as C<[:alpha:]> (see
1003 L<perlrecharclass/POSIX Character Classes>).
1004 The matched-pattern variables, C<$&>, C<$`> (pre-match), C<$'>
1005 (post-match), and C<$+> (last match) also are tainted.
1006 (Note that currently there are some bugs where not everything that
1007 should be tainted gets tainted in all circumstances.)
1008
1009 =item  *
1010
1011 B<Substitution operator> (C<s///>):
1012
1013 Has the same behavior as the match operator.  Also, the left
1014 operand of C<=~> becomes tainted when C<use locale>
1015 (but not S<C<use locale ':not_characters'>>) is in effect if modified as
1016 a result of a substitution based on a regular
1017 expression match involving any of the things mentioned in the previous
1018 item, or of case-mapping, such as C<\l>, C<\L>,C<\u>, C<\U>, or C<\F>.
1019
1020 =item *
1021
1022 B<Output formatting functions> (C<printf()> and C<write()>):
1023
1024 Results are never tainted because otherwise even output from print,
1025 for example C<print(1/7)>, should be tainted if C<use locale> is in
1026 effect.
1027
1028 =item *
1029
1030 B<Case-mapping functions> (C<lc()>, C<lcfirst()>, C<uc()>, C<ucfirst()>):
1031
1032 Results are tainted if C<use locale> (but not
1033 S<C<use locale ':not_characters'>>) is in effect.
1034
1035 =item *
1036
1037 B<POSIX locale-dependent functions> (C<localeconv()>, C<strcoll()>,
1038 C<strftime()>, C<strxfrm()>):
1039
1040 Results are never tainted.
1041
1042 =item *
1043
1044 B<POSIX character class tests> (C<POSIX::isalnum()>,
1045 C<POSIX::isalpha()>, C<POSIX::isdigit()>, C<POSIX::isgraph()>,
1046 C<POSIX::islower()>, C<POSIX::isprint()>, C<POSIX::ispunct()>,
1047 C<POSIX::isspace()>, C<POSIX::isupper()>, C<POSIX::isxdigit()>):
1048
1049 True/false results are never tainted.
1050
1051 =back
1052
1053 Three examples illustrate locale-dependent tainting.
1054 The first program, which ignores its locale, won't run: a value taken
1055 directly from the command line may not be used to name an output file
1056 when taint checks are enabled.
1057
1058         #/usr/local/bin/perl -T
1059         # Run with taint checking
1060
1061         # Command line sanity check omitted...
1062         $tainted_output_file = shift;
1063
1064         open(F, ">$tainted_output_file")
1065             or warn "Open of $tainted_output_file failed: $!\n";
1066
1067 The program can be made to run by "laundering" the tainted value through
1068 a regular expression: the second example--which still ignores locale
1069 information--runs, creating the file named on its command line
1070 if it can.
1071
1072         #/usr/local/bin/perl -T
1073
1074         $tainted_output_file = shift;
1075         $tainted_output_file =~ m%[\w/]+%;
1076         $untainted_output_file = $&;
1077
1078         open(F, ">$untainted_output_file")
1079             or warn "Open of $untainted_output_file failed: $!\n";
1080
1081 Compare this with a similar but locale-aware program:
1082
1083         #/usr/local/bin/perl -T
1084
1085         $tainted_output_file = shift;
1086         use locale;
1087         $tainted_output_file =~ m%[\w/]+%;
1088         $localized_output_file = $&;
1089
1090         open(F, ">$localized_output_file")
1091             or warn "Open of $localized_output_file failed: $!\n";
1092
1093 This third program fails to run because C<$&> is tainted: it is the result
1094 of a match involving C<\w> while C<use locale> is in effect.
1095
1096 =head1 ENVIRONMENT
1097
1098 =over 12
1099
1100 =item PERL_BADLANG
1101
1102 A string that can suppress Perl's warning about failed locale settings
1103 at startup.  Failure can occur if the locale support in the operating
1104 system is lacking (broken) in some way--or if you mistyped the name of
1105 a locale when you set up your environment.  If this environment
1106 variable is absent, or has a value that does not evaluate to integer
1107 zero--that is, "0" or ""-- Perl will complain about locale setting
1108 failures.
1109
1110 B<NOTE>: PERL_BADLANG only gives you a way to hide the warning message.
1111 The message tells about some problem in your system's locale support,
1112 and you should investigate what the problem is.
1113
1114 =back
1115
1116 The following environment variables are not specific to Perl: They are
1117 part of the standardized (ISO C, XPG4, POSIX 1.c) C<setlocale()> method
1118 for controlling an application's opinion on data.  Windows is non-POSIX,
1119 but Perl arranges for the following to work as described anyway.
1120
1121 =over 12
1122
1123 =item LC_ALL
1124
1125 C<LC_ALL> is the "override-all" locale environment variable. If
1126 set, it overrides all the rest of the locale environment variables.
1127
1128 =item LANGUAGE
1129
1130 B<NOTE>: C<LANGUAGE> is a GNU extension, it affects you only if you
1131 are using the GNU libc.  This is the case if you are using e.g. Linux.
1132 If you are using "commercial" Unixes you are most probably I<not>
1133 using GNU libc and you can ignore C<LANGUAGE>.
1134
1135 However, in the case you are using C<LANGUAGE>: it affects the
1136 language of informational, warning, and error messages output by
1137 commands (in other words, it's like C<LC_MESSAGES>) but it has higher
1138 priority than C<LC_ALL>.  Moreover, it's not a single value but
1139 instead a "path" (":"-separated list) of I<languages> (not locales).
1140 See the GNU C<gettext> library documentation for more information.
1141
1142 =item LC_CTYPE
1143
1144 In the absence of C<LC_ALL>, C<LC_CTYPE> chooses the character type
1145 locale.  In the absence of both C<LC_ALL> and C<LC_CTYPE>, C<LANG>
1146 chooses the character type locale.
1147
1148 =item LC_COLLATE
1149
1150 In the absence of C<LC_ALL>, C<LC_COLLATE> chooses the collation
1151 (sorting) locale.  In the absence of both C<LC_ALL> and C<LC_COLLATE>,
1152 C<LANG> chooses the collation locale.
1153
1154 =item LC_MONETARY
1155
1156 In the absence of C<LC_ALL>, C<LC_MONETARY> chooses the monetary
1157 formatting locale.  In the absence of both C<LC_ALL> and C<LC_MONETARY>,
1158 C<LANG> chooses the monetary formatting locale.
1159
1160 =item LC_NUMERIC
1161
1162 In the absence of C<LC_ALL>, C<LC_NUMERIC> chooses the numeric format
1163 locale.  In the absence of both C<LC_ALL> and C<LC_NUMERIC>, C<LANG>
1164 chooses the numeric format.
1165
1166 =item LC_TIME
1167
1168 In the absence of C<LC_ALL>, C<LC_TIME> chooses the date and time
1169 formatting locale.  In the absence of both C<LC_ALL> and C<LC_TIME>,
1170 C<LANG> chooses the date and time formatting locale.
1171
1172 =item LANG
1173
1174 C<LANG> is the "catch-all" locale environment variable. If it is set, it
1175 is used as the last resort after the overall C<LC_ALL> and the
1176 category-specific C<LC_...>.
1177
1178 =back
1179
1180 =head2 Examples
1181
1182 The LC_NUMERIC controls the numeric output:
1183
1184    use locale;
1185    use POSIX qw(locale_h); # Imports setlocale() and the LC_ constants.
1186    setlocale(LC_NUMERIC, "fr_FR") or die "Pardon";
1187    printf "%g\n", 1.23; # If the "fr_FR" succeeded, probably shows 1,23.
1188
1189 and also how strings are parsed by C<POSIX::strtod()> as numbers:
1190
1191    use locale;
1192    use POSIX qw(locale_h strtod);
1193    setlocale(LC_NUMERIC, "de_DE") or die "Entschuldigung";
1194    my $x = strtod("2,34") + 5;
1195    print $x, "\n"; # Probably shows 7,34.
1196
1197 =head1 NOTES
1198
1199 =head2 String C<eval> and C<LC_NUMERIC>
1200
1201 A string L<eval|perlfunc/eval EXPR> parses its expression as standard
1202 Perl.  It is therefore expecting the decimal point to be a dot.  If
1203 C<LC_NUMERIC> is set to have this be a comma instead, the parsing will
1204 be confused, perhaps silently.
1205
1206  use locale;
1207  use POSIX qw(locale_h);
1208  setlocale(LC_NUMERIC, "fr_FR") or die "Pardon";
1209  my $a = 1.2;
1210  print eval "$a + 1.5";
1211  print "\n";
1212
1213 prints C<13,5>.  This is because in that locale, the comma is the
1214 decimal point character.  The C<eval> thus expands to:
1215
1216  eval "1,2 + 1.5"
1217
1218 and the result is not what you likely expected.  No warnings are
1219 generated.  If you do string C<eval>'s within the scope of
1220 S<C<use locale>>, you should instead change the C<eval> line to do
1221 something like:
1222
1223  print eval "no locale; $a + 1.5";
1224
1225 This prints C<2.7>.
1226
1227 =head2 Backward compatibility
1228
1229 Versions of Perl prior to 5.004 B<mostly> ignored locale information,
1230 generally behaving as if something similar to the C<"C"> locale were
1231 always in force, even if the program environment suggested otherwise
1232 (see L<The setlocale function>).  By default, Perl still behaves this
1233 way for backward compatibility.  If you want a Perl application to pay
1234 attention to locale information, you B<must> use the S<C<use locale>>
1235 pragma (see L<The use locale pragma>) or, in the unlikely event
1236 that you want to do so for just pattern matching, the
1237 C</l> regular expression modifier (see L<perlre/Character set
1238 modifiers>) to instruct it to do so.
1239
1240 Versions of Perl from 5.002 to 5.003 did use the C<LC_CTYPE>
1241 information if available; that is, C<\w> did understand what
1242 were the letters according to the locale environment variables.
1243 The problem was that the user had no control over the feature:
1244 if the C library supported locales, Perl used them.
1245
1246 =head2 I18N:Collate obsolete
1247
1248 In versions of Perl prior to 5.004, per-locale collation was possible
1249 using the C<I18N::Collate> library module.  This module is now mildly
1250 obsolete and should be avoided in new applications.  The C<LC_COLLATE>
1251 functionality is now integrated into the Perl core language: One can
1252 use locale-specific scalar data completely normally with C<use locale>,
1253 so there is no longer any need to juggle with the scalar references of
1254 C<I18N::Collate>.
1255
1256 =head2 Sort speed and memory use impacts
1257
1258 Comparing and sorting by locale is usually slower than the default
1259 sorting; slow-downs of two to four times have been observed.  It will
1260 also consume more memory: once a Perl scalar variable has participated
1261 in any string comparison or sorting operation obeying the locale
1262 collation rules, it will take 3-15 times more memory than before.  (The
1263 exact multiplier depends on the string's contents, the operating system
1264 and the locale.) These downsides are dictated more by the operating
1265 system's implementation of the locale system than by Perl.
1266
1267 =head2 Freely available locale definitions
1268
1269 The Unicode CLDR project extracts the POSIX portion of many of its
1270 locales, available at
1271
1272   http://unicode.org/Public/cldr/latest/
1273
1274 There is a large collection of locale definitions at:
1275
1276   http://std.dkuug.dk/i18n/WG15-collection/locales/
1277
1278 You should be aware that it is
1279 unsupported, and is not claimed to be fit for any purpose.  If your
1280 system allows installation of arbitrary locales, you may find the
1281 definitions useful as they are, or as a basis for the development of
1282 your own locales.
1283
1284 =head2 I18n and l10n
1285
1286 "Internationalization" is often abbreviated as B<i18n> because its first
1287 and last letters are separated by eighteen others.  (You may guess why
1288 the internalin ... internaliti ... i18n tends to get abbreviated.)  In
1289 the same way, "localization" is often abbreviated to B<l10n>.
1290
1291 =head2 An imperfect standard
1292
1293 Internationalization, as defined in the C and POSIX standards, can be
1294 criticized as incomplete, ungainly, and having too large a granularity.
1295 (Locales apply to a whole process, when it would arguably be more useful
1296 to have them apply to a single thread, window group, or whatever.)  They
1297 also have a tendency, like standards groups, to divide the world into
1298 nations, when we all know that the world can equally well be divided
1299 into bankers, bikers, gamers, and so on.
1300
1301 =head1 Unicode and UTF-8
1302
1303 The support of Unicode is new starting from Perl version v5.6, and more fully
1304 implemented in versions v5.8 and later.  See L<perluniintro>.
1305
1306 Starting in Perl v5.20, UTF-8 locales are supported in Perl, except for
1307 C<LC_COLLATE> (use L<Unicode::Collate> instead).  If you have Perl v5.16
1308 or v5.18 and can't upgrade, you can use
1309
1310     use locale ':not_characters';
1311
1312 When this form of the pragma is used, only the non-character portions of
1313 locales are used by Perl, for example C<LC_NUMERIC>.  Perl assumes that
1314 you have translated all the characters it is to operate on into Unicode
1315 (actually the platform's native character set (ASCII or EBCDIC) plus
1316 Unicode).  For data in files, this can conveniently be done by also
1317 specifying
1318
1319     use open ':locale';
1320
1321 This pragma arranges for all inputs from files to be translated into
1322 Unicode from the current locale as specified in the environment (see
1323 L</ENVIRONMENT>), and all outputs to files to be translated back
1324 into the locale.  (See L<open>).  On a per-filehandle basis, you can
1325 instead use the L<PerlIO::locale> module, or the L<Encode::Locale>
1326 module, both available from CPAN.  The latter module also has methods to
1327 ease the handling of C<ARGV> and environment variables, and can be used
1328 on individual strings.  If you know that all your locales will be
1329 UTF-8, as many are these days, you can use the L<B<-C>|perlrun/-C>
1330 command line switch.
1331
1332 This form of the pragma allows essentially seamless handling of locales
1333 with Unicode.  The collation order will be by Unicode code point order.
1334 It is strongly
1335 recommended that when you need to order and sort strings that you use
1336 the standard module L<Unicode::Collate> which gives much better results
1337 in many instances than you can get with the old-style locale handling.
1338
1339 All the modules and switches just described can be used in v5.20 with
1340 just plain C<use locale>, and, should the input locales not be UTF-8,
1341 you'll get the less than ideal behavior, described below, that you get
1342 with pre-v5.16 Perls, or when you use the locale pragma without the
1343 C<:not_characters> parameter in v5.16 and v5.18.  If you are using
1344 exclusively UTF-8 locales in v5.20 and higher, the rest of this section
1345 does not apply to you.
1346
1347 There are two cases, multi-byte and single-byte locales.  First
1348 multi-byte:
1349
1350 The only multi-byte (or wide character) locale that Perl is ever likely
1351 to support is UTF-8.  This is due to the difficulty of implementation,
1352 the fact that high quality UTF-8 locales are now published for every
1353 area of the world (L<http://unicode.org/Public/cldr/latest/>), and that
1354 failing all that you can use the L<Encode> module to translate to/from
1355 your locale.  So, you'll have to do one of those things if you're using
1356 one of these locales, such as Big5 or Shift JIS.  For UTF-8 locales, in
1357 Perls (pre v5.20) that don't have full UTF-8 locale support, they may
1358 work reasonably well (depending on your C library implementation)
1359 simply because both
1360 they and Perl store characters that take up multiple bytes the same way.
1361 However, some, if not most, C library implementations may not process
1362 the characters in the upper half of the Latin-1 range (128 - 255)
1363 properly under LC_CTYPE.  To see if a character is a particular type
1364 under a locale, Perl uses the functions like C<isalnum()>.  Your C
1365 library may not work for UTF-8 locales with those functions, instead
1366 only working under the newer wide library functions like C<iswalnum()>.
1367 However, they are treated like single-byte locales, and will have the
1368 restrictions described below.
1369
1370 For single-byte locales,
1371 Perl generally takes the tack to use locale rules on code points that can fit
1372 in a single byte, and Unicode rules for those that can't (though this
1373 isn't uniformly applied, see the note at the end of this section).  This
1374 prevents many problems in locales that aren't UTF-8.  Suppose the locale
1375 is ISO8859-7, Greek.  The character at 0xD7 there is a capital Chi. But
1376 in the ISO8859-1 locale, Latin1, it is a multiplication sign.  The POSIX
1377 regular expression character class C<[[:alpha:]]> will magically match
1378 0xD7 in the Greek locale but not in the Latin one.
1379
1380 However, there are places where this breaks down.  Certain Perl constructs are
1381 for Unicode only, such as C<\p{Alpha}>.  They assume that 0xD7 always has its
1382 Unicode meaning (or the equivalent on EBCDIC platforms).  Since Latin1 is a
1383 subset of Unicode and 0xD7 is the multiplication sign in both Latin1 and
1384 Unicode, C<\p{Alpha}> will never match it, regardless of locale.  A similar
1385 issue occurs with C<\N{...}>.  Prior to v5.20, It is therefore a bad
1386 idea to use C<\p{}> or
1387 C<\N{}> under plain C<use locale>--I<unless> you can guarantee that the
1388 locale will be a ISO8859-1.  Use POSIX character classes instead.
1389
1390 Another problem with this approach is that operations that cross the
1391 single byte/multiple byte boundary are not well-defined, and so are
1392 disallowed.  (This boundary is between the codepoints at 255/256.).
1393 For example, lower casing LATIN CAPITAL LETTER Y WITH DIAERESIS (U+0178)
1394 should return LATIN SMALL LETTER Y WITH DIAERESIS (U+00FF).  But in the
1395 Greek locale, for example, there is no character at 0xFF, and Perl
1396 has no way of knowing what the character at 0xFF is really supposed to
1397 represent.  Thus it disallows the operation.  In this mode, the
1398 lowercase of U+0178 is itself.
1399
1400 The same problems ensue if you enable automatic UTF-8-ification of your
1401 standard file handles, default C<open()> layer, and C<@ARGV> on non-ISO8859-1,
1402 non-UTF-8 locales (by using either the B<-C> command line switch or the
1403 C<PERL_UNICODE> environment variable; see L<perlrun>).
1404 Things are read in as UTF-8, which would normally imply a Unicode
1405 interpretation, but the presence of a locale causes them to be interpreted
1406 in that locale instead.  For example, a 0xD7 code point in the Unicode
1407 input, which should mean the multiplication sign, won't be interpreted by
1408 Perl that way under the Greek locale.  This is not a problem
1409 I<provided> you make certain that all locales will always and only be either
1410 an ISO8859-1, or, if you don't have a deficient C library, a UTF-8 locale.
1411
1412 Still another problem is that this approach can lead to two code
1413 points meaning the same character.  Thus in a Greek locale, both U+03A7
1414 and U+00D7 are GREEK CAPITAL LETTER CHI.
1415
1416 Vendor locales are notoriously buggy, and it is difficult for Perl to test
1417 its locale-handling code because this interacts with code that Perl has no
1418 control over; therefore the locale-handling code in Perl may be buggy as
1419 well.  (However, the Unicode-supplied locales should be better, and
1420 there is a feed back mechanism to correct any problems.  See
1421 L</Freely available locale definitions>.)
1422
1423 If you have Perl v5.16, the problems mentioned above go away if you use
1424 the C<:not_characters> parameter to the locale pragma (except for vendor
1425 bugs in the non-character portions).  If you don't have v5.16, and you
1426 I<do> have locales that work, using them may be worthwhile for certain
1427 specific purposes, as long as you keep in mind the gotchas already
1428 mentioned.  For example, if the collation for your locales works, it
1429 runs faster under locales than under L<Unicode::Collate>; and you gain
1430 access to such things as the local currency symbol and the names of the
1431 months and days of the week.  (But to hammer home the point, in v5.16,
1432 you get this access without the downsides of locales by using the
1433 C<:not_characters> form of the pragma.)
1434
1435 Note: The policy of using locale rules for code points that can fit in a
1436 byte, and Unicode rules for those that can't is not uniformly applied.
1437 Pre-v5.12, it was somewhat haphazard; in v5.12 it was applied fairly
1438 consistently to regular expression matching except for bracketed
1439 character classes; in v5.14 it was extended to all regex matches; and in
1440 v5.16 to the casing operations such as C<"\L"> and C<uc()>.  For
1441 collation, in all releases, the system's C<strxfrm()> function is called,
1442 and whatever it does is what you get.
1443
1444 =head1 BUGS
1445
1446 =head2 Broken systems
1447
1448 In certain systems, the operating system's locale support
1449 is broken and cannot be fixed or used by Perl.  Such deficiencies can
1450 and will result in mysterious hangs and/or Perl core dumps when
1451 C<use locale> is in effect.  When confronted with such a system,
1452 please report in excruciating detail to <F<perlbug@perl.org>>, and
1453 also contact your vendor: bug fixes may exist for these problems
1454 in your operating system.  Sometimes such bug fixes are called an
1455 operating system upgrade.  If you have the source for Perl, include in
1456 the perlbug email the output of the test described above in L</Testing
1457 for broken locales>.
1458
1459 =head1 SEE ALSO
1460
1461 L<I18N::Langinfo>, L<perluniintro>, L<perlunicode>, L<open>,
1462 L<POSIX/isalnum>, L<POSIX/isalpha>,
1463 L<POSIX/isdigit>, L<POSIX/isgraph>, L<POSIX/islower>,
1464 L<POSIX/isprint>, L<POSIX/ispunct>, L<POSIX/isspace>,
1465 L<POSIX/isupper>, L<POSIX/isxdigit>, L<POSIX/localeconv>,
1466 L<POSIX/setlocale>, L<POSIX/strcoll>, L<POSIX/strftime>,
1467 L<POSIX/strtod>, L<POSIX/strxfrm>.
1468
1469 For special considerations when Perl is embedded in a C program,
1470 see L<perlembed/Using embedded Perl with POSIX locales>.
1471
1472 =head1 HISTORY
1473
1474 Jarkko Hietaniemi's original F<perli18n.pod> heavily hacked by Dominic
1475 Dunlop, assisted by the perl5-porters.  Prose worked over a bit by
1476 Tom Christiansen, and updated by Perl 5 porters.