Commit | Line | Data |
f768f60b |
1 | =pod |
6b14ceb7 |
2 | |
3 | =head1 NAME |
4 | |
f768f60b |
5 | Locale::Currency - standard codes for currency identification |
6b14ceb7 |
6 | |
7 | =head1 SYNOPSIS |
8 | |
9 | use Locale::Currency; |
10 | |
11 | $curr = code2currency('usd'); # $curr gets 'US Dollar' |
12 | $code = currency2code('Euro'); # $code gets 'eur' |
13 | |
14 | @codes = all_currency_codes(); |
15 | @names = all_currency_names(); |
16 | |
17 | |
18 | =head1 DESCRIPTION |
19 | |
f768f60b |
20 | The C<Locale::Currency> module provides access to standard codes used |
21 | for identifying currencies and funds, such as those defined in ISO 4217. |
6b14ceb7 |
22 | |
f768f60b |
23 | Most of the routines take an optional additional argument which |
24 | specifies the code set to use. If not specified, the default ISO |
25 | 4217 three-letter codes will be used. |
6b14ceb7 |
26 | |
f768f60b |
27 | =head1 SUPPORTED CODE SETS |
6b14ceb7 |
28 | |
f768f60b |
29 | There are several different code sets you can use for identifying |
30 | currencies. The ones currently supported are: |
6b14ceb7 |
31 | |
32 | =over 4 |
33 | |
f768f60b |
34 | =item B<alpha> |
6b14ceb7 |
35 | |
f768f60b |
36 | This is a set of three-letter (uppercase) codes from ISO 4217 such |
37 | as EUR for Euro. |
6b14ceb7 |
38 | |
f768f60b |
39 | Two of the codes specified by the standard (XTS which is reserved |
40 | for testing purposes and XXX which is for transactions where no |
41 | currency is involved) are omitted. |
6b14ceb7 |
42 | |
f768f60b |
43 | This code set is identified with the symbol C<LOCALE_CURR_ALPHA>. |
6b14ceb7 |
44 | |
f768f60b |
45 | This is the default code set. |
6b14ceb7 |
46 | |
f768f60b |
47 | =item B<num> |
6b14ceb7 |
48 | |
f768f60b |
49 | This is the set of three-digit numeric codes from ISO 4217. |
6b14ceb7 |
50 | |
f768f60b |
51 | This code set is identified with the symbol C<LOCALE_CURR_NUMERIC>. |
6b14ceb7 |
52 | |
f768f60b |
53 | =back |
6b14ceb7 |
54 | |
f768f60b |
55 | =head1 ROUTINES |
6b14ceb7 |
56 | |
57 | =over 4 |
58 | |
f768f60b |
59 | =item B<code2currency ( CODE [,CODESET] )> |
6b14ceb7 |
60 | |
f768f60b |
61 | =item B<currency2code ( NAME [,CODESET] )> |
6b14ceb7 |
62 | |
f768f60b |
63 | =item B<currency_code2code ( CODE ,CODESET ,CODESET2 )> |
6b14ceb7 |
64 | |
f768f60b |
65 | =item B<all_currency_codes ( [CODESET] )> |
6b14ceb7 |
66 | |
f768f60b |
67 | =item B<all_currency_names ( [CODESET] )> |
6b14ceb7 |
68 | |
f768f60b |
69 | =item B<Locale::Currency::rename_currency ( CODE ,NEW_NAME [,CODESET] )> |
6b14ceb7 |
70 | |
f768f60b |
71 | =item B<Locale::Currency::add_currency ( CODE ,NAME [,CODESET] )> |
6b14ceb7 |
72 | |
f768f60b |
73 | =item B<Locale::Currency::delete_currency ( CODE [,CODESET] )> |
6b14ceb7 |
74 | |
f768f60b |
75 | =item B<Locale::Currency::add_currency_alias ( NAME ,NEW_NAME )> |
6b14ceb7 |
76 | |
f768f60b |
77 | =item B<Locale::Currency::delete_currency_alias ( NAME )> |
6b14ceb7 |
78 | |
f768f60b |
79 | =item B<Locale::Currency::rename_currency_code ( CODE ,NEW_CODE [,CODESET] )> |
6b14ceb7 |
80 | |
f768f60b |
81 | =item B<Locale::Currency::add_currency_code_alias ( CODE ,NEW_CODE [,CODESET] )> |
6b14ceb7 |
82 | |
f768f60b |
83 | =item B<Locale::Currency::delete_currency_code_alias ( CODE [,CODESET] )> |
6b14ceb7 |
84 | |
f768f60b |
85 | These routines are all documented in the Locale::Codes man page. |
6b14ceb7 |
86 | |
87 | =back |
88 | |
89 | =head1 SEE ALSO |
90 | |
91 | =over 4 |
92 | |
f768f60b |
93 | =item B<Locale::Codes> |
6b14ceb7 |
94 | |
f768f60b |
95 | =item B<Locale::Constants> |
6b14ceb7 |
96 | |
f768f60b |
97 | =item B<http://www.iso.org/iso/support/currency_codes_list-1.htm> |
6b14ceb7 |
98 | |
f768f60b |
99 | The ISO 4217 data. |
6b14ceb7 |
100 | |
101 | =back |
102 | |
103 | =head1 AUTHOR |
104 | |
f768f60b |
105 | See Locale::Codes for full author history. |
6b14ceb7 |
106 | |
f768f60b |
107 | Currently maintained by Sullivan Beck (sbeck@cpan.org). |
6b14ceb7 |
108 | |
f768f60b |
109 | =head1 COPYRIGHT |
6b14ceb7 |
110 | |
f768f60b |
111 | Copyright (c) 1997-2001 Canon Research Centre Europe (CRE). |
112 | Copyright (c) 2001 Michael Hennecke |
113 | Copyright (c) 2001-2010 Neil Bowers |
114 | Copyright (c) 2010-2010 Sullivan Beck |
6b14ceb7 |
115 | |
116 | This module is free software; you can redistribute it and/or |
117 | modify it under the same terms as Perl itself. |
118 | |
119 | =cut |