From: Rafael Garcia-Suarez Date: Tue, 31 Oct 2006 14:29:07 +0000 (+0000) Subject: Doc clarification for PerlIO::encoding X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=51dfe3f7e03fd8d2e9dadd18c223dce6ad08480f;p=p5sagit%2Fp5-mst-13.2.git Doc clarification for PerlIO::encoding (thanks to Steve Hay) p4raw-id: //depot/perl@29173 --- diff --git a/ext/PerlIO/encoding/encoding.pm b/ext/PerlIO/encoding/encoding.pm index 529543a..c99e70b 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