LEGALESE
~~~~~~~~
    Copyright (c) 2013 Jordan M. Adler.  All rights reserved.
    Copyright (c) 1995 Ilya Zakharevich. All rights reserved.
    This program is free software; you can redistribute it and/or
    modify it under the same terms as Perl itself.

    You should have received a copy of the Perl license along with
    Perl; see the file README in Perl distribution.
 
	You should have received a copy of the GNU General Public License
	along with Perl; see the file Copying.  If not, write to
	the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.

	You should have received a copy of the Artistic License
	along with Perl; see the file Artistic.


Author of this software makes no claim whatsoever about suitability,
reliability, edability, editability or usability of this product, and
should not be kept liable for any damage resulting from the use of
it. If you can use it, you are in luck, if not, I should not be kept
responsible. Keep a handy copy of your backup tape at hand.

WHAT
~~~~

This is a quick implementation of the minimal interface to Readline
libraries. The implementation is made in Perl (mostly) by Jeffrey
Friedl. The only thing this library does is to make it conformant (and
add some minimal changes, like using Term::ReadKey if present, and
correct work under xterm). 

(In fact this is an understatement now, a lot of additions are made,
see CHANGES...)

INSTALL
~~~~~~~

You may need to install Term::ReadKey first if your system is new (Solaris
is ;-(). (Available in standard places, checked with 1.98.)

If you see something like

Can't ioctl TIOCGETP: Invalid argument at ...

this means you need ReadKey.

Note that as of 0.95 Term/ReadLine.pm is unbundled to make CPAN.pm happier.
On the other hand, if you get newer Term/ReadLine.pm (say, by installing
newer Perl) you may get more features enabled.

For most features of T::R::P one needs to look in the CHANGES file, and the
comments at the start of of readline/readline.pm.  Volunteers to make the
corresponding OO interface into POD are welcome (wrappers are available in
Term::ReadLine::Perl5; see perl5db.pl for a sample usage of hairier features,
such as accessing Readline variables and methods).

AUTHOR BUGS
~~~~~~~~~~~

Bugs are accepted via CPAN email, CPAN RT, or Github:
https://github.com/jmadler/p5-Term-ReadLine-Perl5

Jordan M. Adler