| Current File : //opt/RZperl518/man/man3/Locale::Currency.3 |
.\" 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
.\"
.\" 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::Currency 3"
.TH Locale::Currency 3 "2014-10-01" "perl v5.18.4" "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::Currency \- standard codes for currency identification
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& use Locale::Currency;
\&
\& $curr = code2currency(\*(Aqusd\*(Aq); # $curr gets \*(AqUS Dollar\*(Aq
\& $code = currency2code(\*(AqEuro\*(Aq); # $code gets \*(Aqeur\*(Aq
\&
\& @codes = all_currency_codes();
\& @names = all_currency_names();
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The \f(CW\*(C`Locale::Currency\*(C'\fR module provides access to standard codes used
for identifying currencies and funds, such as those defined in \s-1ISO 4217.\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
4217\s0 three-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
currencies. 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
\& $curr = code2currency(\*(Aqusd\*(Aq,\*(Aqalpha\*(Aq);
\& $curr = code2currency(\*(Aqusd\*(Aq,LOCALE_CURR_ALPHA);
.Ve
.PP
The codesets currently supported are:
.IP "\fBalpha, \s-1LOCALE_CURR_ALPHA\s0\fR" 4
.IX Item "alpha, LOCALE_CURR_ALPHA"
This is a set of three-letter (uppercase) codes from \s-1ISO 4217\s0 such
as \s-1EUR\s0 for Euro.
.Sp
Two of the codes specified by the standard (\s-1XTS\s0 which is reserved
for testing purposes and \s-1XXX\s0 which is for transactions where no
currency is involved) are omitted.
.Sp
This is the default code set.
.IP "\fBnum, \s-1LOCALE_CURR_NUMERIC\s0\fR" 4
.IX Item "num, LOCALE_CURR_NUMERIC"
This is the set of three-digit numeric codes from \s-1ISO 4217.\s0
.SH "ROUTINES"
.IX Header "ROUTINES"
.IP "\fBcode2currency ( \s-1CODE\s0 [,CODESET] )\fR" 4
.IX Item "code2currency ( CODE [,CODESET] )"
.PD 0
.IP "\fBcurrency2code ( \s-1NAME\s0 [,CODESET] )\fR" 4
.IX Item "currency2code ( NAME [,CODESET] )"
.IP "\fBcurrency_code2code ( \s-1CODE ,CODESET ,CODESET2 \s0)\fR" 4
.IX Item "currency_code2code ( CODE ,CODESET ,CODESET2 )"
.IP "\fBall_currency_codes ( [\s-1CODESET\s0] )\fR" 4
.IX Item "all_currency_codes ( [CODESET] )"
.IP "\fBall_currency_names ( [\s-1CODESET\s0] )\fR" 4
.IX Item "all_currency_names ( [CODESET] )"
.IP "\fBLocale::Currency::rename_currency ( \s-1CODE ,NEW_NAME\s0 [,CODESET] )\fR" 4
.IX Item "Locale::Currency::rename_currency ( CODE ,NEW_NAME [,CODESET] )"
.IP "\fBLocale::Currency::add_currency ( \s-1CODE ,NAME\s0 [,CODESET] )\fR" 4
.IX Item "Locale::Currency::add_currency ( CODE ,NAME [,CODESET] )"
.IP "\fBLocale::Currency::delete_currency ( \s-1CODE\s0 [,CODESET] )\fR" 4
.IX Item "Locale::Currency::delete_currency ( CODE [,CODESET] )"
.IP "\fBLocale::Currency::add_currency_alias ( \s-1NAME ,NEW_NAME \s0)\fR" 4
.IX Item "Locale::Currency::add_currency_alias ( NAME ,NEW_NAME )"
.IP "\fBLocale::Currency::delete_currency_alias ( \s-1NAME \s0)\fR" 4
.IX Item "Locale::Currency::delete_currency_alias ( NAME )"
.IP "\fBLocale::Currency::rename_currency_code ( \s-1CODE ,NEW_CODE\s0 [,CODESET] )\fR" 4
.IX Item "Locale::Currency::rename_currency_code ( CODE ,NEW_CODE [,CODESET] )"
.IP "\fBLocale::Currency::add_currency_code_alias ( \s-1CODE ,NEW_CODE\s0 [,CODESET] )\fR" 4
.IX Item "Locale::Currency::add_currency_code_alias ( CODE ,NEW_CODE [,CODESET] )"
.IP "\fBLocale::Currency::delete_currency_code_alias ( \s-1CODE\s0 [,CODESET] )\fR" 4
.IX Item "Locale::Currency::delete_currency_code_alias ( CODE [,CODESET] )"
.PD
These routines are all documented in the Locale::Codes::API man page.
.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 "\fBhttp://www.iso.org/iso/support/currency_codes_list\-1.htm\fR" 4
.IX Item "http://www.iso.org/iso/support/currency_codes_list-1.htm"
The \s-1ISO 4217\s0 data.
.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 4
\& Copyright (c) 1997\-2001 Canon Research Centre Europe (CRE).
\& Copyright (c) 2001 Michael Hennecke
\& Copyright (c) 2001\-2010 Neil Bowers
\& Copyright (c) 2010\-2013 Sullivan Beck
.Ve
.PP
This module is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.