summaryrefslogtreecommitdiff
path: root/lib/Term/ReadLine.pm
diff options
context:
space:
mode:
Diffstat (limited to 'lib/Term/ReadLine.pm')
-rw-r--r--lib/Term/ReadLine.pm9
1 files changed, 8 insertions, 1 deletions
diff --git a/lib/Term/ReadLine.pm b/lib/Term/ReadLine.pm
index 51044262fd..2ce7423186 100644
--- 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