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