@@ -1,9 +1,9 @@ .TH tclreadline 1 "@TCLREADLINE_VERSION@" "Johannes Zellner" .\" FILE: "/home/joze/src/tclreadline/tclreadline.n.in" -.\" LAST MODIFIED: "Sun Feb 28 18:25:37 1999 (joze)" +.\" LAST MODIFIED: "Sun Feb 28 19:43:29 1999 (joze)" .\" (C) 1999 by Johannes Zellner .\" Johannes.Zellner@physik.uni-karlsruhe.de .\" $Id$ .\" --- .\" @@ -38,18 +38,18 @@ .SH DESCRIPTION The \fBtclreadline\fP package makes the gnu readline available -to the scripting language tcl. The package is thought primarily -for developers, who want to use the line editing and history expansion -capabilities of the gnu readline while interactively developing -tcl scripts. tclreadline can also be used for tcl scripts +to the scripting language tcl. The primary purpose of the package +is to facilitate the interactive script development by the means +of word and file name completion as well as history expansion +(well known from shells like bash). + +Additionally tclreadline can also be used for tcl scripts which want to use a shell like input interface. In this case the -\fB::tclreadline::read\fP command has to be called explicitly. This -command will print a prompt and return the line which was typed -by the user. +\fB::tclreadline::readline read\fP command has to be called explicitly. .PP The advantage of \fBtclreadline\fP is that it uses the callback handler mechanism of the gnu readline while it processes tcl