@@ -1,10 +1,10 @@ .TH tclreadline n "@TCLREADLINE_VERSION@" "Johannes Zellner" .\" (C) 1999 by Johannes Zellner .\" FILE: "/home/joze/src/tclreadline/tclreadline.n.in" -.\" LAST MODIFICATION: "Sun Aug 22 23:24:34 1999 (joze)" +.\" LAST MODIFICATION: "Mon Aug 23 00:15:10 1999 (joze)" .\" (C) 1998, 1999 by Johannes Zellner, .\" $Id$ .\" --- .\" .\" tclreadline -- gnu readline for the tcl scripting language @@ -121,11 +121,11 @@ with the four arguments \fI"$b"\fP, \fI"5"\fP, \fI"8"\fP and \fI"puts $b"\fP. The custom completer could return a string like "$bl $black $blue", which will complete "$b" to "$bl" (the longest match) and offer a list of two further matches "$black" and "$blue". -For further reference, see the proc tclreadline::script_completer in +For further reference, see the proc tclreadline::ScriptCompleter in the file tclreadlineSetup.tcl. .TP 5 \fB::tclreadline::readline builtincompleter\fP [\fIbool\fP] enable or disable the builtin completer. If the builtin completer @@ -166,17 +166,23 @@ \fB::tclreadline::Print\fP [\fIyes / no\fP] turns on or off the default behavior of tclsh to print the result of every command. This is turned on by default, so it will just behave as the tclsh w/o tclreadline. Turning off might be useful, when reading binary data for example. If \fB::tclreadline::Print\fP is called w/o -arguments, it just returns the current setting. +arguments, it returns the current setting. .TP 5 \fB::tclreadline::Loop\fP enter the tclreadline main loop. This command is typically called from the startup resource file (something .tclshrc, depending on the interpreter -you use). \fB::tclreadline::Loop\fP will normally not return. +you use, see the file `sample.tclshrc'). The main loop sets up some +completion characteristics as variable -- try something like "puts $b" -- +and command completion -- try "puts [in". +\fB::tclreadline::Loop\fP will normally not return. +If you want to write your own main loop and/or own custom completers, +it is probably a good idea to start with tclreadline::Loop +(see the file tclreadlineSetup.tcl). .TP 5 \fB::tclreadline::prompt1\fP a proc which is called by ::tclreadline::Loop and returns a string which will be displayed as the primary prompt. This prompt will be @@ -278,11 +284,17 @@ David Engel , .SH DEBIAN PACKAGE David Engel , -.SH HISTORY +.SH DISCLAIMER + This version of \fBtclreadline\fP is still a development version. Pretty a lot of features and ideas are not implemented yet. The reason for this is the lack of time and manpower. So you are welcome to modify and contribute to the code. If you have suggestions, please let me know. + +\fBtclreadline\fP comes with the GPL (GNU General Public License). +You should have received a copy of the GNU General Public License +along with this program; if not, write to the Free Software +Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.