Jarkko Hietaniemi > perl-5.7.3 > utf8

Download:
perl-5.7.3.tar.gz

Dependencies

Annotate this POD (1)

Module Version: 1.00   Source   Latest Release: perl-5.20.1-RC1

NAME ^

utf8 - Perl pragma to enable/disable UTF-8 (or UTF-EBCDIC) in source code

SYNOPSIS ^

    use utf8;
    no utf8;

DESCRIPTION ^

The use utf8 pragma tells the Perl parser to allow UTF-8 in the program text in the current lexical scope (allow UTF-EBCDIC on EBCDIC based platforms). The no utf8 pragma tells Perl to switch back to treating the source text as literal bytes in the current lexical scope.

This pragma is primarily a compatibility device. Perl versions earlier than 5.6 allowed arbitrary bytes in source code, whereas in future we would like to standardize on the UTF-8 encoding for source text. Until UTF-8 becomes the default format for source text, this pragma should be used to recognize UTF-8 in the source. When UTF-8 becomes the standard source format, this pragma will effectively become a no-op. For convenience in what follows the term UTF-X is used to refer to UTF-8 on ASCII and ISO Latin based platforms and UTF-EBCDIC on EBCDIC based platforms.

Enabling the utf8 pragma has the following effect:

Note that if you have bytes with the eighth bit on in your script (for example embedded Latin-1 in your string literals), use utf8 will be unhappy since the bytes are most probably not well-formed UTF-8. If you want to have such bytes and use utf8, you can disable utf8 until the end the block (or file, if at top level) by no utf8;.

Utility functions

The following functions are defined in the utf8:: package by the perl core.

utf8::encode is like utf8::upgrade but the UTF8 flag does not get turned on. See perlunicode for more on the UTF8 flag and the C API functions sv_utf8_upgrade, sv_utf8_downgrade, sv_utf8_encode, sv_utf8_decode that are wrapped by the Perl functions utf8::upgrade, utf8::downgrade, utf8::encode and utf8::decode.

SEE ALSO ^

perlunicode, bytes

syntax highlighting: