Add just a little bit more explanation to PerlIO::encoding.
[p5sagit/p5-mst-13.2.git] / ext / PerlIO / encoding / encoding.pm
1 package PerlIO::encoding;
2 our $VERSION = '0.01';
3 use XSLoader ();
4 use Encode;
5 XSLoader::load 'PerlIO::encoding';
6 1;
7 __END__
8
9 =head1 NAME
10
11 PerlIO::encoding - encoding layer
12
13 =head1 SYNOPSIS
14
15    open($fh, "<",  \$scalar);
16    open($fh, ">",  \$scalar);
17    open($fh, ">>", \$scalar);
18
19    open($fh, "<...",  \$scalar); # for example open($fh, "<:crlf", \$scalar);
20    open($fh, ">...",  \$scalar); # for example open($fh, ">:utf8", \$scalar);
21    open($fh, ">>..",  \$scalar);
22
23 =head1 DESCRIPTION
24
25 Open scalars for "in memory" input and output.  The scalars will
26 behave as if they were files.
27
28 =cut
29
30