This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Add just a little bit more explanation to PerlIO::encoding.
authorJarkko Hietaniemi <jhi@iki.fi>
Wed, 17 Apr 2002 12:43:07 +0000 (12:43 +0000)
committerJarkko Hietaniemi <jhi@iki.fi>
Wed, 17 Apr 2002 12:43:07 +0000 (12:43 +0000)
p4raw-id: //depot/perl@15967

ext/PerlIO/encoding/encoding.pm

index b29373e..63df000 100644 (file)
@@ -12,10 +12,19 @@ PerlIO::encoding - encoding layer
 
 =head1 SYNOPSIS
 
-   open($fh,"<...",\$scalar);
+   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);
 
 =head1 DESCRIPTION
 
+Open scalars for "in memory" input and output.  The scalars will
+behave as if they were files.
+
 =cut