Commit | Line | Data |
---|---|---|
86530b38 AT |
1 | .\" Automatically generated by Pod::Man v1.34, Pod::Parser v1.13 |
2 | .\" | |
3 | .\" Standard preamble: | |
4 | .\" ======================================================================== | |
5 | .de Sh \" Subsection heading | |
6 | .br | |
7 | .if t .Sp | |
8 | .ne 5 | |
9 | .PP | |
10 | \fB\\$1\fR | |
11 | .PP | |
12 | .. | |
13 | .de Sp \" Vertical space (when we can't use .PP) | |
14 | .if t .sp .5v | |
15 | .if n .sp | |
16 | .. | |
17 | .de Vb \" Begin verbatim text | |
18 | .ft CW | |
19 | .nf | |
20 | .ne \\$1 | |
21 | .. | |
22 | .de Ve \" End verbatim text | |
23 | .ft R | |
24 | .fi | |
25 | .. | |
26 | .\" Set up some character translations and predefined strings. \*(-- will | |
27 | .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left | |
28 | .\" double quote, and \*(R" will give a right double quote. | will give a | |
29 | .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to | |
30 | .\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' | |
31 | .\" expand to `' in nroff, nothing in troff, for use with C<>. | |
32 | .tr \(*W-|\(bv\*(Tr | |
33 | .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' | |
34 | .ie n \{\ | |
35 | . ds -- \(*W- | |
36 | . ds PI pi | |
37 | . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch | |
38 | . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch | |
39 | . ds L" "" | |
40 | . ds R" "" | |
41 | . ds C` "" | |
42 | . ds C' "" | |
43 | 'br\} | |
44 | .el\{\ | |
45 | . ds -- \|\(em\| | |
46 | . ds PI \(*p | |
47 | . ds L" `` | |
48 | . ds R" '' | |
49 | 'br\} | |
50 | .\" | |
51 | .\" If the F register is turned on, we'll generate index entries on stderr for | |
52 | .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index | |
53 | .\" entries marked with X<> in POD. Of course, you'll have to process the | |
54 | .\" output yourself in some meaningful fashion. | |
55 | .if \nF \{\ | |
56 | . de IX | |
57 | . tm Index:\\$1\t\\n%\t"\\$2" | |
58 | .. | |
59 | . nr % 0 | |
60 | . rr F | |
61 | .\} | |
62 | .\" | |
63 | .\" For nroff, turn off justification. Always turn off hyphenation; it makes | |
64 | .\" way too many mistakes in technical documents. | |
65 | .hy 0 | |
66 | .if n .na | |
67 | .\" | |
68 | .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). | |
69 | .\" Fear. Run. Save yourself. No user-serviceable parts. | |
70 | . \" fudge factors for nroff and troff | |
71 | .if n \{\ | |
72 | . ds #H 0 | |
73 | . ds #V .8m | |
74 | . ds #F .3m | |
75 | . ds #[ \f1 | |
76 | . ds #] \fP | |
77 | .\} | |
78 | .if t \{\ | |
79 | . ds #H ((1u-(\\\\n(.fu%2u))*.13m) | |
80 | . ds #V .6m | |
81 | . ds #F 0 | |
82 | . ds #[ \& | |
83 | . ds #] \& | |
84 | .\} | |
85 | . \" simple accents for nroff and troff | |
86 | .if n \{\ | |
87 | . ds ' \& | |
88 | . ds ` \& | |
89 | . ds ^ \& | |
90 | . ds , \& | |
91 | . ds ~ ~ | |
92 | . ds / | |
93 | .\} | |
94 | .if t \{\ | |
95 | . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" | |
96 | . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' | |
97 | . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' | |
98 | . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' | |
99 | . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' | |
100 | . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' | |
101 | .\} | |
102 | . \" troff and (daisy-wheel) nroff accents | |
103 | .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' | |
104 | .ds 8 \h'\*(#H'\(*b\h'-\*(#H' | |
105 | .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] | |
106 | .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' | |
107 | .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' | |
108 | .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] | |
109 | .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] | |
110 | .ds ae a\h'-(\w'a'u*4/10)'e | |
111 | .ds Ae A\h'-(\w'A'u*4/10)'E | |
112 | . \" corrections for vroff | |
113 | .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' | |
114 | .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' | |
115 | . \" for low resolution devices (crt and lpr) | |
116 | .if \n(.H>23 .if \n(.V>19 \ | |
117 | \{\ | |
118 | . ds : e | |
119 | . ds 8 ss | |
120 | . ds o a | |
121 | . ds d- d\h'-1'\(ga | |
122 | . ds D- D\h'-1'\(hy | |
123 | . ds th \o'bp' | |
124 | . ds Th \o'LP' | |
125 | . ds ae ae | |
126 | . ds Ae AE | |
127 | .\} | |
128 | .rm #[ #] #H #V #F C | |
129 | .\" ======================================================================== | |
130 | .\" | |
131 | .IX Title "Locale::Language 3" | |
132 | .TH Locale::Language 3 "2002-06-01" "perl v5.8.0" "Perl Programmers Reference Guide" | |
133 | .SH "NAME" | |
134 | Locale::Language \- ISO two letter codes for language identification (ISO 639) | |
135 | .SH "SYNOPSIS" | |
136 | .IX Header "SYNOPSIS" | |
137 | .Vb 1 | |
138 | \& use Locale::Language; | |
139 | .Ve | |
140 | .PP | |
141 | .Vb 2 | |
142 | \& $lang = code2language('en'); # $lang gets 'English' | |
143 | \& $code = language2code('French'); # $code gets 'fr' | |
144 | .Ve | |
145 | .PP | |
146 | .Vb 2 | |
147 | \& @codes = all_language_codes(); | |
148 | \& @names = all_language_names(); | |
149 | .Ve | |
150 | .SH "DESCRIPTION" | |
151 | .IX Header "DESCRIPTION" | |
152 | The \f(CW\*(C`Locale::Language\*(C'\fR module provides access to the \s-1ISO\s0 two-letter | |
153 | codes for identifying languages, as defined in \s-1ISO\s0 639. You can either | |
154 | access the codes via the \*(L"conversion routines\*(R" (described below), | |
155 | or via the two functions which return lists of all language codes or | |
156 | all language names. | |
157 | .SH "CONVERSION ROUTINES" | |
158 | .IX Header "CONVERSION ROUTINES" | |
159 | There are two conversion routines: \f(CW\*(C`code2language()\*(C'\fR and \f(CW\*(C`language2code()\*(C'\fR. | |
160 | .IP "\fIcode2language()\fR" 4 | |
161 | .IX Item "code2language()" | |
162 | This function takes a two letter language code and returns a string | |
163 | which contains the name of the language identified. If the code is | |
164 | not a valid language code, as defined by \s-1ISO\s0 639, then \f(CW\*(C`undef\*(C'\fR | |
165 | will be returned. | |
166 | .Sp | |
167 | .Vb 1 | |
168 | \& $lang = code2language($code); | |
169 | .Ve | |
170 | .IP "\fIlanguage2code()\fR" 4 | |
171 | .IX Item "language2code()" | |
172 | This function takes a language name and returns the corresponding | |
173 | two letter language code, if such exists. | |
174 | If the argument could not be identified as a language name, | |
175 | then \f(CW\*(C`undef\*(C'\fR will be returned. | |
176 | .Sp | |
177 | .Vb 1 | |
178 | \& $code = language2code('French'); | |
179 | .Ve | |
180 | .Sp | |
181 | The case of the language name is not important. | |
182 | See the section \*(L"\s-1KNOWN\s0 \s-1BUGS\s0 \s-1AND\s0 \s-1LIMITATIONS\s0\*(R" below. | |
183 | .SH "QUERY ROUTINES" | |
184 | .IX Header "QUERY ROUTINES" | |
185 | There are two function which can be used to obtain a list of all | |
186 | language codes, or all language names: | |
187 | .ie n .IP """all_language_codes()""" 4 | |
188 | .el .IP "\f(CWall_language_codes()\fR" 4 | |
189 | .IX Item "all_language_codes()" | |
190 | Returns a list of all two-letter language codes. | |
191 | The codes are guaranteed to be all lower\-case, | |
192 | and not in any particular order. | |
193 | .ie n .IP """all_language_names()""" 4 | |
194 | .el .IP "\f(CWall_language_names()\fR" 4 | |
195 | .IX Item "all_language_names()" | |
196 | Returns a list of all language names for which there is a corresponding | |
197 | two-letter language code. The names are capitalised, and not returned | |
198 | in any particular order. | |
199 | .SH "EXAMPLES" | |
200 | .IX Header "EXAMPLES" | |
201 | The following example illustrates use of the \f(CW\*(C`code2language()\*(C'\fR function. | |
202 | The user is prompted for a language code, and then told the corresponding | |
203 | language name: | |
204 | .PP | |
205 | .Vb 1 | |
206 | \& $| = 1; # turn off buffering | |
207 | .Ve | |
208 | .PP | |
209 | .Vb 11 | |
210 | \& print "Enter language code: "; | |
211 | \& chop($code = <STDIN>); | |
212 | \& $lang = code2language($code); | |
213 | \& if (defined $lang) | |
214 | \& { | |
215 | \& print "$code = $lang\en"; | |
216 | \& } | |
217 | \& else | |
218 | \& { | |
219 | \& print "'$code' is not a valid language code!\en"; | |
220 | \& } | |
221 | .Ve | |
222 | .SH "KNOWN BUGS AND LIMITATIONS" | |
223 | .IX Header "KNOWN BUGS AND LIMITATIONS" | |
224 | .IP "\(bu" 4 | |
225 | In the current implementation, all data is read in when the | |
226 | module is loaded, and then held in memory. | |
227 | A lazy implementation would be more memory friendly. | |
228 | .IP "\(bu" 4 | |
229 | Currently just supports the two letter language codes \- | |
230 | there are also three-letter codes, and numbers. | |
231 | Would these be of any use to anyone? | |
232 | .SH "SEE ALSO" | |
233 | .IX Header "SEE ALSO" | |
234 | .IP "Locale::Country" 4 | |
235 | .IX Item "Locale::Country" | |
236 | \&\s-1ISO\s0 codes for identification of country (\s-1ISO\s0 3166). | |
237 | Supports 2\-letter, 3\-letter, and numeric country codes. | |
238 | .IP "Locale::Script" 4 | |
239 | .IX Item "Locale::Script" | |
240 | \&\s-1ISO\s0 codes for identification of written scripts (\s-1ISO\s0 15924). | |
241 | .IP "Locale::Currency" 4 | |
242 | .IX Item "Locale::Currency" | |
243 | \&\s-1ISO\s0 three letter codes for identification of currencies and funds (\s-1ISO\s0 4217). | |
244 | .IP "\s-1ISO\s0 639:1988 (E/F)" 4 | |
245 | .IX Item "ISO 639:1988 (E/F)" | |
246 | Code for the representation of names of languages. | |
247 | .IP "http://lcweb.loc.gov/standards/iso639\-2/langhome.html" 4 | |
248 | .IX Item "http://lcweb.loc.gov/standards/iso639-2/langhome.html" | |
249 | Home page for \s-1ISO\s0 639\-2. | |
250 | .SH "AUTHOR" | |
251 | .IX Header "AUTHOR" | |
252 | Neil Bowers <neil@bowers.com> | |
253 | .SH "COPYRIGHT" | |
254 | .IX Header "COPYRIGHT" | |
255 | Copyright (C) 2002, Neil Bowers. | |
256 | .PP | |
257 | Copyright (c) 1997\-2001 Canon Research Centre Europe (\s-1CRE\s0). | |
258 | .PP | |
259 | This module is free software; you can redistribute it and/or | |
260 | modify it under the same terms as Perl itself. |