Debian Codegraph @

upstream/debian-unstable/man1/perlunifaq.1

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "PERLUNIFAQ 1"
58 .TH PERLUNIFAQ 1 2025-11-16 "perl v5.40.1" "Perl Programmers Reference Guide"
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 perlunifaq \- Perl Unicode FAQ
65 .SH "Q and A"
66 .IX Header "Q and A"
67 This is a list of questions and answers about Unicode in Perl, intended to be
68 read after perlunitut.
69 .SS "perlunitut isn't really a Unicode tutorial, is it?"
70 .IX Subsection "perlunitut isn't really a Unicode tutorial, is it?"
71 No, and this isn't really a Unicode FAQ.
72 .PP
73 Perl has an abstracted interface for all supported character encodings, so this
74 is actually a generic \f(CW\*(C`Encode\*(C'\fR tutorial and \f(CW\*(C`Encode\*(C'\fR FAQ. But many people
75 think that Unicode is special and magical, and I didn't want to disappoint
76 them, so I decided to call the document a Unicode tutorial.
77 .SS "What character encodings does Perl support?"
78 .IX Subsection "What character encodings does Perl support?"
79 To find out which character encodings your Perl supports, run:
80 .PP
81 .Vb 1
82 \& perl \-MEncode \-le "print for Encode\->encodings(\*(Aq:all\*(Aq)"
83 .Ve
84 .SS "Which version of perl should I use?"
85 .IX Subsection "Which version of perl should I use?"
86 Well, if you can, upgrade to the most recent, but certainly \f(CW5.8.1\fR or newer.
87 The tutorial and FAQ assume the latest release.
88 .PP
89 You should also check your modules, and upgrade them if necessary. For example,
90 HTML::Entities requires version >= 1.32 to function correctly, even though the
91 changelog is silent about this.
92 .SS "What about binary data, like images?"
93 .IX Subsection "What about binary data, like images?"
94 Well, apart from a bare \f(CW\*(C`binmode $fh\*(C'\fR, you shouldn't treat them specially.
95 (The binmode is needed because otherwise Perl may convert line endings on Win32
96 systems.)
97 .PP
98 Be careful, though, to never combine text strings with binary strings. If you
99 need text in a binary stream, encode your text strings first using the
100 appropriate encoding, then join them with binary strings. See also: "What if I
101 don't encode?".
102 .SS "When should I decode or encode?"
103 .IX Subsection "When should I decode or encode?"
104 Whenever you're communicating text with anything that is external to your perl
105 process, like a database, a text file, a socket, or another program. Even if
106 the thing you're communicating with is also written in Perl.
107 .SS "What if I don't decode?"
108 .IX Subsection "What if I don't decode?"
109 Whenever your encoded, binary string is used together with a text string, Perl
110 will assume that your binary string was encoded with ISO\-8859\-1, also known as
111 latin\-1. If it wasn't latin\-1, then your data is unpleasantly converted. For
112 example, if it was UTF\-8, the individual bytes of multibyte characters are seen
113 as separate characters, and then again converted to UTF\-8. Such double encoding
114 can be compared to double HTML encoding (\f(CW\*(C`&amp;gt;\*(C'\fR), or double URI encoding
115 (\f(CW%253E\fR).
116 .PP
117 This silent implicit decoding is known as "upgrading". That may sound
118 positive, but it's best to avoid it.
119 .SS "What if I don't encode?"
120 .IX Subsection "What if I don't encode?"
121 It depends on what you output and how you output it.
122 .PP
123 \fIOutput via a filehandle\fR
124 .IX Subsection "Output via a filehandle"
125 .IP \(bu 4
126 If the string's characters are all code point 255 or lower, Perl
127 outputs bytes that match those code points. This is what happens with encoded
128 strings. It can also, though, happen with unencoded strings that happen to be
129 all code point 255 or lower.
130 .IP \(bu 4
131 Otherwise, Perl outputs the string encoded as UTF\-8. This only happens
132 with strings you neglected to encode. Since that should not happen, Perl also
133 throws a "wide character" warning in this case.
134 .PP
135 \fIOther output mechanisms (e.g., \fR\f(CI\*(C`exec\*(C'\fR\fI, \fR\f(CI\*(C`chdir\*(C'\fR\fI, ..)\fR
136 .IX Subsection "Other output mechanisms (e.g., exec, chdir, ..)"
137 .PP
138 Your text string will be sent using the bytes in Perl's internal format.
139 .PP
140 Because the internal format is often UTF\-8, these bugs are hard to spot,
141 because UTF\-8 is usually the encoding you wanted! But don't be lazy, and don't
142 use the fact that Perl's internal format is UTF\-8 to your advantage. Encode
143 explicitly to avoid weird bugs, and to show to maintenance programmers that you
144 thought this through.
145 .SS "Is there a way to automatically decode or encode?"
146 .IX Subsection "Is there a way to automatically decode or encode?"
147 If all data that comes from a certain handle is encoded in exactly the same
148 way, you can tell the PerlIO system to automatically decode everything, with
149 the \f(CW\*(C`encoding\*(C'\fR layer. If you do this, you can't accidentally forget to decode
150 or encode anymore, on things that use the layered handle.
151 .PP
152 You can provide this layer when \f(CW\*(C`open\*(C'\fRing the file:
153 .PP
154 .Vb 2
155 \& open my $fh, \*(Aq>:encoding(UTF\-8)\*(Aq, $filename; # auto encoding on write
156 \& open my $fh, \*(Aq<:encoding(UTF\-8)\*(Aq, $filename; # auto decoding on read
157 .Ve
158 .PP
159 Or if you already have an open filehandle:
160 .PP
161 .Vb 1
162 \& binmode $fh, \*(Aq:encoding(UTF\-8)\*(Aq;
163 .Ve
164 .PP
165 Some database drivers for DBI can also automatically encode and decode, but
166 that is sometimes limited to the UTF\-8 encoding.
167 .SS "What if I don't know which encoding was used?"
168 .IX Subsection "What if I don't know which encoding was used?"
169 Do whatever you can to find out, and if you have to: guess. (Don't forget to
170 document your guess with a comment.)
171 .PP
172 You could open the document in a web browser, and change the character set or
173 character encoding until you can visually confirm that all characters look the
174 way they should.
175 .PP
176 There is no way to reliably detect the encoding automatically, so if people
177 keep sending you data without charset indication, you may have to educate them.
178 .SS "Can I use Unicode in my Perl sources?"
179 .IX Subsection "Can I use Unicode in my Perl sources?"
180 Yes, you can! If your sources are UTF\-8 encoded, you can indicate that with the
181 \&\f(CW\*(C`use utf8\*(C'\fR pragma.
182 .PP
183 .Vb 1
184 \& use utf8;
185 .Ve
186 .PP
187 This doesn't do anything to your input, or to your output. It only influences
188 the way your sources are read. You can use Unicode in string literals, in
189 identifiers (but they still have to be "word characters" according to \f(CW\*(C`\ew\*(C'\fR),
190 and even in custom delimiters.
191 .SS "Data::Dumper doesn't restore the UTF8 flag; is it broken?"
192 .IX Subsection "Data::Dumper doesn't restore the UTF8 flag; is it broken?"
193 No, Data::Dumper's Unicode abilities are as they should be. There have been
194 some complaints that it should restore the UTF8 flag when the data is read
195 again with \f(CW\*(C`eval\*(C'\fR. However, you should really not look at the flag, and
196 nothing indicates that Data::Dumper should break this rule.
197 .PP
198 Here's what happens: when Perl reads in a string literal, it sticks to 8 bit
199 encoding as long as it can. (But perhaps originally it was internally encoded
200 as UTF\-8, when you dumped it.) When it has to give that up because other
201 characters are added to the text string, it silently upgrades the string to
202 UTF\-8.
203 .PP
204 If you properly encode your strings for output, none of this is of your
205 concern, and you can just \f(CW\*(C`eval\*(C'\fR dumped data as always.
206 .SS "Why do regex character classes sometimes match only in the ASCII range?"
207 .IX Subsection "Why do regex character classes sometimes match only in the ASCII range?"
208 Starting in Perl 5.14 (and partially in Perl 5.12), just put a
209 \&\f(CW\*(C`use feature \*(Aqunicode_strings\*(Aq\*(C'\fR near the beginning of your program.
210 Within its lexical scope you shouldn't have this problem. It also is
211 automatically enabled under \f(CW\*(C`use feature \*(Aq:5.12\*(Aq\*(C'\fR or \f(CW\*(C`use v5.12\*(C'\fR or
212 using \f(CW\*(C`\-E\*(C'\fR on the command line for Perl 5.12 or higher.
213 .PP
214 The rationale for requiring this is to not break older programs that
215 rely on the way things worked before Unicode came along. Those older
216 programs knew only about the ASCII character set, and so may not work
217 properly for additional characters. When a string is encoded in UTF\-8,
218 Perl assumes that the program is prepared to deal with Unicode, but when
219 the string isn't, Perl assumes that only ASCII
220 is wanted, and so those characters that are not ASCII
221 characters aren't recognized as to what they would be in Unicode.
222 \&\f(CW\*(C`use feature \*(Aqunicode_strings\*(Aq\*(C'\fR tells Perl to treat all characters as
223 Unicode, whether the string is encoded in UTF\-8 or not, thus avoiding
224 the problem.
225 .PP
226 However, on earlier Perls, or if you pass strings to subroutines outside
227 the feature's scope, you can force Unicode rules by changing the
228 encoding to UTF\-8 by doing \f(CWutf8::upgrade($string)\fR. This can be used
229 safely on any string, as it checks and does not change strings that have
230 already been upgraded.
231 .PP
232 For a more detailed discussion, see Unicode::Semantics on CPAN.
233 .SS "Why do some characters not uppercase or lowercase correctly?"
234 .IX Subsection "Why do some characters not uppercase or lowercase correctly?"
235 See the answer to the previous question.
236 .SS "How can I determine if a string is a text string or a binary string?"
237 .IX Subsection "How can I determine if a string is a text string or a binary string?"
238 You can't. Some use the UTF8 flag for this, but that's misuse, and makes well
239 behaved modules like Data::Dumper look bad. The flag is useless for this
240 purpose, because it's off when an 8 bit encoding (by default ISO\-8859\-1) is
241 used to store the string.
242 .PP
243 This is something you, the programmer, has to keep track of; sorry. You could
244 consider adopting a kind of "Hungarian notation" to help with this.
245 .SS "How do I convert from encoding FOO to encoding BAR?"
246 .IX Subsection "How do I convert from encoding FOO to encoding BAR?"
247 By first converting the FOO-encoded byte string to a text string, and then the
248 text string to a BAR-encoded byte string:
249 .PP
250 .Vb 2
251 \& my $text_string = decode(\*(AqFOO\*(Aq, $foo_string);
252 \& my $bar_string = encode(\*(AqBAR\*(Aq, $text_string);
253 .Ve
254 .PP
255 or by skipping the text string part, and going directly from one binary
256 encoding to the other:
257 .PP
258 .Vb 2
259 \& use Encode qw(from_to);
260 \& from_to($string, \*(AqFOO\*(Aq, \*(AqBAR\*(Aq); # changes contents of $string
261 .Ve
262 .PP
263 or by letting automatic decoding and encoding do all the work:
264 .PP
265 .Vb 3
266 \& open my $foofh, \*(Aq<:encoding(FOO)\*(Aq, \*(Aqexample.foo.txt\*(Aq;
267 \& open my $barfh, \*(Aq>:encoding(BAR)\*(Aq, \*(Aqexample.bar.txt\*(Aq;
268 \& print { $barfh } $_ while <$foofh>;
269 .Ve
270 .ie n .SS "What are ""decode_utf8"" and ""encode_utf8""?"
271 .el .SS "What are \f(CWdecode_utf8\fP and \f(CWencode_utf8\fP?"
272 .IX Subsection "What are decode_utf8 and encode_utf8?"
273 These are alternate syntaxes for \f(CW\*(C`decode(\*(Aqutf8\*(Aq, ...)\*(C'\fR and \f(CW\*(C`encode(\*(Aqutf8\*(Aq,
274 \&...)\*(C'\fR. Do not use these functions for data exchange. Instead use
275 \&\f(CW\*(C`decode(\*(AqUTF\-8\*(Aq, ...)\*(C'\fR and \f(CW\*(C`encode(\*(AqUTF\-8\*(Aq, ...)\*(C'\fR; see
276 "What's the difference between UTF\-8 and utf8?" below.
277 .SS "What is a ""wide character""?"
278 .IX Subsection "What is a ""wide character""?"
279 This is a term used for characters occupying more than one byte.
280 .PP
281 The Perl warning "Wide character in ..." is caused by such a character.
282 With no specified encoding layer, Perl tries to
283 fit things into a single byte. When it can't, it
284 emits this warning (if warnings are enabled), and uses UTF\-8 encoded data
285 instead.
286 .PP
287 To avoid this warning and to avoid having different output encodings in a single
288 stream, always specify an encoding explicitly, for example with a PerlIO layer:
289 .PP
290 .Vb 1
291 \& binmode STDOUT, ":encoding(UTF\-8)";
292 .Ve
293 .SH INTERNALS
294 .IX Header "INTERNALS"
295 .SS "What is ""the UTF8 flag""?"
296 .IX Subsection "What is ""the UTF8 flag""?"
297 Please, unless you're hacking the internals, or debugging weirdness, don't
298 think about the UTF8 flag at all. That means that you very probably shouldn't
299 use \f(CW\*(C`is_utf8\*(C'\fR, \f(CW\*(C`_utf8_on\*(C'\fR or \f(CW\*(C`_utf8_off\*(C'\fR at all.
300 .PP
301 The UTF8 flag, also called SvUTF8, is an internal flag that indicates that the
302 current internal representation is UTF\-8. Without the flag, it is assumed to be
303 ISO\-8859\-1. Perl converts between these automatically. (Actually Perl usually
304 assumes the representation is ASCII; see "Why do regex character classes
305 sometimes match only in the ASCII range?" above.)
306 .PP
307 One of Perl's internal formats happens to be UTF\-8. Unfortunately, Perl can't
308 keep a secret, so everyone knows about this. That is the source of much
309 confusion. It's better to pretend that the internal format is some unknown
310 encoding, and that you always have to encode and decode explicitly.
311 .ie n .SS "What about the ""use bytes"" pragma?"
312 .el .SS "What about the \f(CWuse bytes\fP pragma?"
313 .IX Subsection "What about the use bytes pragma?"
314 Don't use it. It makes no sense to deal with bytes in a text string, and it
315 makes no sense to deal with characters in a byte string. Do the proper
316 conversions (by decoding/encoding), and things will work out well: you get
317 character counts for decoded data, and byte counts for encoded data.
318 .PP
319 \&\f(CW\*(C`use bytes\*(C'\fR is usually a failed attempt to do something useful. Just forget
320 about it.
321 .ie n .SS "What about the ""use encoding"" pragma?"
322 .el .SS "What about the \f(CWuse encoding\fP pragma?"
323 .IX Subsection "What about the use encoding pragma?"
324 Don't use it. Unfortunately, it assumes that the programmer's environment and
325 that of the user will use the same encoding. It will use the same encoding for
326 the source code and for STDIN and STDOUT. When a program is copied to another
327 machine, the source code does not change, but the STDIO environment might.
328 .PP
329 If you need non-ASCII characters in your source code, make it a UTF\-8 encoded
330 file and \f(CW\*(C`use utf8\*(C'\fR.
331 .PP
332 If you need to set the encoding for STDIN, STDOUT, and STDERR, for example
333 based on the user's locale, \f(CW\*(C`use open\*(C'\fR.
334 .ie n .SS "What is the difference between "":encoding"" and "":utf8""?"
335 .el .SS "What is the difference between \f(CW:encoding\fP and \f(CW:utf8\fP?"
336 .IX Subsection "What is the difference between :encoding and :utf8?"
337 Because UTF\-8 is one of Perl's internal formats, you can often just skip the
338 encoding or decoding step, and manipulate the UTF8 flag directly.
339 .PP
340 Instead of \f(CW:encoding(UTF\-8)\fR, you can simply use \f(CW\*(C`:utf8\*(C'\fR, which skips the
341 encoding step if the data was already represented as UTF8 internally. This is
342 widely accepted as good behavior when you're writing, but it can be dangerous
343 when reading, because it causes internal inconsistency when you have invalid
344 byte sequences. Using \f(CW\*(C`:utf8\*(C'\fR for input can sometimes result in security
345 breaches, so please use \f(CW:encoding(UTF\-8)\fR instead.
346 .PP
347 Instead of \f(CW\*(C`decode\*(C'\fR and \f(CW\*(C`encode\*(C'\fR, you could use \f(CW\*(C`_utf8_on\*(C'\fR and \f(CW\*(C`_utf8_off\*(C'\fR,
348 but this is considered bad style. Especially \f(CW\*(C`_utf8_on\*(C'\fR can be dangerous, for
349 the same reason that \f(CW\*(C`:utf8\*(C'\fR can.
350 .PP
351 There are some shortcuts for oneliners;
352 see \-C in perlrun.
353 .ie n .SS "What's the difference between ""UTF\-8"" and ""utf8""?"
354 .el .SS "What's the difference between \f(CWUTF\-8\fP and \f(CWutf8\fP?"
355 .IX Subsection "What's the difference between UTF-8 and utf8?"
356 \&\f(CW\*(C`UTF\-8\*(C'\fR is the official standard. \f(CW\*(C`utf8\*(C'\fR is Perl's way of being liberal in
357 what it accepts. If you have to communicate with things that aren't so liberal,
358 you may want to consider using \f(CW\*(C`UTF\-8\*(C'\fR. If you have to communicate with things
359 that are too liberal, you may have to use \f(CW\*(C`utf8\*(C'\fR. The full explanation is in
360 "UTF\-8 vs. utf8 vs. UTF8" in Encode.
361 .PP
362 \&\f(CW\*(C`UTF\-8\*(C'\fR is internally known as \f(CW\*(C`utf\-8\-strict\*(C'\fR. The tutorial uses UTF\-8
363 consistently, even where utf8 is actually used internally, because the
364 distinction can be hard to make, and is mostly irrelevant.
365 .PP
366 For example, utf8 can be used for code points that don't exist in Unicode, like
367 9999999, but if you encode that to UTF\-8, you get a substitution character (by
368 default; see "Handling Malformed Data" in Encode for more ways of dealing with
369 this.)
370 .PP
371 Okay, if you insist: the "internal format" is utf8, not UTF\-8. (When it's not
372 some other encoding.)
373 .SS "I lost track; what encoding is the internal format really?"
374 .IX Subsection "I lost track; what encoding is the internal format really?"
375 It's good that you lost track, because you shouldn't depend on the internal
376 format being any specific encoding. But since you asked: by default, the
377 internal format is either ISO\-8859\-1 (latin\-1), or utf8, depending on the
378 history of the string. On EBCDIC platforms, this may be different even.
379 .PP
380 Perl knows how it stored the string internally, and will use that knowledge
381 when you \f(CW\*(C`encode\*(C'\fR. In other words: don't try to find out what the internal
382 encoding for a certain string is, but instead just encode it into the encoding
383 that you want.
384 .SH AUTHOR
385 .IX Header "AUTHOR"
386 Juerd Waalboer <#####@juerd.nl>
387 .SH "SEE ALSO"
388 .IX Header "SEE ALSO"
389 perlunicode, perluniintro, Encode