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