cpan/Locale-Codes/lib/Locale/Currency.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 Locale::Currency - standard codes for currency identification
   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
  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.
  22
  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.
  26
  27 =head1 SUPPORTED CODE SETS
  28
  29 There are several different code sets you can use for identifying
  30 currencies. The ones currently supported are:
  31
  32 =over 4
  33
  34 =item B<alpha>
  35
  36 This is a set of three-letter (uppercase) codes from ISO 4217 such
  37 as EUR for Euro.
  38
  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.
  42
  43 This code set is identified with the symbol C<LOCALE_CURR_ALPHA>.
  44
  45 This is the default code set.
  46
  47 =item B<num>
  48
  49 This is the set of three-digit numeric codes from ISO 4217.
  50
  51 This code set is identified with the symbol C<LOCALE_CURR_NUMERIC>.
  52
  53 =back
  54
  55 =head1 ROUTINES
  56
  57 =over 4
  58
  59 =item B<code2currency ( CODE [,CODESET] )>
  60
  61 =item B<currency2code ( NAME [,CODESET] )>
  62
  63 =item B<currency_code2code ( CODE ,CODESET ,CODESET2 )>
  64
  65 =item B<all_currency_codes ( [CODESET] )>
  66
  67 =item B<all_currency_names ( [CODESET] )>
  68
  69 =item B<Locale::Currency::rename_currency  ( CODE ,NEW_NAME [,CODESET] )>
  70
  71 =item B<Locale::Currency::add_currency  ( CODE ,NAME [,CODESET] )>
  72
  73 =item B<Locale::Currency::delete_currency  ( CODE [,CODESET] )>
  74
  75 =item B<Locale::Currency::add_currency_alias  ( NAME ,NEW_NAME )>
  76
  77 =item B<Locale::Currency::delete_currency_alias  ( NAME )>
  78
  79 =item B<Locale::Currency::rename_currency_code  ( CODE ,NEW_CODE [,CODESET] )>
  80
  81 =item B<Locale::Currency::add_currency_code_alias  ( CODE ,NEW_CODE [,CODESET] )>
  82
  83 =item B<Locale::Currency::delete_currency_code_alias  ( CODE [,CODESET] )>
  84
  85 These routines are all documented in the Locale::Codes man page.
  86
  87 =back
  88
  89 =head1 SEE ALSO
  90
  91 =over 4
  92
  93 =item B<Locale::Codes>
  94
  95 =item B<Locale::Constants>
  96
  97 =item B<http://www.iso.org/iso/support/currency_codes_list-1.htm>
  98
  99 The ISO 4217 data.
 100
 101 =back
 102
 103 =head1 AUTHOR
 104
 105 See Locale::Codes for full author history.
 106
 107 Currently maintained by Sullivan Beck (sbeck@cpan.org).
 108
 109 =head1 COPYRIGHT
 110
 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
 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