summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJarkko Hietaniemi <jhi@iki.fi>2002-04-19 00:43:45 +0000
committerJarkko Hietaniemi <jhi@iki.fi>2002-04-19 00:43:45 +0000
commitb89cebd372b9cce8c52030d6cb406e962ff84b10 (patch)
tree26d0f064f6b6bcd29506b123f65ffbb91b5846e9
parentcb0b211a477c3c0b17df40bb6ed00d1e751523d3 (diff)
downloadperl-b89cebd372b9cce8c52030d6cb406e962ff84b10.tar.gz
The previous change on this was *ahem* slightly off-topic.
p4raw-id: //depot/perl@15998
-rw-r--r--ext/PerlIO/encoding/encoding.pm21
1 files changed, 12 insertions, 9 deletions
diff --git a/ext/PerlIO/encoding/encoding.pm b/ext/PerlIO/encoding/encoding.pm
index 63df00045a..8c87831a73 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