$Id: README,v 1.4 1995/07/25 08:00:45 dimka Exp $

TclRl extension -- GNU Readline  support for Tcl7.3 & Tcl7.4
-------------------------------------------------------------

This extension based on GNU Readline-2.0 library .
TclRl adds a new command called `readline'  to Tcl. 
This command works like [gets stdin] command , but it calls 
readline() instead of plain read() . Realine command allows 
to user:
   * edit command line 

   * run build-in functions and user-defined 
     tcl scripts bound to key sequences

   * use different keymaps

   * approximately all other features provided by GNU Readline

License
-------

This peace of software distributed under GNU Public License.
Please see file COPYING for more information.

Install
--------

In order to receive full functionality you should recompile 
GNU Readline-2.0 with patch supplied:

* Get readline-2.0.tar.gz , unpack and open it 
* Now copy readline.c.patch from the TclRl distribution to 
  readline-2.0 dir and do
     patch readline.c < readline.c.patch
* Compile readline-2.0 according to the package instructions.

This patch allows binding of an tcl script to any key sequence. 
Without the patch only one-key long sequence can be bound.
Compile TclRl library and rlsh:

* Run `configure` script. You can specify the following options:
	--with-tcl=path    
	                   used to define path to tcl libraries 
                           and includes. Configure will search
                           them in 'path/include' and 'path/lib'
                           directories. Path defaults to 
                            /usr/local .
        --with-readline=path
                           same as previous one, for GNU readline 
                           Path dcefaults to /usr/local.
        --with-dbg         Turns on debug support.
  Configure automatically checks whether you have Readline patched 
  and defines STRONG_BINDING flag is so.
* Do `make`

Examples
--------

Directory 'examples' contain file tclrsh.tcl. Try to run 
`rlsh examples/tclrsh.tcl` this will turn plain tcl shell to 
tcsh-like mode.

Documentation
-------------

File tclrl.ps contains complete programming guide for TclRl. 
Please read it and send to me any comments. 
Sorry, I am not a native English speaker so this documentation
has many language mistakes. EVERYONE WHO CAN CORRECT MY POOR
WRITING IS WELCOME.

Availability
------------

ftp://tochna.technion.ac.il/pub/staff/dimka/tclrl/tclrl-0.2.tar.gz
I will upload this package to alcatel archive soon.
This depends on how many people will interested in it.

Testing
--------

I have tested this package on DEC Alpha running OSF/1
and DEC 5000/200 under Ultrix 4.3.a.

Author
------
Dimitry Kloper  <dimka@tochna.technion.ac.il>


