.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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 >0, 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 "Locale::Currency 3pm"
.TH Locale::Currency 3pm 2024-03-18 "perl v5.38.2" "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
Locale::Currency \- module for dealing with currency code sets
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&   use Locale::Currency;
\&
\&   $name = code2currency(CODE);
\&   $code = currency2code(NAME);
\&
\&   @codes   = all_currency_codes();
\&   @names   = all_currency_names();
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This module provides access to currency code sets.
.PP
Please refer to the Locale::Codes::Types document for a description
of the code sets available.
.PP
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.
.SH ROUTINES
.IX Header "ROUTINES"
All routines in this module call the appropriate method in the
Locale::Codes module, using an object of type: currency
Please refer to the documentation of the Locale::Codes module
for details about each function.
.PP
The following functions are exported automatically:
.IP "\fBcode2currency(CODE [,CODESET] [,'retired'])\fR" 4
.IX Item "code2currency(CODE [,CODESET] [,'retired'])"
See \fBcode2name\fR in Locale::Codes
.IP "\fBcode2currencys(CODE [,CODESET])\fR" 4
.IX Item "code2currencys(CODE [,CODESET])"
See \fBcode2names\fR in Locale::Codes
.IP "\fBcurrency2code(NAME [,CODESET] [,'retired'])\fR" 4
.IX Item "currency2code(NAME [,CODESET] [,'retired'])"
See \fBname2code\fR in Locale::Codes
.IP "\fBcurrency_code2code(CODE ,CODESET ,CODESET2)\fR" 4
.IX Item "currency_code2code(CODE ,CODESET ,CODESET2)"
See \fBcode2code\fR in Locale::Codes
.IP "\fBall_currency_codes([CODESET] [,'retired'])\fR" 4
.IX Item "all_currency_codes([CODESET] [,'retired'])"
See \fBall_codes\fR in Locale::Codes
.IP "\fBall_currency_names([CODESET] [,'retired'])\fR" 4
.IX Item "all_currency_names([CODESET] [,'retired'])"
See \fBall_names\fR in Locale::Codes
.PP
The following functions are not exported and must be called fully
qualified with the package name:
.IP \fBLocale::Currency::show_errors(FLAG)\fR 4
.IX Item "Locale::Currency::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.
.Sp
See \fBshow_errors\fR in Locale::Codes but note that the default for
the non-OO modules are to NOT produce errors.
.IP "\fBLocale::Currency::rename_currency(CODE ,NEW_NAME [,CODESET])\fR" 4
.IX Item "Locale::Currency::rename_currency(CODE ,NEW_NAME [,CODESET])"
See \fBrename_code\fR in Locale::Codes
.IP "\fBLocale::Currency::add_currency(CODE ,NAME [,CODESET])\fR" 4
.IX Item "Locale::Currency::add_currency(CODE ,NAME [,CODESET])"
See \fBadd_code\fR in Locale::Codes
.IP "\fBLocale::Currency::delete_currency(CODE [,CODESET])\fR" 4
.IX Item "Locale::Currency::delete_currency(CODE [,CODESET])"
See \fBdelete_code\fR in Locale::Codes
.IP "\fBLocale::Currency::add_currency_alias(NAME ,NEW_NAME)\fR" 4
.IX Item "Locale::Currency::add_currency_alias(NAME ,NEW_NAME)"
See \fBadd_alias\fR in Locale::Codes
.IP \fBLocale::Currency::delete_currency_alias(NAME)\fR 4
.IX Item "Locale::Currency::delete_currency_alias(NAME)"
See \fBdelete_alias\fR in Locale::Codes
.IP "\fBLocale::Currency::rename_currency_code(CODE ,NEW_CODE [,CODESET])\fR" 4
.IX Item "Locale::Currency::rename_currency_code(CODE ,NEW_CODE [,CODESET])"
See \fBreplace_code\fR in Locale::Codes
.IP "\fBLocale::Currency::add_currency_code_alias(CODE ,NEW_CODE [,CODESET])\fR" 4
.IX Item "Locale::Currency::add_currency_code_alias(CODE ,NEW_CODE [,CODESET])"
See \fBadd_code_alias\fR in Locale::Codes
.IP "\fBLocale::Currency::delete_currency_code_alias(CODE [,CODESET])\fR" 4
.IX Item "Locale::Currency::delete_currency_code_alias(CODE [,CODESET])"
See \fBdelete_code_alias\fR in Locale::Codes
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.IP Locale::Codes 4
.IX Item "Locale::Codes"
The Locale-Codes distribution.
.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 1
\&   Copyright (c) 2011\-2024 Sullivan Beck
.Ve
.PP
This module is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.