Re: Debugger in beta3

[p5sagit/p5-mst-13.2.git] / lib / Term / ReadLine.pm

diff --git a/lib/Term/ReadLine.pm b/lib/Term/ReadLine.pm
index 5104426..2ce7423 100644 (file)
--- a/lib/Term/ReadLine.pm
+++ b/lib/Term/ReadLine.pm
@@ -1,6 +1,6 @@
 =head1 NAME
 
-C<Term::ReadLine>: Perl interface to various C<readline> packages. If
+Term::ReadLine - Perl interface to various C<readline> packages. If
 no real package is found, substitutes stubs instead of basic functions.
 
 =head1 SYNOPSIS
@@ -16,6 +16,13 @@ no real package is found, substitutes stubs instead of basic functions.
     $term->addhistory($_) if /\S/;
   }
 
+=head1 DESCRIPTION
+
+This package is just a front end to some other packages. At the moment
+this description is written, the only such package is Term-ReadLine,
+available on CPAN near you. The real target of this stub package is to
+set up a common interface to whatever Readline emerges with time.
+
 =head1 Minimal set of supported functions
 
 All the supported functions should be called as methods, i.e., either as