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