Remove Locale-Codes internals from core
[p5sagit/p5-mst-13.2.git] / cpan / Locale-Codes / lib / Locale / Language.pod
1 =pod
2
3 =head1 NAME
4
5 Locale::Language - standard codes for language identification
6
7 =head1 SYNOPSIS
8
9    use Locale::Language;
10
11    $lang = code2language('en');        # $lang gets 'English'
12    $code = language2code('French');    # $code gets 'fr'
13
14    @codes   = all_language_codes();
15    @names   = all_language_names();
16
17 =head1 DESCRIPTION
18
19 The C<Locale::Language> module provides access to standard codes used
20 for identifying languages, such as those as defined in ISO 639.
21
22 Most of the routines take an optional additional argument which
23 specifies the code set to use. If not specified, the default ISO
24 639 two-letter codes will be used.
25
26 =head1 SUPPORTED CODE SETS
27
28 There are several different code sets you can use for identifying
29 languages. The ones currently supported are:
30
31 =over 4
32
33 =item B<alpha-2>
34
35 This is the set of two-letter (lowercase) codes from ISO 639, such
36 as 'he' for Hebrew.
37
38 This code set is identified with the symbol C<LOCALE_LANG_ALPHA_2>.
39
40 This is the default code set.
41
42 =item B<alpha-3>
43
44 This is the set of three-letter (lowercase) bibliographic codes from
45 ISO 639, such as 'heb' for Hebrew.
46
47 This code set is identified with the symbol C<LOCALE_LANG_ALPHA_3>.
48
49 =item B<term>
50
51 This is the set of three-letter (lowercase) terminologic codes from
52 ISO 639.
53
54 This code set is identified with the symbol C<LOCALE_LANG_TERM>.
55
56 =back
57
58 =head1 ROUTINES
59
60 =over 4
61
62 =item B<code2language ( CODE [,CODESET] )>
63
64 =item B<language2code ( NAME [,CODESET] )>
65
66 =item B<language_code2code ( CODE ,CODESET ,CODESET2 )>
67
68 =item B<all_language_codes ( [CODESET] )>
69
70 =item B<all_language_names ( [CODESET] )>
71
72 =item B<Locale::Language::rename_language  ( CODE ,NEW_NAME [,CODESET] )>
73
74 =item B<Locale::Language::add_language  ( CODE ,NAME [,CODESET] )>
75
76 =item B<Locale::Language::delete_language  ( CODE [,CODESET] )>
77
78 =item B<Locale::Language::add_language_alias  ( NAME ,NEW_NAME )>
79
80 =item B<Locale::Language::delete_language_alias  ( NAME )>
81
82 =item B<Locale::Language::rename_language_code  ( CODE ,NEW_CODE [,CODESET] )>
83
84 =item B<Locale::Language::add_language_code_alias  ( CODE ,NEW_CODE [,CODESET] )>
85
86 =item B<Locale::Language::delete_language_code_alias  ( CODE [,CODESET] )>
87
88 These routines are all documented in the Locale::Codes man page.
89
90 =back
91
92 =head1 SEE ALSO
93
94 =over 4
95
96 =item B<Locale::Codes>
97
98 =item B<Locale::Constants>
99
100 =item B<http://www.loc.gov/standards/iso639-2/>
101
102 Source of the ISO 639 codes.
103
104 =back
105
106 =head1 AUTHOR
107
108 See Locale::Codes for full author history.
109
110 Currently maintained by Sullivan Beck (sbeck@cpan.org).
111
112 =head1 COPYRIGHT
113
114    Copyright (c) 1997-2001 Canon Research Centre Europe (CRE).
115    Copyright (c) 2001-2010 Neil Bowers
116    Copyright (c) 2010-2010 Sullivan Beck
117
118 This module is free software; you can redistribute it and/or
119 modify it under the same terms as Perl itself.
120
121 =cut