@@ -71,11 +71,11 @@ For the functionality of the GNU readline you should refer to the readline's documentation. .PP The following list will give all commands, which are currently -implemented in the shared lib (e.g. libtclreadline@TCLREADLINE_VERSION@.so). +implemented in the shared lib (e.g. libtclreadline@VERSION@.so). Additional commands were introduced in a startup script \fBtclreadlineSetup.tcl\fP, which lives in the tclreadline installation directory. (typically something like /usr/local/lib/tclreadline ..) These commands are primarily for internal use and not documented here. @@ -143,11 +143,11 @@ \fBtclreadline::readline eof\fP returns the current eof script. .TP 5 \fB::tclreadline::readline initialize\fP \fIhistoryfile\fP initialize the tclreadline interface and read the history from -the \fIhistoryfile\fP. On succes an empty string is returned. +the \fIhistoryfile\fP. On success an empty string is returned. This command has to be called before any other tclreadline commands. .TP 5 \fB::tclreadline::readline read\fP \fIprompt\fP prints the \fIprompt\fP to stdout and enters the tclreadline event @@ -209,11 +209,11 @@ .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 -something like "[info nameofexecutable] \[[pwd]\]" possibly fancy colored. +something like "[info nameofexecutable] \\[[pwd]\\]" possibly fancy colored. The default proc is defined on entering the ::tclreadline::Loop, if it is not already defined. So: If you define your own proc ::tclreadline::prompt1 before entering ::tclreadline::Loop, this proc is called each time the prompt is to be displayed. Example: @@ -230,10 +230,15 @@ Note that non-printable control characters as color control characters must be enclosed in literal ctrl-a / ctrl-b to tell readline the length of the printable prompt. See for example the variable `prompt_string' in the file tclreadlineSetup.tcl in your tclreadline installation directory. +.TP 5 +\fB::tclreadline::prompt2\fP +a proc which is called by ::tclreadline::Loop and returns a string +which will be displayed as the secondary prompt when interactively +prompting for continuation of an incomplete command. .\" .SH "EXAMPLES" .\" .SH "ENVIRONMENT VARIABLES" @@ -240,24 +245,24 @@ .SH "VARIABLES" \fItclreadline\fP defines the following variables in the namespace \fI::tclreadline\fP: -(for backwards compatiblity the global variables tclreadline_version, +(for backwards compatibility the global variables tclreadline_version, tclreadline_patchLevel and tclreadline_library are still present). .TP 5 \fBtclreadline::version\fP (read-only) -holds the version string "@TCLREADLINE_VERSION@". +holds the version string "@VERSION@". .TP 5 \fBtclreadline::patchLevel\fP (read-only) holds the patch level string "@PATCHLEVEL_STR@". .TP 5 \fBtclreadline::library\fP (read-only) -holds the library string "@TCLREADLINE_LIBRARY@". +holds the library string "@TCLRL_DIR@". .TP 5 \fBtclreadline::license\fP (read-only) holds a BSD license statement.