Update Locale-Codes to CPAN version 3.54

[perl5.git] / cpan / Locale-Codes / lib / Locale / Country.pod

=pod

=head1 NAME

Locale::Country - module for dealing with country code sets

=head1 SYNOPSIS

   use Locale::Country;

   $name = code2country(CODE);
   $code = country2code(NAME);

   @codes   = all_country_codes();
   @names   = all_country_names();

=head1 DESCRIPTION

This module provides access to country code sets.

Please refer to the L<Locale::Codes::Types> document for a description
of the code sets available.

Most of the routines take an optional additional argument which
specifies the code set to use. The code set can be specified using the
name of a code set, or the perl constant specified in the above
document.  If not specified, the default code set will be used.

=head1 ROUTINES

All routines in this module call the appropriate method in the
L<Locale::Codes> module, using an object of type: country
Please refer to the documentation of the L<Locale::Codes> module
for details about each function.

The following functions are exported automatically:

=over 4

=item B<code2country(CODE [,CODESET] [,'retired'])>

See B<code2name> in L<Locale::Codes>

=item B<country2code(NAME [,CODESET] [,'retired'])>

See B<name2code> in L<Locale::Codes>

=item B<country_code2code(CODE ,CODESET ,CODESET2)>

See B<code2code> in L<Locale::Codes>

=item B<all_country_codes([CODESET] [,'retired'])>

See B<all_codes> in L<Locale::Codes>

=item B<all_country_names([CODESET] [,'retired'])>

See B<all_names> in L<Locale::Codes>

=back

The following functions are not exported and must be called fully
qualified with the package name:

=over 4

=item B<Locale::Country::show_errors(FLAG)>

By default, invalid input will produce empty results, but no errors.  By
passing in a non-zero value of FLAG, errors will be produced.

See B<show_errors> in L<Locale::Codes> but note that the default for
the non-OO modules are to NOT produce errors.

=item B<Locale::Country::rename_country(CODE ,NEW_NAME [,CODESET])>

See B<rename_code> in L<Locale::Codes>

=item B<Locale::Country::add_country(CODE ,NAME [,CODESET])>

See B<add_code> in L<Locale::Codes>

=item B<Locale::Country::delete_country(CODE [,CODESET])>

See B<delete_code> in L<Locale::Codes>

=item B<Locale::Country::add_country_alias(NAME ,NEW_NAME)>

See B<add_alias> in L<Locale::Codes>

=item B<Locale::Country::delete_country_alias(NAME)>

See B<delete_alias> in L<Locale::Codes>

=item B<Locale::Country::rename_country_code(CODE ,NEW_CODE [,CODESET])>

See B<replace_code> in L<Locale::Codes>

=item B<Locale::Country::add_country_code_alias(CODE ,NEW_CODE [,CODESET])>

See B<add_code_alias> in L<Locale::Codes>

=item B<Locale::Country::delete_country_code_alias(CODE [,CODESET])>

See B<delete_code_alias> in L<Locale::Codes>

=back

=head1 SEE ALSO

=over 4

=item L<Locale::Codes>

The Locale-Codes distribution.

=back

=head1 AUTHOR

See Locale::Codes for full author history.

Currently maintained by Sullivan Beck (sbeck@cpan.org).

=head1 COPYRIGHT

   Copyright (c) 2011-2017 Sullivan Beck

This module is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.

=cut