.\" Automatically generated by Pod::Man 2.28 (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
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Locale::Codes::Country 3perl"
.TH Locale::Codes::Country 3perl "2014-12-27" "perl v5.20.2" "Perl Programmers Reference Guide"
.\" 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"
Locale::Codes::Country \- standard codes for country identification
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&   use Locale::Codes::Country;
\&
\&   $country = code2country(\*(Aqjp\*(Aq [,CODESET]);        # $country gets \*(AqJapan\*(Aq
\&   $code    = country2code(\*(AqNorway\*(Aq [,CODESET]);    # $code gets \*(Aqno\*(Aq
\&
\&   @codes   = all_country_codes( [CODESET]);
\&   @names   = all_country_names();
\&
\&   # semi\-private routines
\&   Locale::Codes::Country::alias_code(\*(Aquk\*(Aq => \*(Aqgb\*(Aq);
\&   Locale::Codes::Country::rename_country(\*(Aqgb\*(Aq => \*(AqGreat Britain\*(Aq);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The \f(CW\*(C`Locale::Codes::Country\*(C'\fR module provides access to several code sets
that can be used for identifying countries, such as those defined in
\&\s-1ISO 3166\-1.\s0
.PP
Most of the routines take an optional additional argument which
specifies the code set to use. If not specified, the default \s-1ISO
3166\-1\s0 two-letter codes will be used.
.SH "SUPPORTED CODE SETS"
.IX Header "SUPPORTED CODE SETS"
There are several different code sets you can use for identifying
countries. A code set may be specified using either a name, or a
constant that is automatically exported by this module.
.PP
For example, the two are equivalent:
.PP
.Vb 2
\&   $country = code2country(\*(Aqjp\*(Aq,\*(Aqalpha\-2\*(Aq);
\&   $country = code2country(\*(Aqjp\*(Aq,LOCALE_CODE_ALPHA_2);
.Ve
.PP
The codesets currently supported are:
.IP "\fBalpha\-2, \s-1LOCALE_CODE_ALPHA_2\s0\fR" 4
.IX Item "alpha-2, LOCALE_CODE_ALPHA_2"
This is the set of two-letter (lowercase) codes from \s-1ISO 3166\-1,\s0 such
as 'tv' for Tuvalu.
.Sp
This is the default code set.
.IP "\fBalpha\-3, \s-1LOCALE_CODE_ALPHA_3\s0\fR" 4
.IX Item "alpha-3, LOCALE_CODE_ALPHA_3"
This is the set of three-letter (lowercase) codes from \s-1ISO 3166\-1,\s0
such as 'brb' for Barbados. These codes are actually defined and
maintained by the U.N. Statistics division.
.IP "\fBnumeric, \s-1LOCALE_CODE_NUMERIC\s0\fR" 4
.IX Item "numeric, LOCALE_CODE_NUMERIC"
This is the set of three-digit numeric codes from \s-1ISO 3166\-1,\s0 such as
064 for Bhutan. These codes are actually defined and maintained by the
U.N. Statistics division.
.Sp
If a 2\-digit code is entered, it is converted to 3 digits by prepending
a 0.
.IP "\fBdom, \s-1LOCALE_CODE_DOM\s0\fR" 4
.IX Item "dom, LOCALE_CODE_DOM"
The \s-1IANA\s0 is responsible for delegating management of the top level country
domains.  The country domains are the two-letter (lowercase) codes from \s-1ISO 3166\s0
with a few other additions.
.PP
\&\s-1NOTE:\s0 As of version 3.27, the \s-1FIPS\s0 code set is no longer supported.  See the
Locale::Codes::Changes document for details.
.SH "ROUTINES"
.IX Header "ROUTINES"
.IP "\fBcode2country ( \s-1CODE\s0 [,CODESET] )\fR" 4
.IX Item "code2country ( CODE [,CODESET] )"
.PD 0
.IP "\fBcountry2code ( \s-1NAME\s0 [,CODESET] )\fR" 4
.IX Item "country2code ( NAME [,CODESET] )"
.IP "\fBcountry_code2code ( \s-1CODE ,CODESET ,CODESET2 \s0)\fR" 4
.IX Item "country_code2code ( CODE ,CODESET ,CODESET2 )"
.IP "\fBall_country_codes ( [\s-1CODESET\s0] )\fR" 4
.IX Item "all_country_codes ( [CODESET] )"
.IP "\fBall_country_names ( [\s-1CODESET\s0] )\fR" 4
.IX Item "all_country_names ( [CODESET] )"
.IP "\fBLocale::Codes::Country::rename_country  ( \s-1CODE ,NEW_NAME\s0 [,CODESET] )\fR" 4
.IX Item "Locale::Codes::Country::rename_country ( CODE ,NEW_NAME [,CODESET] )"
.IP "\fBLocale::Codes::Country::add_country  ( \s-1CODE ,NAME\s0 [,CODESET] )\fR" 4
.IX Item "Locale::Codes::Country::add_country ( CODE ,NAME [,CODESET] )"
.IP "\fBLocale::Codes::Country::delete_country  ( \s-1CODE\s0 [,CODESET] )\fR" 4
.IX Item "Locale::Codes::Country::delete_country ( CODE [,CODESET] )"
.IP "\fBLocale::Codes::Country::add_country_alias  ( \s-1NAME ,NEW_NAME \s0)\fR" 4
.IX Item "Locale::Codes::Country::add_country_alias ( NAME ,NEW_NAME )"
.IP "\fBLocale::Codes::Country::delete_country_alias  ( \s-1NAME \s0)\fR" 4
.IX Item "Locale::Codes::Country::delete_country_alias ( NAME )"
.IP "\fBLocale::Codes::Country::rename_country_code  ( \s-1CODE ,NEW_CODE\s0 [,CODESET] )\fR" 4
.IX Item "Locale::Codes::Country::rename_country_code ( CODE ,NEW_CODE [,CODESET] )"
.IP "\fBLocale::Codes::Country::add_country_code_alias  ( \s-1CODE ,NEW_CODE\s0 [,CODESET] )\fR" 4
.IX Item "Locale::Codes::Country::add_country_code_alias ( CODE ,NEW_CODE [,CODESET] )"
.IP "\fBLocale::Codes::Country::delete_country_code_alias  ( \s-1CODE\s0 [,CODESET] )\fR" 4
.IX Item "Locale::Codes::Country::delete_country_code_alias ( CODE [,CODESET] )"
.PD
These routines are all documented in the Locale::Codes::API man page.
.IP "\fBalias_code ( \s-1ALIAS, CODE\s0 [,CODESET] )\fR" 4
.IX Item "alias_code ( ALIAS, CODE [,CODESET] )"
Version 2.07 included 2 functions for modifying the internal data:
rename_country and alias_code. Both of these could be used only to
modify the internal data for country codes.
.Sp
As of 3.10, the internal data for all types of codes can be modified.
.Sp
The alias_code function is preserved for backwards compatibility, but
the following two are identical:
.Sp
.Vb 2
\&   alias_code(ALIAS,CODE [,CODESET]);
\&   rename_country_code(CODE,ALIAS [,CODESET]);
.Ve
.Sp
and the latter should be used for consistency.
.Sp
The alias_code function is deprecated and will be removed in the December
2014 release.
.Sp
\&\fBNote:\fR this function was previously called _alias_code, but the
leading underscore has been dropped. The old name was supported for
all 2.X releases, but has been dropped as of 3.00.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.IP "\fBLocale::Codes\fR" 4
.IX Item "Locale::Codes"
The Locale-Codes distribution.
.IP "\fBLocale::Codes::API\fR" 4
.IX Item "Locale::Codes::API"
The list of functions supported by this module.
.IP "\fBLocale::SubCountry\fR" 4
.IX Item "Locale::SubCountry"
\&\s-1ISO\s0 codes for country sub-divisions (states, counties, provinces,
etc), as defined in \s-1ISO 3166\-2. \s0 This module is not part of the
Locale-Codes distribution, but is available from \s-1CPAN\s0 in
CPAN/modules/by\-module/Locale/
.IP "\fBhttp://www.iso.org/iso/home/standards/country_codes.htm\fR" 4
.IX Item "http://www.iso.org/iso/home/standards/country_codes.htm"
Official home page for the \s-1ISO 3166\s0 maintenance agency.
.IP "\fBhttp://www.iso.org/iso/home/standards/country_codes/iso\-3166\-1_decoding_table.htm\fR" 4
.IX Item "http://www.iso.org/iso/home/standards/country_codes/iso-3166-1_decoding_table.htm"
The source of \s-1ISO 3166\-1\s0 two-letter codes used by this
module.
.IP "\fBhttp://www.iana.org/domains/root/db/\fR" 4
.IX Item "http://www.iana.org/domains/root/db/"
Official source of the top-level domain names.
.IP "\fBhttp://unstats.un.org/unsd/methods/m49/m49alpha.htm\fR" 4
.IX Item "http://unstats.un.org/unsd/methods/m49/m49alpha.htm"
The source of the official \s-1ISO 3166\-1\s0 three-letter codes and
three-digit codes.
.Sp
For some reason, this table is incomplete! Several countries are
missing from it, and I cannot find them anywhere on the \s-1UN\s0 site.  I
no longer use this as a source of data.
.IP "\fBhttps://www.cia.gov/library/publications/the\-world\-factbook/appendix/print_appendix\-d.html\fR" 4
.IX Item "https://www.cia.gov/library/publications/the-world-factbook/appendix/print_appendix-d.html"
The World Factbook maintained by the \s-1CIA\s0 is a potential source of
the data.  Unfortunately, it adds/preserves non-standard codes, so it is no
longer used as a source of data.
.IP "\fBhttp://www.statoids.com/wab.html\fR" 4
.IX Item "http://www.statoids.com/wab.html"
Another unofficial source of data. Currently, it is not used to get
data, but the notes and explanatory material were very useful for
understanding discrepancies between the sources.
.SH "AUTHOR"
.IX Header "AUTHOR"
See Locale::Codes for full author history.
.PP
Currently maintained by Sullivan Beck (sbeck@cpan.org).
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
.Vb 3
\&   Copyright (c) 1997\-2001 Canon Research Centre Europe (CRE).
\&   Copyright (c) 2001\-2010 Neil Bowers
\&   Copyright (c) 2010\-2014 Sullivan Beck
.Ve
.PP
This module is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.