Check-in [e5343fb8ae]
Not logged in
Overview
Comment: Modified Files: tclreadline.n.in Added Files: Makefile.in tclreadline.c tclreadlineConfig.sh.in tclreadlineInit.tcl.in
Downloads: Tarball | ZIP archive | SQL archive
Timelines: family | ancestors | descendants | both | trunk
Files: files | file ages | folders
SHA1: e5343fb8ae1a1171dce9b18cf452291a02a6960c
User & Date: johannes@zellner.org on 1999-08-23 20:38:26
Other Links: manifest | tags
Context
1999-08-24
01:23
Modified Files: tclreadlineSetup.tcl.in Added Files: Makefile.in tclreadline.c tclreadlineConfig.sh.in tclreadlineInit.tcl.in check-in: 1ce074b566 user: johannes@zellner.org tags: trunk
1999-08-23
20:38
Modified Files: tclreadline.n.in Added Files: Makefile.in tclreadline.c tclreadlineConfig.sh.in tclreadlineInit.tcl.in check-in: e5343fb8ae user: johannes@zellner.org tags: trunk
20:04
Modified Files: configure.in Added Files: Makefile.in tclreadline.c tclreadlineConfig.sh.in tclreadlineInit.tcl.in check-in: bb8a6ef5b9 user: johannes@zellner.org tags: trunk
Changes
Hide Diffs Side-by-Side Diffs Ignore Whitespace Patch

Modified tclreadline.n.in from [d7922e5c29] to [25cdb5647d].

     1      1   .TH tclreadline n "@TCLREADLINE_VERSION@" "Johannes Zellner"
     2      2   
     3      3   .\" (C) 1999 by Johannes Zellner
     4      4   .\" FILE: "/home/joze/src/tclreadline/tclreadline.n.in"
     5         -.\" LAST MODIFICATION: "Mon Aug 23 00:15:10 1999 (joze)"
            5  +.\" LAST MODIFICATION: "Mon Aug 23 22:31:24 1999 (joze)"
     6      6   .\" (C) 1998, 1999 by Johannes Zellner, <johannes@zellner.org>
     7      7   .\" $Id$
     8      8   .\" ---
     9      9   .\"
    10     10   .\" tclreadline -- gnu readline for the tcl scripting language
    11     11   .\" Copyright (C) 1999  Johannes Zellner
    12     12   .\"
................................................................................
    23     23   .\" You should have received a copy of the GNU General Public License
    24     24   .\" along with this program; if not, write to the Free Software
    25     25   .\" Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
    26     26   .\"
    27     27   .\" <johannes@zellner.org>, http://www.zellner.org/tclreadline/
    28     28   
    29     29   
    30         -.SH NAME
           30  +.\"	# CS - begin code excerpt
           31  +.de CS
           32  +.RS
           33  +.nf
           34  +.ta .25i .5i .75i 1i
           35  +..
           36  +.\"	# CE - end code excerpt
           37  +.de CE
           38  +.fi
           39  +.RE
           40  +..
           41  +
           42  +.SH "NAME"
    31     43   tclreadline \- gnu readline for the tcl scripting language
    32     44   
    33         -
    34         -.SH SYNOPSIS
           45  +.SH "SYNOPSIS"
    35     46   .TP 6
    36     47   \fB::tclreadline::readline\fP \fIcommand\fP [\fIoptions\fP]
    37     48   
    38     49   
    39         -.SH DESCRIPTION
           50  +.SH "DESCRIPTION"
    40     51   
    41     52   The \fBtclreadline\fP package makes the gnu readline available
    42     53   to the scripting language tcl. The primary purpose of the package
    43     54   is to facilitate the interactive script development by the means
    44     55   of word and file name completion as well as history expansion
    45     56   (well known from shells like bash).
    46     57   
................................................................................
    59     70   
    60     71   \fBtclreadline\fP is basically a shared library and a few tcl scripts
    61     72   which are accessed with the tcl package require command. Therefore
    62     73   \fBtclreadline\fP should work with all common extensions like
    63     74   \fBblt, itcl, itk, tix ...\fP.
    64     75   
    65     76   
    66         -.\".SH SOURCE FILES
           77  +.\" .SH SOURCE FILES
    67     78   
    68     79   
    69         -.SH COMMANDS
           80  +.SH "COMMANDS"
    70     81   
    71     82   If you want to use \fBtclreadline\fP as a line interface
    72     83   for developing tcl scripts, you probably don't have to read
    73     84   this section.
    74     85   
    75     86   .PP
    76     87   The following list will give all commands, which are currently
................................................................................
   145    156   
   146    157   .TP 5
   147    158   \fB::tclreadline::readline initialize\fP \fIhistoryfile\fP
   148    159   initialize the tclreadline interface and read the history from
   149    160   the \fIhistoryfile\fP. On succes an empty string is returned.
   150    161   This command has to be called before any other tclreadline commands.
   151    162   
   152         -
   153    163   .TP 5
   154    164   \fB::tclreadline::readline read\fP \fIprompt\fP
   155    165   prints the \fIprompt\fP to stdout and enters the tclreadline event
   156    166   loop. Both readline and X events are processed. Returns the
   157    167   (eventually history-expanded) input string.
   158         -
   159    168   
   160    169   .TP 5
   161    170   \fB::tclreadline::readline write\fP \fIhistoryfile\fP
   162    171   writes the history to the \fIhistoryfile\fP. This command is called
   163    172   automatically from the internal routine ::tclreadline::Exit.
   164    173   
   165    174   .TP 5
................................................................................
   188    197   which will be displayed as the primary prompt. This prompt will be
   189    198   something like "[info nameofexecutable] \[[pwd]\]" possibly fancy colored.
   190    199   The default proc is defined on entering the ::tclreadline::Loop,
   191    200   if it is not already defined. So: If you define your own proc
   192    201   ::tclreadline::prompt1 before entering ::tclreadline::Loop, this
   193    202   proc is called each time the prompt is to be displayed.
   194    203   Example:
   195         -.EQ
          204  +.CS
   196    205       package require tclreadline
   197    206       namespace eval tclreadline {
   198    207           proc prompt1 {} {
   199    208               return "[clock format [clock seconds]]> "
   200    209           }
   201    210       }
   202    211       ::tclreadline::Loop
   203         -.EN
          212  +.CE
          213  +
   204    214   Note that non-printable control characters as color control characters
   205    215   must be enclosed in literal ctrl-a / ctrl-b to tell readline the length
   206    216   of the printable prompt. See for example the variable `prompt_string'
   207    217   in the file tclreadlineSetup.tcl in your tclreadline installation directory.
   208    218   
   209    219   
   210         -.\".SH "EXAMPLES"
          220  +.\" .SH "EXAMPLES"
   211    221   
   212    222   
   213         -.\".SH "ENVIRONMENT VARIABLES"
          223  +.\" .SH "ENVIRONMENT VARIABLES"
   214    224   
   215         -.SH VARIABLES
          225  +.SH "VARIABLES"
   216    226   
   217    227   The global variable \fBtclreadline_version\fP holds the version number
   218    228   of the tclreadline package.
   219    229   
   220         -.SH FILES
          230  +.SH "FILES"
   221    231   
   222    232   the \fB.tclshrc\fP file in the HOME directory, which
   223    233   is read on tclsh startup. Alternatively, the name of this initialization
   224    234   file might be \fB.wishrc\fP ... depending on what interpreter you use.
   225    235   These files should typically contain something like
   226         -
   227         -.EQ
          236  +.CS
   228    237       if {$tcl_interactive} {
   229    238           package require tclreadline
   230    239           ::tclreadline::Loop
   231    240       }
   232         -.EN
          241  +.CE
   233    242   
   234    243   which will enter the tclreadline main loop.
   235    244   
   236    245   .PP
   237    246   the \fB.tclsh-history\fP file in the HOME directory. On startup
   238    247   commands will be read from this file. On exit, the readline history
   239    248   is written to this file. Note that if you abort tclsh with <cntrl-c>
................................................................................
   243    252   .PP
   244    253   the \fB.inputrc\fP file in the users HOME directory. This file
   245    254   is used normally for all programs which use the gnu readline (e.g.  bash).
   246    255   The `global' readline settings there will be valid also for
   247    256   \fBtclreadline\fP. Additionally the .inputrc might hold conditional
   248    257   settings for the implementation name \fBtclreadline\fP. Example of 
   249    258   some lines in your .inputrc:
   250         -
   251         -.EQ
          259  +.CS
   252    260       $if tclreadline
   253    261       "\\C-xp": "puts $env(PATH)"
   254    262       $endif
   255         -.EN
          263  +.CE
   256    264   
   257    265   For further documentation please refer to the gnu readline documentation.
   258    266   
   259         -.SH BUGS
          267  +.SH "BUGS"
   260    268   probably.
   261    269   
   262    270   
   263         -.SH SEE ALSO
          271  +.SH "SEE ALSO"
   264    272   
   265    273   
   266    274   .PP
   267    275   The official \fBtclreadline\fP web site at:
   268    276   
   269    277   .PP
   270    278   .RS 4
   271    279   http://www.zellner.org/tclreadline/
   272    280   .RE
   273    281   
   274    282   
   275         -.SH AUTHOR
          283  +.SH "AUTHOR"
   276    284   Johannes Zellner, <johannes@zellner.org>
   277         -.br
   278         -.SH CONTRIBUTIONS, SUGGESTIONS AND PATCHES
          285  +
          286  +.SH "CONTRIBUTIONS, SUGGESTIONS AND PATCHES"
   279    287   Magnus Eriksson <magnus.eriksson@netinsight.se>,
   280    288   Les Johnson <les@infolabs.com>,
   281    289   Harald Kirsch <kir@iitb.fhg.de>,
   282    290   Christian Krone <krischan@sql.de>,
   283    291   Larry W. Virden <lvirden@cas.org>,
   284    292   David Engel <dlengel@home.com>, <david@debian.org>
   285    293   
   286         -.SH DEBIAN PACKAGE
          294  +.SH "DEBIAN PACKAGE"
   287    295   David Engel <dlengel@home.com>, <david@debian.org>
   288    296   
   289         -.SH DISCLAIMER
          297  +.SH "DISCLAIMER"
   290    298   
   291    299   This version of \fBtclreadline\fP is still a development version.
   292    300   Pretty a lot of features and ideas are not implemented yet. The
   293    301   reason for this is the lack of time and manpower.
   294    302   So you are welcome to modify and contribute to the code.
   295    303   If you have suggestions, please let me know.
   296    304   
   297    305   \fBtclreadline\fP comes with the GPL (GNU General Public License).
   298    306   You should have received a copy of the GNU General Public License
   299    307   along with this program; if not, write to the Free Software
   300    308   Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.