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