diff options
author | Rafael Garcia-Suarez <rgarciasuarez@gmail.com> | 2006-10-31 14:29:07 +0000 |
---|---|---|
committer | Rafael Garcia-Suarez <rgarciasuarez@gmail.com> | 2006-10-31 14:29:07 +0000 |
commit | 51dfe3f7e03fd8d2e9dadd18c223dce6ad08480f (patch) | |
tree | 22d558caca6a7a4bb341361eeae1cc609b94fc99 /ext/PerlIO | |
parent | baa5e62136a4e1c91752d5aeb5e1b5e5dbaadaf3 (diff) | |
download | perl-51dfe3f7e03fd8d2e9dadd18c223dce6ad08480f.tar.gz |
Doc clarification for PerlIO::encoding
(thanks to Steve Hay)
p4raw-id: //depot/perl@29173
Diffstat (limited to 'ext/PerlIO')
-rw-r--r-- | ext/PerlIO/encoding/encoding.pm | 14 |
1 files changed, 8 insertions, 6 deletions
diff --git a/ext/PerlIO/encoding/encoding.pm b/ext/PerlIO/encoding/encoding.pm index 529543a12c..c99e70b5a6 100644 --- a/ext/PerlIO/encoding/encoding.pm +++ b/ext/PerlIO/encoding/encoding.pm @@ -25,6 +25,8 @@ PerlIO::encoding - encoding layer =head1 SYNOPSIS + use PerlIO::encoding; + open($f, "<:encoding(foo)", "infoo"); open($f, ">:encoding(bar)", "outbar"); @@ -33,16 +35,16 @@ PerlIO::encoding - encoding layer =head1 DESCRIPTION -Open a filehandle with a transparent encoding filter. +This PerlIO layer opens a filehandle with a transparent encoding filter. -On input, convert the bytes expected to be in the specified +On input, it converts the bytes expected to be in the specified character set and encoding to Perl string data (Unicode and -Perl's internal Unicode encoding, UTF-8). On output, convert +Perl's internal Unicode encoding, UTF-8). On output, it converts Perl string data into the specified character set and encoding. -When the layer is pushed the current value of C<$PerlIO::encoding::fallback> -is saved and used as the CHECK argument when calling the Encode methods encode() -and decode(). +When the layer is pushed, the current value of C<$PerlIO::encoding::fallback> +is saved and used as the CHECK argument when calling the Encode methods +encode() and decode(). =head1 SEE ALSO |