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