diff options
| author | Nick Ing-Simmons <nik@tiuk.ti.com> | 2001-03-27 21:18:58 +0000 |
|---|---|---|
| committer | Nick Ing-Simmons <nik@tiuk.ti.com> | 2001-03-27 21:18:58 +0000 |
| commit | b3d30bf7e271096b5b02c85f1129c4e49c36a709 (patch) | |
| tree | 2666567d763997d5abdb533cb37bec19cb9953b2 /ext/PerlIO | |
| parent | e7a1fdd7863072044ba7ced152ae990afb435b16 (diff) | |
| download | perl-b3d30bf7e271096b5b02c85f1129c4e49c36a709.tar.gz | |
Outline docs for PerlIO and PerlIO::Scalar
p4raw-id: //depot/perlio@9395
Diffstat (limited to 'ext/PerlIO')
| -rw-r--r-- | ext/PerlIO/Scalar/Scalar.pm | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/ext/PerlIO/Scalar/Scalar.pm b/ext/PerlIO/Scalar/Scalar.pm index e733a72c1b..28794079d3 100644 --- a/ext/PerlIO/Scalar/Scalar.pm +++ b/ext/PerlIO/Scalar/Scalar.pm @@ -4,3 +4,23 @@ use XSLoader (); XSLoader::load 'PerlIO::Scalar'; 1; __END__ + +=head1 NAME + +PerlIO::Scalar - support module for in-memory IO. + +=head1 SYNOPSIS + + open($fh,"<...",\$scalar); + +=head1 DESCRIPTION + +C<PerlIO::Scalar> only exists to use XSLoader to load C code that provides +support for treating a scalar as an "in memory" file. + +All normal file operations can be performed on the handle. The scalar is considered +a stream of bytes. Currently fileno($fh) returns C<undef>. + +=cut + + |