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