# -*- make -*-
#
# FILE: "/home/joze/src/tclreadline/Makefile.in"
# LAST MODIFIED: "Sun Feb 28 18:19:55 1999 (joze)"
# LAST MODIFIED: "Sun Feb 28 19:44:53 1999 (joze)"
# (C) 1998, 1999 by Johannes Zellner
# Johannes.Zellner@physik.uni-karlsruhe.de
# $Id$
# ---
#
# tclreadline -- gnu readline for tcl
# Copyright (C) 1999  Johannes Zellner

OBJS = tclreadline.o

CSRCS = $(TOP_DIR)/tclreadline.c
TCLFILES = tclreadlineInit.tcl tclreadlineSetup.tcl

SOURCES = \
    Makefile.in \
    tclreadline.n.in \
    configure.in \
    tclreadline.c \
    tclreadline.h.in \
    tclreadlineConfig.sh.in \
    tclreadlineInit.tcl.in \
    tclreadlineSetup.tcl.in \
    tclreadline.n.in \

.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$
.\" ---
.\"
.\" tclreadline -- gnu readline for the tcl scripting language
.\" Copyright (C) 1999  Johannes Zellner

.TP 6
\fB::tclreadline::readline\fP \fIcommand\fP [\fIoptions\fP]


.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 
\fB::tclreadline::readline read\fP command has to be called explicitly.
command will print a prompt and return the line which was typed
by the user.

.PP

The advantage of \fBtclreadline\fP is that it uses the callback
handler mechanism of the gnu readline while it processes tcl
events. This way X events from a wish gui will processed as
well as events from the \fPtclreadline\fP line interface.