.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "DateTime::Locale 3"
.TH DateTime::Locale 3 "2016-06-26" "perl v5.16.3" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
DateTime::Locale \- Localization support for DateTime.pm
.SH "VERSION"
.IX Header "VERSION"
version 1.05
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use DateTime::Locale;
\&
\&  my $loc = DateTime::Locale\->load(\*(Aqen\-GB\*(Aq);
\&
\&  print $loc\->native_locale_name, "\en", $loc\->datetime_format_long, "\en";
\&
\&  # but mostly just things like ...
\&
\&  my $dt = DateTime\->now( locale => \*(Aqfr\*(Aq );
\&  print "Aujourd\*(Aqhui le mois est " . $dt\->month_name, "\en";
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
DateTime::Locale is primarily a factory for the various locale subclasses. It
also provides some functions for getting information on all the available
locales.
.PP
If you want to know what methods are available for locale objects, then please
read the \f(CW\*(C`DateTime::Locale::FromData\*(C'\fR documentation.
.SH "USAGE"
.IX Header "USAGE"
This module provides the following class methods:
.ie n .SS "DateTime::Locale\->load( $locale_code | $locale_name )"
.el .SS "DateTime::Locale\->load( \f(CW$locale_code\fP | \f(CW$locale_name\fP )"
.IX Subsection "DateTime::Locale->load( $locale_code | $locale_name )"
Returns the locale object for the specified locale code or name \- see the
\&\f(CW\*(C`DateTime::Locale::Catalog\*(C'\fR documentation for the list of available codes and
names. The name provided may be either the English or native name.
.PP
If the requested locale is not found, a fallback search takes place to
find a suitable replacement.
.PP
The fallback search order is:
.PP
.Vb 5
\&  {language}\-{script}\-{territory}
\&  {language}\-{script}
\&  {language}\-{territory}\-{variant}
\&  {language}\-{territory}
\&  {language}
.Ve
.PP
Eg. For the locale code \f(CW\*(C`es\-XX\-UNKNOWN\*(C'\fR the fallback search would be:
.PP
.Vb 4
\&  es\-XX\-UNKNOWN   # Fails \- no such locale
\&  es\-XX           # Fails \- no such locale
\&  es              # Found \- the es locale is returned as the
\&                  # closest match to the requested id
.Ve
.PP
Eg. For the locale code \f(CW\*(C`es\-Latn\-XX\*(C'\fR the fallback search would be:
.PP
.Vb 5
\&  es\-Latn\-XX      # Fails \- no such locale
\&  es\-Latn         # Fails \- no such locale
\&  es\-XX           # Fails \- no such locale
\&  es              # Found \- the es locale is returned as the
\&                  # closest match to the requested id
.Ve
.PP
If no suitable replacement is found, then an exception is thrown.
.PP
The loaded locale is cached, so that \fBlocale objects may be
singletons\fR. Calling \f(CW\*(C`DateTime::Locale\->register()\*(C'\fR, \f(CW\*(C`DateTime::Locale\->add_aliases()\*(C'\fR, or \f(CW\*(C`DateTime::Locale\->remove_alias()\*(C'\fR
clears the cache.
.SS "DateTime::Locale\->codes"
.IX Subsection "DateTime::Locale->codes"
.Vb 2
\&  my @codes = DateTime::Locale\->codes;
\&  my $codes = DateTime::Locale\->codes;
.Ve
.PP
Returns an unsorted list of the available locale codes, or an array reference if
called in a scalar context. This list does not include aliases.
.SS "DateTime::Locale\->names"
.IX Subsection "DateTime::Locale->names"
.Vb 2
\&  my @names = DateTime::Locale\->names;
\&  my $names = DateTime::Locale\->names;
.Ve
.PP
Returns an unsorted list of the available locale names in English, or an array
reference if called in a scalar context.
.SS "DateTime::Locale\->native_names"
.IX Subsection "DateTime::Locale->native_names"
.Vb 2
\&  my @names = DateTime::Locale\->native_names;
\&  my $names = DateTime::Locale\->native_names;
.Ve
.PP
Returns an unsorted list of the available locale names in their native
language, or an array reference if called in a scalar context. All native
names in \s-1UTF\-8\s0 characters as appropriate.
.SH "CLDR DATA BUGS"
.IX Header "CLDR DATA BUGS"
Please be aware that all locale data has been generated from the \s-1CLDR \s0(Common
Locale Data Repository) project locales data). The data is incomplete, and may
contain errors in some locales.
.PP
When reporting errors in data, please check the primary data sources first,
then where necessary report errors directly to the primary source via the \s-1CLDR\s0
bug report system. See http://unicode.org/cldr/filing_bug_reports.html for
details.
.PP
Once these errors have been confirmed, please forward the error report and
corrections to the DateTime mailing list, datetime@perl.org.
.SH "AUTHOR EMERITUS"
.IX Header "AUTHOR EMERITUS"
Richard Evans wrote the first version of DateTime::Locale, including the tools
to extract the \s-1CLDR\s0 data.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
DateTime::Locale::Base
.PP
datetime@perl.org mailing list
.PP
http://datetime.perl.org/
.SH "SUPPORT"
.IX Header "SUPPORT"
Bugs may be submitted through the \s-1RT\s0 bug tracker <http://rt.cpan.org/Public/Dist/Display.html?Name=DateTime-Locale>
(or bug\-datetime\-locale@rt.cpan.org <mailto:bug-datetime-locale@rt.cpan.org>).
.PP
There is a mailing list available for users of this distribution,
<mailto:datetime@perl.org>.
.PP
I am also usually active on \s-1IRC\s0 as 'drolsky' on \f(CW\*(C`irc://irc.perl.org\*(C'\fR.
.SH "DONATIONS"
.IX Header "DONATIONS"
If you'd like to thank me for the work I've done on this module, please
consider making a \*(L"donation\*(R" to me via PayPal. I spend a lot of free time
creating free software, and would appreciate any support you'd care to offer.
.PP
Please note that \fBI am not suggesting that you must do this\fR in order for me
to continue working on this particular software. I will continue to do so,
inasmuch as I have in the past, for as long as it interests me.
.PP
Similarly, a donation made in this way will probably not make me work on this
software much more, unless I get so many donations that I can consider working
on free software full time (let's all have a chuckle at that together).
.PP
To donate, log into PayPal and send money to autarch@urth.org, or use the
button at <http://www.urth.org/~autarch/fs\-donation.html>.
.SH "AUTHOR"
.IX Header "AUTHOR"
Dave Rolsky <autarch@urth.org>
.SH "CONTRIBUTOR"
.IX Header "CONTRIBUTOR"
Karen Etheridge <ether@cpan.org>
.SH "COPYRIGHT AND LICENCE"
.IX Header "COPYRIGHT AND LICENCE"
This software is copyright (c) 2016 by Dave Rolsky.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.