From: Jarkko Hietaniemi <jhi@iki.fi>
Date: Fri, 19 Apr 2002 00:43:45 +0000 (+0000)
Subject: The previous change on this was *ahem* slightly off-topic.
X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=b89cebd372b9cce8c52030d6cb406e962ff84b10;p=p5sagit%2Fp5-mst-13.2.git

The previous change on this was *ahem* slightly off-topic.

p4raw-id: //depot/perl@15998
---

diff --git a/ext/PerlIO/encoding/encoding.pm b/ext/PerlIO/encoding/encoding.pm
index 63df000..8c87831 100644
--- a/ext/PerlIO/encoding/encoding.pm
+++ b/ext/PerlIO/encoding/encoding.pm
@@ -12,18 +12,21 @@ PerlIO::encoding - encoding layer
 
 =head1 SYNOPSIS
 
-   open($fh, "<",  \$scalar);
-   open($fh, ">",  \$scalar);
-   open($fh, ">>", \$scalar);
-
-   open($fh, "<...",  \$scalar); # for example open($fh, "<:crlf", \$scalar);
-   open($fh, ">...",  \$scalar); # for example open($fh, ">:utf8", \$scalar);
-   open($fh, ">>..",  \$scalar);
+  open($f, "<:encoding(foo)", "infoo");
+  open($f, ">:encoding(bar)", "outbar");
 
 =head1 DESCRIPTION
 
-Open scalars for "in memory" input and output.  The scalars will
-behave as if they were files.
+Open a filehandle with a transparent encoding filter.
+
+On input, convert 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 string data into the specified character set and encoding.
+
+=head1 SEE ALSO
+
+L<open>, L<Encode>, L<perlfunc/binmode>, L<perluniintro>
 
 =cut