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