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