Outline docs for PerlIO and PerlIO::Scalar

[perl5.git] / ext / PerlIO / Scalar / Scalar.pm

diff --git a/ext/PerlIO/Scalar/Scalar.pm b/ext/PerlIO/Scalar/Scalar.pm
index e733a72..2879407 100644 (file)
--- 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
+
+