README
1LEGALESE
2~~~~~~~~
3 Copyright (c) 1995 Ilya Zakharevich. All rights reserved.
4 This program is free software; you can redistribute it and/or
5 modify it under the same terms as Perl itself.
6
7 You should have received a copy of the Perl license along with
8 Perl; see the file README in Perl distribution.
9
10 You should have received a copy of the GNU General Public License
11 along with Perl; see the file Copying. If not, write to
12 the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
13
14 You should have received a copy of the Artistic License
15 along with Perl; see the file Artistic.
16
17
18Author of this software makes no claim whatsoever about suitability,
19reliability, edability, editability or usability of this product, and
20should not be kept liable for any damage resulting from the use of
21it. If you can use it, you are in luck, if not, I should not be kept
22responsible. Keep a handy copy of your backup tape at hand.
23
24WHAT
25~~~~
26
27This is a quick implementation of the minimal interface to Readline
28libraries. The implementation is made in Perl (mostly) by Jeffrey
29Friedl. The only thing this library does is to make it conformant (and
30add some minimal changes, like using Term::ReadKey if present, and
31correct work under xterm).
32
33(In fact this is an understatement now, a lot of additions are made,
34see CHANGES...)
35
36INSTALL
37~~~~~~~
38
39To install this module type
40
41 perl Makefile.PL
42 make
43 make test
44 or (with newer makemaker)
45 make test_dynamic
46 (Check whether you are satisfied with the results. Try
47 to redirect stdin and/or stdout.)
48 make install
49
50You may need to install Term::ReadKey first if your system is new (Solaris
51is ;-(). (Available in standard places, checked with 1.98.)
52
53If you see something like
54
55Can't ioctl TIOCGETP: Invalid argument at ...
56
57this means you need ReadKey.
58
59Note that as of 0.95 Term/ReadLine.pm is unbundled to make CPAN.pm happier.
60On the other hand, if you get newer Term/ReadLine.pm (say, by installing
61newer Perl) you may get more features enabled.
62
63For most features of T::R::P one needs to look in the CHANGES file, and the
64comments at the start of of readline/readline.pm. Volunteers to make the
65corresponding OO interface into POD are welcome (wrappers are available in
66Term::ReadLine::Perl; see perl5db.pl for a sample usage of hairier features,
67such as accessing Readline variables and methods).
68
69AUTHOR BUGS
70~~~~~~~~~~~
71Ilya Zakharevich
72cpan@ilyaz.org
73
74Std dstribution site: http://www.ilyaz.org/software/perl/modules
75