Hex Artifact Content
Not logged in

Artifact ec7927137d56807b0e85b6668811d518effc488d:


0000: 2e 54 48 20 74 63 6c 72 65 61 64 6c 69 6e 65 20  .TH tclreadline 
0010: 6e 20 22 40 50 41 54 43 48 4c 45 56 45 4c 5f 53  n "@PATCHLEVEL_S
0020: 54 52 40 22 20 22 4a 6f 68 61 6e 6e 65 73 20 5a  TR@" "Johannes Z
0030: 65 6c 6c 6e 65 72 22 0a 0a 2e 5c 22 20 46 49 4c  ellner"...\" FIL
0040: 45 3a 20 74 63 6c 72 65 61 64 6c 69 6e 65 2e 6e  E: tclreadline.n
0050: 2e 69 6e 0a 2e 5c 22 20 24 49 64 24 0a 2e 5c 22  .in..\" $Id$..\"
0060: 20 2d 2d 2d 0a 2e 5c 22 20 74 63 6c 72 65 61 64   ---..\" tclread
0070: 6c 69 6e 65 20 2d 2d 20 67 6e 75 20 72 65 61 64  line -- gnu read
0080: 6c 69 6e 65 20 66 6f 72 20 74 63 6c 0a 2e 5c 22  line for tcl..\"
0090: 20 68 74 74 70 3a 2f 2f 77 77 77 2e 7a 65 6c 6c   http://www.zell
00a0: 6e 65 72 2e 6f 72 67 2f 74 63 6c 72 65 61 64 6c  ner.org/tclreadl
00b0: 69 6e 65 2f 0a 2e 5c 22 20 43 6f 70 79 72 69 67  ine/..\" Copyrig
00c0: 68 74 20 28 63 29 20 31 39 39 38 20 2d 20 32 30  ht (c) 1998 - 20
00d0: 31 34 2c 20 4a 6f 68 61 6e 6e 65 73 20 5a 65 6c  14, Johannes Zel
00e0: 6c 6e 65 72 20 3c 6a 6f 68 61 6e 6e 65 73 40 7a  lner <johannes@z
00f0: 65 6c 6c 6e 65 72 2e 6f 72 67 3e 0a 2e 5c 22 20  ellner.org>..\" 
0100: 54 68 69 73 20 73 6f 66 74 77 61 72 65 20 69 73  This software is
0110: 20 63 6f 70 79 72 69 67 68 74 20 75 6e 64 65 72   copyright under
0120: 20 74 68 65 20 42 53 44 20 6c 69 63 65 6e 73 65   the BSD license
0130: 2e 0a 2e 5c 22 20 2d 2d 2d 0a 0a 0a 2e 5c 22 20  ...\" ---....\" 
0140: 23 20 43 53 20 2d 20 62 65 67 69 6e 20 63 6f 64  # CS - begin cod
0150: 65 20 65 78 63 65 72 70 74 0a 2e 64 65 20 43 53  e excerpt..de CS
0160: 0a 2e 52 53 0a 2e 6e 66 0a 2e 74 61 20 2e 32 35  ..RS..nf..ta .25
0170: 69 20 2e 35 69 20 2e 37 35 69 20 31 69 0a 2e 2e  i .5i .75i 1i...
0180: 0a 2e 5c 22 20 23 20 43 45 20 2d 20 65 6e 64 20  ..\" # CE - end 
0190: 63 6f 64 65 20 65 78 63 65 72 70 74 0a 2e 64 65  code excerpt..de
01a0: 20 43 45 0a 2e 66 69 0a 2e 52 45 0a 2e 2e 0a 0a   CE..fi..RE.....
01b0: 2e 53 48 20 22 4e 41 4d 45 22 0a 74 63 6c 72 65  .SH "NAME".tclre
01c0: 61 64 6c 69 6e 65 20 5c 2d 20 67 6e 75 20 72 65  adline \- gnu re
01d0: 61 64 6c 69 6e 65 20 66 6f 72 20 74 68 65 20 74  adline for the t
01e0: 63 6c 20 73 63 72 69 70 74 69 6e 67 20 6c 61 6e  cl scripting lan
01f0: 67 75 61 67 65 0a 0a 2e 53 48 20 22 53 59 4e 4f  guage...SH "SYNO
0200: 50 53 49 53 22 0a 2e 54 50 20 36 0a 5c 66 42 3a  PSIS"..TP 6.\fB:
0210: 3a 74 63 6c 72 65 61 64 6c 69 6e 65 3a 3a 72 65  :tclreadline::re
0220: 61 64 6c 69 6e 65 5c 66 50 20 5c 66 49 63 6f 6d  adline\fP \fIcom
0230: 6d 61 6e 64 5c 66 50 20 5b 5c 66 49 6f 70 74 69  mand\fP [\fIopti
0240: 6f 6e 73 5c 66 50 5d 0a 0a 0a 2e 53 48 20 22 44  ons\fP]....SH "D
0250: 45 53 43 52 49 50 54 49 4f 4e 22 0a 0a 54 68 65  ESCRIPTION"..The
0260: 20 5c 66 42 74 63 6c 72 65 61 64 6c 69 6e 65 5c   \fBtclreadline\
0270: 66 50 20 70 61 63 6b 61 67 65 20 6d 61 6b 65 73  fP package makes
0280: 20 74 68 65 20 67 6e 75 20 72 65 61 64 6c 69 6e   the gnu readlin
0290: 65 20 61 76 61 69 6c 61 62 6c 65 0a 74 6f 20 74  e available.to t
02a0: 68 65 20 73 63 72 69 70 74 69 6e 67 20 6c 61 6e  he scripting lan
02b0: 67 75 61 67 65 20 74 63 6c 2e 20 54 68 65 20 70  guage tcl. The p
02c0: 72 69 6d 61 72 79 20 70 75 72 70 6f 73 65 20 6f  rimary purpose o
02d0: 66 20 74 68 65 20 70 61 63 6b 61 67 65 0a 69 73  f the package.is
02e0: 20 74 6f 20 66 61 63 69 6c 69 74 61 74 65 20 74   to facilitate t
02f0: 68 65 20 69 6e 74 65 72 61 63 74 69 76 65 20 73  he interactive s
0300: 63 72 69 70 74 20 64 65 76 65 6c 6f 70 6d 65 6e  cript developmen
0310: 74 20 62 79 20 74 68 65 20 6d 65 61 6e 73 0a 6f  t by the means.o
0320: 66 20 77 6f 72 64 20 61 6e 64 20 66 69 6c 65 20  f word and file 
0330: 6e 61 6d 65 20 63 6f 6d 70 6c 65 74 69 6f 6e 20  name completion 
0340: 61 73 20 77 65 6c 6c 20 61 73 20 68 69 73 74 6f  as well as histo
0350: 72 79 20 65 78 70 61 6e 73 69 6f 6e 0a 28 77 65  ry expansion.(we
0360: 6c 6c 20 6b 6e 6f 77 6e 20 66 72 6f 6d 20 73 68  ll known from sh
0370: 65 6c 6c 73 20 6c 69 6b 65 20 62 61 73 68 29 2e  ells like bash).
0380: 0a 0a 41 64 64 69 74 69 6f 6e 61 6c 6c 79 20 74  ..Additionally t
0390: 63 6c 72 65 61 64 6c 69 6e 65 20 63 61 6e 20 61  clreadline can a
03a0: 6c 73 6f 20 62 65 20 75 73 65 64 20 66 6f 72 20  lso be used for 
03b0: 74 63 6c 20 73 63 72 69 70 74 73 0a 77 68 69 63  tcl scripts.whic
03c0: 68 20 77 61 6e 74 20 74 6f 20 75 73 65 20 61 20  h want to use a 
03d0: 73 68 65 6c 6c 20 6c 69 6b 65 20 69 6e 70 75 74  shell like input
03e0: 20 69 6e 74 65 72 66 61 63 65 2e 20 49 6e 20 74   interface. In t
03f0: 68 69 73 20 63 61 73 65 20 74 68 65 0a 5c 66 42  his case the.\fB
0400: 3a 3a 74 63 6c 72 65 61 64 6c 69 6e 65 3a 3a 72  ::tclreadline::r
0410: 65 61 64 6c 69 6e 65 20 72 65 61 64 5c 66 50 20  eadline read\fP 
0420: 63 6f 6d 6d 61 6e 64 20 68 61 73 20 74 6f 20 62  command has to b
0430: 65 20 63 61 6c 6c 65 64 20 65 78 70 6c 69 63 69  e called explici
0440: 74 6c 79 2e 0a 0a 2e 50 50 0a 0a 54 68 65 20 61  tly....PP..The a
0450: 64 76 61 6e 74 61 67 65 20 6f 66 20 5c 66 42 74  dvantage of \fBt
0460: 63 6c 72 65 61 64 6c 69 6e 65 5c 66 50 20 69 73  clreadline\fP is
0470: 20 74 68 61 74 20 69 74 20 75 73 65 73 20 74 68   that it uses th
0480: 65 20 63 61 6c 6c 62 61 63 6b 0a 68 61 6e 64 6c  e callback.handl
0490: 65 72 20 6d 65 63 68 61 6e 69 73 6d 20 6f 66 20  er mechanism of 
04a0: 74 68 65 20 67 6e 75 20 72 65 61 64 6c 69 6e 65  the gnu readline
04b0: 20 77 68 69 6c 65 20 69 74 20 70 72 6f 63 65 73   while it proces
04c0: 73 65 73 20 74 63 6c 0a 65 76 65 6e 74 73 2e 20  ses tcl.events. 
04d0: 54 68 69 73 20 77 61 79 20 58 20 65 76 65 6e 74  This way X event
04e0: 73 20 66 72 6f 6d 20 61 20 77 69 73 68 20 67 75  s from a wish gu
04f0: 69 20 77 69 6c 6c 20 70 72 6f 63 65 73 73 65 64  i will processed
0500: 20 61 73 0a 77 65 6c 6c 20 61 73 20 65 76 65 6e   as.well as even
0510: 74 73 20 66 72 6f 6d 20 74 68 65 20 5c 66 50 74  ts from the \fPt
0520: 63 6c 72 65 61 64 6c 69 6e 65 5c 66 50 20 6c 69  clreadline\fP li
0530: 6e 65 20 69 6e 74 65 72 66 61 63 65 2e 0a 0a 2e  ne interface....
0540: 50 50 0a 0a 5c 66 42 74 63 6c 72 65 61 64 6c 69  PP..\fBtclreadli
0550: 6e 65 5c 66 50 20 69 73 20 62 61 73 69 63 61 6c  ne\fP is basical
0560: 6c 79 20 61 20 73 68 61 72 65 64 20 6c 69 62 72  ly a shared libr
0570: 61 72 79 20 61 6e 64 20 61 20 66 65 77 20 74 63  ary and a few tc
0580: 6c 20 73 63 72 69 70 74 73 0a 77 68 69 63 68 20  l scripts.which 
0590: 61 72 65 20 61 63 63 65 73 73 65 64 20 77 69 74  are accessed wit
05a0: 68 20 74 68 65 20 74 63 6c 20 70 61 63 6b 61 67  h the tcl packag
05b0: 65 20 72 65 71 75 69 72 65 20 63 6f 6d 6d 61 6e  e require comman
05c0: 64 2e 20 54 68 65 72 65 66 6f 72 65 0a 5c 66 42  d. Therefore.\fB
05d0: 74 63 6c 72 65 61 64 6c 69 6e 65 5c 66 50 20 73  tclreadline\fP s
05e0: 68 6f 75 6c 64 20 77 6f 72 6b 20 77 69 74 68 20  hould work with 
05f0: 61 6c 6c 20 63 6f 6d 6d 6f 6e 20 65 78 74 65 6e  all common exten
0600: 73 69 6f 6e 73 20 6c 69 6b 65 0a 5c 66 42 62 6c  sions like.\fBbl
0610: 74 2c 20 69 74 63 6c 2c 20 69 74 6b 2c 20 74 69  t, itcl, itk, ti
0620: 78 20 2e 2e 2e 5c 66 50 2e 0a 0a 0a 2e 5c 22 20  x ...\fP.....\" 
0630: 2e 53 48 20 53 4f 55 52 43 45 20 46 49 4c 45 53  .SH SOURCE FILES
0640: 0a 0a 0a 2e 53 48 20 22 43 4f 4d 4d 41 4e 44 53  ....SH "COMMANDS
0650: 22 0a 0a 49 66 20 79 6f 75 20 77 61 6e 74 20 74  "..If you want t
0660: 6f 20 75 73 65 20 5c 66 42 74 63 6c 72 65 61 64  o use \fBtclread
0670: 6c 69 6e 65 5c 66 50 20 61 73 20 61 20 6c 69 6e  line\fP as a lin
0680: 65 20 69 6e 74 65 72 66 61 63 65 0a 66 6f 72 20  e interface.for 
0690: 64 65 76 65 6c 6f 70 69 6e 67 20 74 63 6c 20 73  developing tcl s
06a0: 63 72 69 70 74 73 2c 20 79 6f 75 20 70 72 6f 62  cripts, you prob
06b0: 61 62 6c 79 20 64 6f 6e 27 74 20 68 61 76 65 20  ably don't have 
06c0: 74 6f 20 72 65 61 64 0a 74 68 69 73 20 73 65 63  to read.this sec
06d0: 74 69 6f 6e 2e 20 49 6e 20 74 68 69 73 20 63 61  tion. In this ca
06e0: 73 65 20 74 68 65 20 6f 6e 6c 79 20 74 68 69 6e  se the only thin
06f0: 67 20 79 6f 75 20 73 68 6f 75 6c 64 20 64 6f 20  g you should do 
0700: 69 73 0a 74 6f 20 6d 6f 64 69 66 79 20 79 6f 75  is.to modify you
0710: 72 20 2e 74 63 6c 73 68 72 63 20 61 63 63 6f 72  r .tclshrc accor
0720: 64 69 6e 67 20 74 6f 20 74 68 65 20 73 65 63 74  ding to the sect
0730: 69 6f 6e 20 5c 66 42 46 49 4c 45 53 5c 66 50 2e  ion \fBFILES\fP.
0740: 0a 0a 46 6f 72 20 74 68 65 20 66 75 6e 63 74 69  ..For the functi
0750: 6f 6e 61 6c 69 74 79 20 6f 66 20 74 68 65 20 47  onality of the G
0760: 4e 55 20 72 65 61 64 6c 69 6e 65 20 79 6f 75 20  NU readline you 
0770: 73 68 6f 75 6c 64 20 72 65 66 65 72 20 74 6f 0a  should refer to.
0780: 74 68 65 20 72 65 61 64 6c 69 6e 65 27 73 20 64  the readline's d
0790: 6f 63 75 6d 65 6e 74 61 74 69 6f 6e 2e 0a 0a 2e  ocumentation....
07a0: 50 50 0a 54 68 65 20 66 6f 6c 6c 6f 77 69 6e 67  PP.The following
07b0: 20 6c 69 73 74 20 77 69 6c 6c 20 67 69 76 65 20   list will give 
07c0: 61 6c 6c 20 63 6f 6d 6d 61 6e 64 73 2c 20 77 68  all commands, wh
07d0: 69 63 68 20 61 72 65 20 63 75 72 72 65 6e 74 6c  ich are currentl
07e0: 79 0a 69 6d 70 6c 65 6d 65 6e 74 65 64 20 69 6e  y.implemented in
07f0: 20 74 68 65 20 73 68 61 72 65 64 20 6c 69 62 20   the shared lib 
0800: 28 65 2e 67 2e 20 6c 69 62 74 63 6c 72 65 61 64  (e.g. libtclread
0810: 6c 69 6e 65 40 56 45 52 53 49 4f 4e 40 2e 73 6f  line@VERSION@.so
0820: 29 2e 0a 41 64 64 69 74 69 6f 6e 61 6c 20 63 6f  )..Additional co
0830: 6d 6d 61 6e 64 73 20 77 65 72 65 20 69 6e 74 72  mmands were intr
0840: 6f 64 75 63 65 64 20 69 6e 20 61 20 73 74 61 72  oduced in a star
0850: 74 75 70 20 73 63 72 69 70 74 0a 5c 66 42 74 63  tup script.\fBtc
0860: 6c 72 65 61 64 6c 69 6e 65 53 65 74 75 70 2e 74  lreadlineSetup.t
0870: 63 6c 5c 66 50 2c 20 77 68 69 63 68 20 6c 69 76  cl\fP, which liv
0880: 65 73 20 69 6e 20 74 68 65 20 74 63 6c 72 65 61  es in the tclrea
0890: 64 6c 69 6e 65 0a 69 6e 73 74 61 6c 6c 61 74 69  dline.installati
08a0: 6f 6e 20 64 69 72 65 63 74 6f 72 79 2e 0a 28 74  on directory..(t
08b0: 79 70 69 63 61 6c 6c 79 20 73 6f 6d 65 74 68 69  ypically somethi
08c0: 6e 67 20 6c 69 6b 65 20 2f 75 73 72 2f 6c 6f 63  ng like /usr/loc
08d0: 61 6c 2f 6c 69 62 2f 74 63 6c 72 65 61 64 6c 69  al/lib/tclreadli
08e0: 6e 65 20 2e 2e 29 0a 54 68 65 73 65 20 63 6f 6d  ne ..).These com
08f0: 6d 61 6e 64 73 20 61 72 65 20 70 72 69 6d 61 72  mands are primar
0900: 69 6c 79 20 66 6f 72 20 69 6e 74 65 72 6e 61 6c  ily for internal
0910: 20 75 73 65 20 61 6e 64 20 6e 6f 74 20 64 6f 63   use and not doc
0920: 75 6d 65 6e 74 65 64 20 68 65 72 65 2e 0a 0a 4e  umented here...N
0930: 6f 74 65 20 74 68 61 74 20 61 6c 6c 20 63 6f 6d  ote that all com
0940: 6d 61 6e 64 73 20 72 65 73 69 64 65 20 69 6e 20  mands reside in 
0950: 74 68 65 20 6e 61 6d 65 73 70 61 63 65 20 5c 66  the namespace \f
0960: 42 3a 3a 74 63 6c 72 65 61 64 6c 69 6e 65 3a 3a  B::tclreadline::
0970: 5c 66 50 2e 0a 0a 0a 2e 54 50 20 35 0a 5c 66 42  \fP.....TP 5.\fB
0980: 3a 3a 74 63 6c 72 65 61 64 6c 69 6e 65 3a 3a 72  ::tclreadline::r
0990: 65 61 64 6c 69 6e 65 20 61 64 64 5c 66 50 20 5c  eadline add\fP \
09a0: 66 49 73 74 72 69 6e 67 5c 66 50 0a 61 64 64 73  fIstring\fP.adds
09b0: 20 61 20 73 74 72 69 6e 67 20 74 6f 20 74 68 65   a string to the
09c0: 20 63 6f 6d 70 6c 65 74 65 72 2e 20 49 66 20 74   completer. If t
09d0: 68 65 20 73 74 72 69 6e 67 20 63 6f 6e 74 61 69  he string contai
09e0: 6e 73 20 77 68 69 74 65 0a 73 70 61 63 65 73 2c  ns white.spaces,
09f0: 20 65 61 63 68 20 6f 66 20 74 68 65 20 77 6f 72   each of the wor
0a00: 64 73 20 77 69 6c 6c 20 62 65 20 63 6f 6d 70 6c  ds will be compl
0a10: 65 74 65 64 20 63 6f 6e 73 65 63 75 74 69 76 65  eted consecutive
0a20: 6c 79 20 77 68 65 6e 0a 68 69 74 74 69 6e 67 20  ly when.hitting 
0a30: 3c 54 61 62 3e 2e 20 45 78 61 6d 70 6c 65 3a 0a  <Tab>. Example:.
0a40: 0a 20 20 20 20 3a 3a 74 63 6c 72 65 61 64 6c 69  .    ::tclreadli
0a50: 6e 65 3a 3a 72 65 61 64 6c 69 6e 65 20 61 64 64  ne::readline add
0a60: 20 22 62 75 74 74 6f 6e 20 70 61 74 68 4e 61 6d   "button pathNam
0a70: 65 20 3f 6f 70 74 69 6f 6e 73 3f 22 0a 0a 74 79  e ?options?"..ty
0a80: 70 69 6e 67 20 62 75 74 3c 54 61 62 3e 20 77 69  ping but<Tab> wi
0a90: 6c 6c 20 63 6f 6d 70 6c 65 74 65 20 74 6f 20 62  ll complete to b
0aa0: 75 74 74 6f 6e 2e 20 48 69 74 74 69 6e 67 20 3c  utton. Hitting <
0ab0: 54 61 62 3e 20 61 67 61 69 6e 0a 77 69 6c 6c 20  Tab> again.will 
0ac0: 63 6f 6d 70 6c 65 74 65 20 74 6f 20 22 62 75 74  complete to "but
0ad0: 74 6f 6e 20 70 61 74 68 4e 61 6d 65 22 2e 20 20  ton pathName".  
0ae0: 2e 2e 2e 0a 0a 2e 54 50 20 35 0a 5c 66 42 3a 3a  ......TP 5.\fB::
0af0: 74 63 6c 72 65 61 64 6c 69 6e 65 3a 3a 72 65 61  tclreadline::rea
0b00: 64 6c 69 6e 65 20 63 6f 6d 70 6c 65 74 65 5c 66  dline complete\f
0b10: 50 20 5c 66 49 73 74 72 69 6e 67 5c 66 50 0a 72  P \fIstring\fP.r
0b20: 65 74 75 72 6e 73 20 31 20 69 66 20 5c 66 49 73  eturns 1 if \fIs
0b30: 74 72 69 6e 67 5c 66 50 20 69 73 20 61 20 63 6f  tring\fP is a co
0b40: 6d 70 6c 65 74 65 20 74 63 6c 20 63 6f 6d 6d 61  mplete tcl comma
0b50: 6e 64 20 61 6e 64 20 30 20 6f 74 68 65 72 77 69  nd and 0 otherwi
0b60: 73 65 2e 0a 0a 2e 54 50 20 35 0a 5c 66 42 3a 3a  se....TP 5.\fB::
0b70: 74 63 6c 72 65 61 64 6c 69 6e 65 3a 3a 72 65 61  tclreadline::rea
0b80: 64 6c 69 6e 65 20 63 75 73 74 6f 6d 63 6f 6d 70  dline customcomp
0b90: 6c 65 74 65 72 5c 66 50 20 5b 5c 66 49 73 74 72  leter\fP [\fIstr
0ba0: 69 6e 67 5c 66 50 5d 0a 52 65 67 69 73 74 65 72  ing\fP].Register
0bb0: 20 74 68 65 20 70 72 6f 63 20 5c 66 49 73 74 72   the proc \fIstr
0bc0: 69 6e 67 5c 66 50 20 61 73 20 63 75 73 74 6f 6d  ing\fP as custom
0bd0: 20 63 6f 6d 70 6c 65 74 65 72 2e 20 54 68 69 73   completer. This
0be0: 20 70 72 6f 63 20 69 73 20 63 61 6c 6c 65 64 0a   proc is called.
0bf0: 77 69 74 68 20 65 78 61 63 74 6c 79 20 66 6f 75  with exactly fou
0c00: 72 20 61 72 67 75 6d 65 6e 74 73 20 65 61 63 68  r arguments each
0c10: 20 74 69 6d 65 20 63 6f 6d 70 6c 65 74 69 6f 6e   time completion
0c20: 20 74 61 6b 65 73 20 70 6c 61 63 65 3a 0a 74 68   takes place:.th
0c30: 65 20 77 6f 72 64 20 74 6f 20 63 6f 6d 70 6c 65  e word to comple
0c40: 74 65 20 28 22 74 65 78 74 22 29 2c 20 74 68 65  te ("text"), the
0c50: 20 22 73 74 61 72 74 22 20 61 6e 64 20 22 65 6e   "start" and "en
0c60: 64 22 20 70 6f 73 69 74 69 6f 6e 73 20 6f 66 20  d" positions of 
0c70: 74 68 69 73 20 77 6f 72 64 0a 69 6e 20 74 68 65  this word.in the
0c80: 20 6c 69 6e 65 20 65 6e 74 65 72 65 64 20 73 6f   line entered so
0c90: 20 66 61 72 2c 20 61 6e 64 20 74 68 69 73 20 6c   far, and this l
0ca0: 69 6e 65 20 28 22 6c 69 6e 65 22 29 2e 20 54 68  ine ("line"). Th
0cb0: 65 20 63 75 73 74 6f 6d 20 63 6f 6d 70 6c 65 74  e custom complet
0cc0: 69 6f 6e 0a 73 63 72 69 70 74 20 73 68 6f 75 6c  ion.script shoul
0cd0: 64 20 72 65 74 75 72 6e 20 61 6e 20 61 72 72 61  d return an arra
0ce0: 79 20 6f 66 20 73 74 72 69 6e 67 73 20 77 68 69  y of strings whi
0cf0: 63 68 20 69 73 20 61 20 6c 69 73 74 20 6f 66 20  ch is a list of 
0d00: 63 6f 6d 70 6c 65 74 69 6f 6e 73 0a 66 6f 72 20  completions.for 
0d10: 22 74 65 78 74 22 2e 20 20 49 66 20 74 68 65 72  "text".  If ther
0d20: 65 20 61 72 65 20 6e 6f 20 63 6f 6d 70 6c 65 74  e are no complet
0d30: 69 6f 6e 73 2c 20 69 74 20 73 68 6f 75 6c 64 20  ions, it should 
0d40: 72 65 74 75 72 6e 20 61 6e 20 65 6d 70 74 79 0a  return an empty.
0d50: 73 74 72 69 6e 67 20 22 22 2e 20 20 54 68 65 20  string "".  The 
0d60: 66 69 72 73 74 20 65 6e 74 72 79 20 69 6e 20 74  first entry in t
0d70: 68 65 20 72 65 74 75 72 6e 65 64 20 6c 69 73 74  he returned list
0d80: 20 69 73 20 74 68 65 20 73 75 62 73 74 69 74 75   is the substitu
0d90: 74 69 6f 6e 0a 66 6f 72 20 22 74 65 78 74 22 2e  tion.for "text".
0da0: 20 54 68 65 20 72 65 6d 61 69 6e 69 6e 67 20 65   The remaining e
0db0: 6e 74 72 69 65 73 20 61 72 65 20 74 68 65 20 70  ntries are the p
0dc0: 6f 73 73 69 62 6c 65 20 63 6f 6d 70 6c 65 74 69  ossible completi
0dd0: 6f 6e 73 2e 20 49 66 0a 74 68 65 20 63 75 73 74  ons. If.the cust
0de0: 6f 6d 20 63 6f 6d 70 6c 65 74 69 6f 6e 20 73 63  om completion sc
0df0: 72 69 70 74 20 72 65 74 75 72 6e 73 20 61 6e 20  ript returns an 
0e00: 65 6d 70 74 79 20 73 74 72 69 6e 67 20 61 6e 64  empty string and
0e10: 20 62 75 69 6c 74 69 6e 0a 63 6f 6d 70 6c 65 74   builtin.complet
0e20: 69 6f 6e 20 69 73 20 65 6e 61 62 6c 65 64 20 28  ion is enabled (
0e30: 73 65 65 20 5c 66 42 74 63 6c 72 65 61 64 6c 69  see \fBtclreadli
0e40: 6e 65 3a 3a 72 65 61 64 6c 69 6e 65 20 62 75 69  ne::readline bui
0e50: 6c 74 69 6e 63 6f 6d 70 6c 65 74 65 72 5c 66 50  ltincompleter\fP
0e60: 29 2c 0a 74 68 65 20 62 75 69 6c 74 69 6e 20 63  ),.the builtin c
0e70: 6f 6d 70 6c 65 74 65 72 20 69 73 20 63 61 6c 6c  ompleter is call
0e80: 65 64 2e 0a 5c 66 42 74 63 6c 72 65 61 64 6c 69  ed..\fBtclreadli
0e90: 6e 65 3a 3a 72 65 61 64 6c 69 6e 65 20 63 75 73  ne::readline cus
0ea0: 74 6f 6d 63 6f 6d 70 6c 65 74 65 72 5c 66 50 20  tomcompleter\fP 
0eb0: 73 69 6d 70 6c 79 20 72 65 74 75 72 6e 73 20 74  simply returns t
0ec0: 68 65 20 63 75 72 72 65 6e 74 0a 63 75 73 74 6f  he current.custo
0ed0: 6d 20 63 6f 6d 70 6c 65 74 65 72 20 69 66 20 63  m completer if c
0ee0: 61 6c 6c 65 64 20 77 2f 6f 20 5c 66 49 73 74 72  alled w/o \fIstr
0ef0: 69 6e 67 5c 66 50 2e 20 54 6f 20 74 75 72 6e 20  ing\fP. To turn 
0f00: 6f 66 20 63 75 73 74 6f 6d 0a 63 6f 6d 70 6c 65  of custom.comple
0f10: 74 69 6f 6e 2c 20 63 61 6c 6c 20 5c 66 42 74 63  tion, call \fBtc
0f20: 6c 72 65 61 64 6c 69 6e 65 3a 3a 72 65 61 64 6c  lreadline::readl
0f30: 69 6e 65 20 63 75 73 74 6f 6d 63 6f 6d 70 6c 65  ine customcomple
0f40: 74 65 72 5c 66 50 20 77 69 74 68 0a 61 6e 20 65  ter\fP with.an e
0f50: 6d 70 74 79 20 5c 66 49 73 74 72 69 6e 67 5c 66  mpty \fIstring\f
0f60: 50 2e 0a 0a 45 78 61 6d 70 6c 65 3a 20 5c 66 42  P...Example: \fB
0f70: 25 20 70 75 74 73 20 24 62 3c 54 41 42 3e 5c 66  % puts $b<TAB>\f
0f80: 50 20 77 69 6c 6c 20 63 61 6c 6c 20 74 68 65 20  P will call the 
0f90: 63 75 73 74 6f 6d 20 63 6f 6d 70 6c 65 74 65 72  custom completer
0fa0: 0a 77 69 74 68 20 74 68 65 20 66 6f 75 72 20 61  .with the four a
0fb0: 72 67 75 6d 65 6e 74 73 20 5c 66 49 22 24 62 22  rguments \fI"$b"
0fc0: 5c 66 50 2c 20 5c 66 49 22 35 22 5c 66 50 2c 20  \fP, \fI"5"\fP, 
0fd0: 5c 66 49 22 38 22 5c 66 50 20 61 6e 64 20 5c 66  \fI"8"\fP and \f
0fe0: 49 22 70 75 74 73 20 24 62 22 5c 66 50 2e 0a 54  I"puts $b"\fP..T
0ff0: 68 65 20 63 75 73 74 6f 6d 20 63 6f 6d 70 6c 65  he custom comple
1000: 74 65 72 20 63 6f 75 6c 64 20 72 65 74 75 72 6e  ter could return
1010: 20 61 20 73 74 72 69 6e 67 20 6c 69 6b 65 20 22   a string like "
1020: 24 62 6c 20 24 62 6c 61 63 6b 20 24 62 6c 75 65  $bl $black $blue
1030: 22 2c 20 77 68 69 63 68 0a 77 69 6c 6c 20 63 6f  ", which.will co
1040: 6d 70 6c 65 74 65 20 22 24 62 22 20 74 6f 20 22  mplete "$b" to "
1050: 24 62 6c 22 20 28 74 68 65 20 6c 6f 6e 67 65 73  $bl" (the longes
1060: 74 20 6d 61 74 63 68 29 20 61 6e 64 20 6f 66 66  t match) and off
1070: 65 72 20 61 20 6c 69 73 74 20 6f 66 20 74 77 6f  er a list of two
1080: 0a 66 75 72 74 68 65 72 20 6d 61 74 63 68 65 73  .further matches
1090: 20 22 24 62 6c 61 63 6b 22 20 61 6e 64 20 22 24   "$black" and "$
10a0: 62 6c 75 65 22 2e 0a 0a 46 6f 72 20 66 75 72 74  blue"...For furt
10b0: 68 65 72 20 72 65 66 65 72 65 6e 63 65 2c 20 73  her reference, s
10c0: 65 65 20 74 68 65 20 70 72 6f 63 20 74 63 6c 72  ee the proc tclr
10d0: 65 61 64 6c 69 6e 65 3a 3a 53 63 72 69 70 74 43  eadline::ScriptC
10e0: 6f 6d 70 6c 65 74 65 72 20 69 6e 0a 74 68 65 20  ompleter in.the 
10f0: 66 69 6c 65 20 74 63 6c 72 65 61 64 6c 69 6e 65  file tclreadline
1100: 53 65 74 75 70 2e 74 63 6c 2e 0a 0a 2e 54 50 20  Setup.tcl....TP 
1110: 35 0a 5c 66 42 3a 3a 74 63 6c 72 65 61 64 6c 69  5.\fB::tclreadli
1120: 6e 65 3a 3a 72 65 61 64 6c 69 6e 65 20 62 75 69  ne::readline bui
1130: 6c 74 69 6e 63 6f 6d 70 6c 65 74 65 72 5c 66 50  ltincompleter\fP
1140: 20 5b 5c 66 49 62 6f 6f 6c 5c 66 50 5d 0a 65 6e   [\fIbool\fP].en
1150: 61 62 6c 65 20 6f 72 20 64 69 73 61 62 6c 65 20  able or disable 
1160: 74 68 65 20 62 75 69 6c 74 69 6e 20 63 6f 6d 70  the builtin comp
1170: 6c 65 74 65 72 2e 20 49 66 20 74 68 65 20 62 75  leter. If the bu
1180: 69 6c 74 69 6e 20 63 6f 6d 70 6c 65 74 65 72 0a  iltin completer.
1190: 69 73 20 65 6e 61 62 6c 65 64 2c 20 69 74 20 77  is enabled, it w
11a0: 69 6c 6c 20 62 65 20 69 6e 76 6f 6b 65 64 20 65  ill be invoked e
11b0: 69 74 68 65 72 20 69 66 20 74 68 65 72 65 20 69  ither if there i
11c0: 73 20 6e 6f 20 63 75 73 74 6f 6d 20 63 6f 6d 70  s no custom comp
11d0: 6c 65 74 65 72 2c 0a 6f 72 20 74 68 65 20 63 75  leter,.or the cu
11e0: 73 74 6f 6d 20 63 6f 6d 70 6c 65 74 65 72 20 72  stom completer r
11f0: 65 74 75 72 6e 65 64 20 61 6e 20 65 6d 70 74 79  eturned an empty
1200: 20 20 73 74 72 69 6e 67 2e 20 54 68 65 20 62 75    string. The bu
1210: 69 6c 74 69 6e 0a 63 6f 6d 70 6c 65 74 65 72 20  iltin.completer 
1220: 69 73 20 6f 6e 20 62 79 20 64 65 66 61 75 6c 74  is on by default
1230: 2e 0a 5c 66 42 74 63 6c 72 65 61 64 6c 69 6e 65  ..\fBtclreadline
1240: 3a 3a 72 65 61 64 6c 69 6e 65 20 62 75 69 6c 74  ::readline built
1250: 69 6e 63 6f 6d 70 6c 65 74 65 72 5c 66 50 20 72  incompleter\fP r
1260: 65 74 75 72 6e 73 20 74 68 65 20 63 75 72 72 65  eturns the curre
1270: 6e 74 0a 63 75 73 74 6f 6d 20 63 6f 6d 70 6c 65  nt.custom comple
1280: 74 65 72 20 28 61 6c 73 6f 2c 20 69 66 20 63 61  ter (also, if ca
1290: 6c 6c 65 64 20 77 2f 6f 20 74 68 65 20 5c 66 49  lled w/o the \fI
12a0: 62 6f 6f 6c 5c 66 50 20 61 72 67 75 6d 65 6e 74  bool\fP argument
12b0: 29 2e 0a 0a 2e 54 50 20 35 0a 5c 66 42 3a 3a 74  )....TP 5.\fB::t
12c0: 63 6c 72 65 61 64 6c 69 6e 65 3a 3a 72 65 61 64  clreadline::read
12d0: 6c 69 6e 65 20 65 6f 66 63 68 61 72 5c 66 50 20  line eofchar\fP 
12e0: 5b 5c 66 49 73 63 72 69 70 74 5c 66 50 5d 0a 73  [\fIscript\fP].s
12f0: 65 74 20 61 20 73 63 72 69 70 74 20 77 68 69 63  et a script whic
1300: 68 20 77 69 6c 6c 20 62 65 20 63 61 6c 6c 65 64  h will be called
1310: 2c 20 69 66 20 72 65 61 64 6c 69 6e 65 20 72 65  , if readline re
1320: 74 75 72 6e 73 20 74 68 65 20 65 6f 66 20 63 68  turns the eof ch
1330: 61 72 61 63 74 65 72 0a 28 74 68 69 73 20 69 73  aracter.(this is
1340: 20 74 79 70 69 63 61 6c 6c 79 20 74 68 65 20 63   typically the c
1350: 61 73 65 20 69 66 20 43 54 52 4c 2d 44 20 69 73  ase if CTRL-D is
1360: 20 65 6e 74 65 72 65 64 20 61 74 20 74 68 65 20   entered at the 
1370: 76 65 72 79 20 62 65 67 69 6e 6e 69 6e 67 0a 6f  very beginning.o
1380: 66 20 74 68 65 20 6c 69 6e 65 29 2e 20 54 68 65  f the line). The
1390: 20 64 65 66 61 75 6c 74 20 66 6f 72 20 74 68 69   default for thi
13a0: 73 20 73 63 72 69 70 74 20 69 73 20 22 70 75 74  s script is "put
13b0: 73 20 7b 7d 3b 20 65 78 69 74 22 2e 20 53 65 74  s {}; exit". Set
13c0: 74 69 6e 67 0a 74 68 69 73 20 74 6f 20 61 6e 20  ting.this to an 
13d0: 65 6d 70 74 79 20 76 61 6c 75 65 20 64 69 73 61  empty value disa
13e0: 62 6c 65 73 20 61 6e 79 20 61 63 74 69 6f 6e 20  bles any action 
13f0: 6f 6e 20 65 6f 66 2e 0a 5c 66 42 74 63 6c 72 65  on eof..\fBtclre
1400: 61 64 6c 69 6e 65 3a 3a 72 65 61 64 6c 69 6e 65  adline::readline
1410: 20 65 6f 66 5c 66 50 20 72 65 74 75 72 6e 73 20   eof\fP returns 
1420: 74 68 65 20 63 75 72 72 65 6e 74 20 65 6f 66 20  the current eof 
1430: 73 63 72 69 70 74 2e 0a 0a 2e 54 50 20 35 0a 5c  script....TP 5.\
1440: 66 42 3a 3a 74 63 6c 72 65 61 64 6c 69 6e 65 3a  fB::tclreadline:
1450: 3a 72 65 61 64 6c 69 6e 65 20 69 6e 69 74 69 61  :readline initia
1460: 6c 69 7a 65 5c 66 50 20 5c 66 49 68 69 73 74 6f  lize\fP \fIhisto
1470: 72 79 66 69 6c 65 5c 66 50 0a 69 6e 69 74 69 61  ryfile\fP.initia
1480: 6c 69 7a 65 20 74 68 65 20 74 63 6c 72 65 61 64  lize the tclread
1490: 6c 69 6e 65 20 69 6e 74 65 72 66 61 63 65 20 61  line interface a
14a0: 6e 64 20 72 65 61 64 20 74 68 65 20 68 69 73 74  nd read the hist
14b0: 6f 72 79 20 66 72 6f 6d 0a 74 68 65 20 5c 66 49  ory from.the \fI
14c0: 68 69 73 74 6f 72 79 66 69 6c 65 5c 66 50 2e 20  historyfile\fP. 
14d0: 4f 6e 20 73 75 63 63 65 73 73 20 61 6e 20 65 6d  On success an em
14e0: 70 74 79 20 73 74 72 69 6e 67 20 69 73 20 72 65  pty string is re
14f0: 74 75 72 6e 65 64 2e 0a 54 68 69 73 20 63 6f 6d  turned..This com
1500: 6d 61 6e 64 20 68 61 73 20 74 6f 20 62 65 20 63  mand has to be c
1510: 61 6c 6c 65 64 20 62 65 66 6f 72 65 20 61 6e 79  alled before any
1520: 20 6f 74 68 65 72 20 74 63 6c 72 65 61 64 6c 69   other tclreadli
1530: 6e 65 20 63 6f 6d 6d 61 6e 64 73 2e 0a 0a 2e 54  ne commands....T
1540: 50 20 35 0a 5c 66 42 3a 3a 74 63 6c 72 65 61 64  P 5.\fB::tclread
1550: 6c 69 6e 65 3a 3a 72 65 61 64 6c 69 6e 65 20 72  line::readline r
1560: 65 61 64 5c 66 50 20 5c 66 49 70 72 6f 6d 70 74  ead\fP \fIprompt
1570: 5c 66 50 0a 70 72 69 6e 74 73 20 74 68 65 20 5c  \fP.prints the \
1580: 66 49 70 72 6f 6d 70 74 5c 66 50 20 74 6f 20 73  fIprompt\fP to s
1590: 74 64 6f 75 74 20 61 6e 64 20 65 6e 74 65 72 73  tdout and enters
15a0: 20 74 68 65 20 74 63 6c 72 65 61 64 6c 69 6e 65   the tclreadline
15b0: 20 65 76 65 6e 74 0a 6c 6f 6f 70 2e 20 42 6f 74   event.loop. Bot
15c0: 68 20 72 65 61 64 6c 69 6e 65 20 61 6e 64 20 58  h readline and X
15d0: 20 65 76 65 6e 74 73 20 61 72 65 20 70 72 6f 63   events are proc
15e0: 65 73 73 65 64 2e 20 52 65 74 75 72 6e 73 20 74  essed. Returns t
15f0: 68 65 0a 28 65 76 65 6e 74 75 61 6c 6c 79 20 68  he.(eventually h
1600: 69 73 74 6f 72 79 2d 65 78 70 61 6e 64 65 64 29  istory-expanded)
1610: 20 69 6e 70 75 74 20 73 74 72 69 6e 67 2e 0a 5c   input string..\
1620: 66 42 74 63 6c 72 65 61 64 6c 69 6e 65 3a 3a 72  fBtclreadline::r
1630: 65 61 64 6c 69 6e 65 20 72 65 61 64 5c 66 50 20  eadline read\fP 
1640: 72 69 73 65 73 20 61 6e 20 65 72 72 6f 72 2c 20  rises an error, 
1650: 69 66 20 61 6e 0a 65 72 72 6f 72 20 6f 63 63 75  if an.error occu
1660: 72 73 20 77 68 69 6c 65 20 65 76 61 6c 75 61 74  rs while evaluat
1670: 69 6e 67 20 61 20 73 63 72 69 70 74 20 63 6f 6d  ing a script com
1680: 70 6c 65 74 65 72 2e 0a 0a 2e 54 50 20 35 0a 5c  pleter....TP 5.\
1690: 66 42 3a 3a 74 63 6c 72 65 61 64 6c 69 6e 65 3a  fB::tclreadline:
16a0: 3a 72 65 61 64 6c 69 6e 65 20 77 72 69 74 65 5c  :readline write\
16b0: 66 50 20 5c 66 49 68 69 73 74 6f 72 79 66 69 6c  fP \fIhistoryfil
16c0: 65 5c 66 50 0a 77 72 69 74 65 73 20 74 68 65 20  e\fP.writes the 
16d0: 68 69 73 74 6f 72 79 20 74 6f 20 74 68 65 20 5c  history to the \
16e0: 66 49 68 69 73 74 6f 72 79 66 69 6c 65 5c 66 50  fIhistoryfile\fP
16f0: 2e 20 54 68 69 73 20 63 6f 6d 6d 61 6e 64 20 69  . This command i
1700: 73 20 63 61 6c 6c 65 64 0a 61 75 74 6f 6d 61 74  s called.automat
1710: 69 63 61 6c 6c 79 20 66 72 6f 6d 20 74 68 65 20  ically from the 
1720: 69 6e 74 65 72 6e 61 6c 20 72 6f 75 74 69 6e 65  internal routine
1730: 20 3a 3a 74 63 6c 72 65 61 64 6c 69 6e 65 3a 3a   ::tclreadline::
1740: 45 78 69 74 2e 0a 49 66 20 74 68 65 20 76 61 72  Exit..If the var
1750: 69 61 62 6c 65 20 5c 66 42 74 63 6c 72 65 61 64  iable \fBtclread
1760: 6c 69 6e 65 3a 3a 68 69 73 74 6f 72 79 4c 65 6e  line::historyLen
1770: 67 74 68 5c 66 50 20 69 73 20 6e 6f 6e 2d 6e 65  gth\fP is non-ne
1780: 67 61 74 69 76 65 2c 0a 74 68 65 20 68 69 73 74  gative,.the hist
1790: 6f 72 79 66 69 6c 65 20 77 69 6c 6c 20 62 65 20  oryfile will be 
17a0: 74 72 75 6e 63 61 74 65 64 20 74 6f 20 68 6f 6c  truncated to hol
17b0: 64 20 6f 6e 6c 79 20 74 68 69 73 20 6e 75 6d 62  d only this numb
17c0: 65 72 20 6c 69 6e 65 73 2e 0a 0a 2e 54 50 20 35  er lines....TP 5
17d0: 0a 5c 66 42 3a 3a 74 63 6c 72 65 61 64 6c 69 6e  .\fB::tclreadlin
17e0: 65 3a 3a 72 65 61 64 6c 69 6e 65 20 72 65 73 65  e::readline rese
17f0: 74 2d 74 65 72 6d 69 6e 61 6c 5c 66 50 20 5b 5c  t-terminal\fP [\
1800: 66 49 74 65 72 6d 69 6e 61 6c 4e 61 6d 65 5c 66  fIterminalName\f
1810: 50 5d 0a 77 2f 6f 20 61 72 67 75 6d 65 6e 74 3a  P].w/o argument:
1820: 20 72 65 73 65 74 20 74 68 65 20 73 74 61 74 65   reset the state
1830: 20 6f 66 20 74 68 65 20 74 65 72 6d 69 6e 61 6c   of the terminal
1840: 20 74 6f 20 77 68 61 74 20 69 74 20 77 61 73 0a   to what it was.
1850: 62 65 66 6f 72 65 20 74 63 6c 72 65 61 64 6c 69  before tclreadli
1860: 6e 65 20 77 61 73 20 75 73 65 64 2e 20 57 69 74  ne was used. Wit
1870: 68 20 61 72 67 75 6d 65 6e 74 3a 20 72 65 69 6e  h argument: rein
1880: 69 74 69 61 6c 69 7a 65 20 72 65 61 64 6c 69 6e  itialize readlin
1890: 65 27 73 0a 69 64 65 61 20 6f 66 20 74 68 65 20  e's.idea of the 
18a0: 74 65 72 6d 69 6e 61 6c 20 73 65 74 74 69 6e 67  terminal setting
18b0: 73 20 75 73 69 6e 67 20 74 65 72 6d 69 6e 61 6c  s using terminal
18c0: 4e 61 6d 65 20 61 73 20 74 68 65 20 74 65 72 6d  Name as the term
18d0: 69 6e 61 6c 20 74 79 70 65 2e 0a 54 68 65 20 66  inal type..The f
18e0: 6f 72 6d 20 77 2f 6f 20 61 72 67 75 6d 65 6e 74  orm w/o argument
18f0: 20 6d 69 67 68 74 20 6e 6f 74 20 77 6f 72 6b 20   might not work 
1900: 69 66 20 74 63 6c 72 65 61 64 6c 69 6e 65 20 77  if tclreadline w
1910: 61 73 20 63 6f 6d 70 69 6c 65 64 0a 77 69 74 68  as compiled.with
1920: 20 61 6e 20 6f 6c 64 65 72 20 76 65 72 73 69 6f   an older versio
1930: 6e 20 6f 66 20 6c 69 62 72 65 61 64 6c 69 6e 65  n of libreadline
1940: 2e 0a 0a 2e 54 50 20 35 0a 5c 66 42 3a 3a 74 63  ....TP 5.\fB::tc
1950: 6c 72 65 61 64 6c 69 6e 65 3a 3a 72 65 61 64 6c  lreadline::readl
1960: 69 6e 65 20 62 65 6c 6c 5c 66 50 0a 52 69 6e 67  ine bell\fP.Ring
1970: 20 74 68 65 20 74 65 72 6d 69 6e 61 6c 20 62 65   the terminal be
1980: 6c 6c 2c 20 6f 62 65 79 69 6e 67 20 74 68 65 20  ll, obeying the 
1990: 73 65 74 74 69 6e 67 20 6f 66 20 62 65 6c 6c 2d  setting of bell-
19a0: 73 74 79 6c 65 0a 2d 2d 20 61 75 64 69 62 6c 65  style.-- audible
19b0: 20 6f 72 20 76 69 73 69 62 6c 65 2e 0a 0a 2e 54   or visible....T
19c0: 50 20 35 0a 5c 66 42 3a 3a 74 63 6c 72 65 61 64  P 5.\fB::tclread
19d0: 6c 69 6e 65 3a 3a 74 65 78 74 5c 66 50 0a 52 65  line::text\fP.Re
19e0: 74 75 72 6e 20 74 68 65 20 63 75 72 72 65 6e 74  turn the current
19f0: 20 69 6e 70 75 74 2e 0a 0a 2e 54 50 20 35 0a 5c   input....TP 5.\
1a00: 66 42 3a 3a 74 63 6c 72 65 61 64 6c 69 6e 65 3a  fB::tclreadline:
1a10: 3a 72 65 61 64 6c 69 6e 65 20 75 70 64 61 74 65  :readline update
1a20: 5c 66 50 0a 52 65 64 72 61 77 20 74 68 65 20 63  \fP.Redraw the c
1a30: 75 72 72 65 6e 74 20 69 6e 70 75 74 20 6c 69 6e  urrent input lin
1a40: 65 2e 0a 0a 2e 54 50 20 35 0a 5c 66 42 3a 3a 74  e....TP 5.\fB::t
1a50: 63 6c 72 65 61 64 6c 69 6e 65 3a 3a 50 72 69 6e  clreadline::Prin
1a60: 74 5c 66 50 20 5b 5c 66 49 79 65 73 20 2f 20 6e  t\fP [\fIyes / n
1a70: 6f 5c 66 50 5d 0a 74 75 72 6e 73 20 6f 6e 20 6f  o\fP].turns on o
1a80: 72 20 6f 66 66 20 74 68 65 20 64 65 66 61 75 6c  r off the defaul
1a90: 74 20 62 65 68 61 76 69 6f 72 20 6f 66 20 74 63  t behavior of tc
1aa0: 6c 73 68 20 74 6f 20 70 72 69 6e 74 20 74 68 65  lsh to print the
1ab0: 20 72 65 73 75 6c 74 20 6f 66 0a 65 76 65 72 79   result of.every
1ac0: 20 63 6f 6d 6d 61 6e 64 2e 20 54 68 69 73 20 69   command. This i
1ad0: 73 20 74 75 72 6e 65 64 20 6f 6e 20 62 79 20 64  s turned on by d
1ae0: 65 66 61 75 6c 74 2c 20 73 6f 20 69 74 20 77 69  efault, so it wi
1af0: 6c 6c 20 6a 75 73 74 20 62 65 68 61 76 65 0a 61  ll just behave.a
1b00: 73 20 74 68 65 20 74 63 6c 73 68 20 77 2f 6f 20  s the tclsh w/o 
1b10: 74 63 6c 72 65 61 64 6c 69 6e 65 2e 20 54 75 72  tclreadline. Tur
1b20: 6e 69 6e 67 20 6f 66 66 20 6d 69 67 68 74 20 62  ning off might b
1b30: 65 20 75 73 65 66 75 6c 2c 20 77 68 65 6e 20 72  e useful, when r
1b40: 65 61 64 69 6e 67 0a 62 69 6e 61 72 79 20 64 61  eading.binary da
1b50: 74 61 20 66 6f 72 20 65 78 61 6d 70 6c 65 2e 20  ta for example. 
1b60: 49 66 20 5c 66 42 3a 3a 74 63 6c 72 65 61 64 6c  If \fB::tclreadl
1b70: 69 6e 65 3a 3a 50 72 69 6e 74 5c 66 50 20 69 73  ine::Print\fP is
1b80: 20 63 61 6c 6c 65 64 20 77 2f 6f 0a 61 72 67 75   called w/o.argu
1b90: 6d 65 6e 74 73 2c 20 69 74 20 72 65 74 75 72 6e  ments, it return
1ba0: 73 20 74 68 65 20 63 75 72 72 65 6e 74 20 73 65  s the current se
1bb0: 74 74 69 6e 67 2e 0a 0a 2e 54 50 20 35 0a 5c 66  tting....TP 5.\f
1bc0: 42 3a 3a 74 63 6c 72 65 61 64 6c 69 6e 65 3a 3a  B::tclreadline::
1bd0: 4c 6f 6f 70 5c 66 50 20 5b 5c 66 49 68 69 73 74  Loop\fP [\fIhist
1be0: 6f 72 79 66 69 6c 65 5c 66 50 5d 0a 65 6e 74 65  oryfile\fP].ente
1bf0: 72 20 74 68 65 20 74 63 6c 72 65 61 64 6c 69 6e  r the tclreadlin
1c00: 65 20 6d 61 69 6e 20 6c 6f 6f 70 2e 20 54 68 69  e main loop. Thi
1c10: 73 20 63 6f 6d 6d 61 6e 64 20 69 73 20 74 79 70  s command is typ
1c20: 69 63 61 6c 6c 79 20 63 61 6c 6c 65 64 20 66 72  ically called fr
1c30: 6f 6d 0a 74 68 65 20 73 74 61 72 74 75 70 20 72  om.the startup r
1c40: 65 73 6f 75 72 63 65 20 66 69 6c 65 20 28 73 6f  esource file (so
1c50: 6d 65 74 68 69 6e 67 20 2e 74 63 6c 73 68 72 63  mething .tclshrc
1c60: 2c 20 64 65 70 65 6e 64 69 6e 67 20 6f 6e 20 74  , depending on t
1c70: 68 65 20 69 6e 74 65 72 70 72 65 74 65 72 0a 79  he interpreter.y
1c80: 6f 75 20 75 73 65 2c 20 73 65 65 20 74 68 65 20  ou use, see the 
1c90: 66 69 6c 65 20 60 73 61 6d 70 6c 65 2e 74 63 6c  file `sample.tcl
1ca0: 73 68 72 63 27 29 2e 20 54 68 65 20 6d 61 69 6e  shrc'). The main
1cb0: 20 6c 6f 6f 70 20 73 65 74 73 20 75 70 20 73 6f   loop sets up so
1cc0: 6d 65 0a 63 6f 6d 70 6c 65 74 69 6f 6e 20 63 68  me.completion ch
1cd0: 61 72 61 63 74 65 72 69 73 74 69 63 73 20 61 73  aracteristics as
1ce0: 20 76 61 72 69 61 62 6c 65 20 2d 2d 20 74 72 79   variable -- try
1cf0: 20 73 6f 6d 65 74 68 69 6e 67 20 6c 69 6b 65 20   something like 
1d00: 22 70 75 74 73 20 24 62 3c 54 41 42 3e 22 20 2d  "puts $b<TAB>" -
1d10: 2d 0a 61 6e 64 20 63 6f 6d 6d 61 6e 64 20 63 6f  -.and command co
1d20: 6d 70 6c 65 74 69 6f 6e 20 2d 2d 20 74 72 79 20  mpletion -- try 
1d30: 22 70 75 74 73 20 5b 69 6e 3c 54 41 42 3e 22 2e  "puts [in<TAB>".
1d40: 0a 49 66 20 74 68 65 20 6f 70 74 69 6f 6e 61 6c  .If the optional
1d50: 20 61 72 67 75 6d 65 6e 74 20 5c 66 49 68 69 73   argument \fIhis
1d60: 74 6f 72 79 66 69 6c 65 5c 66 50 20 69 73 20 67  toryfile\fP is g
1d70: 69 76 65 6e 2c 20 74 68 69 73 20 66 69 6c 65 20  iven, this file 
1d80: 77 69 6c 6c 0a 62 65 20 75 73 65 64 20 66 6f 72  will.be used for
1d90: 20 72 65 61 64 69 6e 67 20 61 6e 64 20 77 72 69   reading and wri
1da0: 74 69 6e 67 20 74 68 65 20 63 6f 6d 6d 61 6e 64  ting the command
1db0: 20 68 69 73 74 6f 72 79 20 69 6e 73 74 65 61 64   history instead
1dc0: 20 6f 66 20 74 68 65 0a 64 65 66 61 75 6c 74 20   of the.default 
1dd0: 5c 66 42 2e 74 63 6c 73 68 2d 68 69 73 74 6f 72  \fB.tclsh-histor
1de0: 79 5c 66 50 2e 0a 5c 66 42 3a 3a 74 63 6c 72 65  y\fP..\fB::tclre
1df0: 61 64 6c 69 6e 65 3a 3a 4c 6f 6f 70 5c 66 50 20  adline::Loop\fP 
1e00: 77 69 6c 6c 20 6e 6f 72 6d 61 6c 6c 79 20 6e 6f  will normally no
1e10: 74 20 72 65 74 75 72 6e 2e 0a 49 66 20 79 6f 75  t return..If you
1e20: 20 77 61 6e 74 20 74 6f 20 77 72 69 74 65 20 79   want to write y
1e30: 6f 75 72 20 6f 77 6e 20 6d 61 69 6e 20 6c 6f 6f  our own main loo
1e40: 70 20 61 6e 64 2f 6f 72 20 6f 77 6e 20 63 75 73  p and/or own cus
1e50: 74 6f 6d 20 63 6f 6d 70 6c 65 74 65 72 73 2c 0a  tom completers,.
1e60: 69 74 20 69 73 20 70 72 6f 62 61 62 6c 79 20 61  it is probably a
1e70: 20 67 6f 6f 64 20 69 64 65 61 20 74 6f 20 73 74   good idea to st
1e80: 61 72 74 20 77 69 74 68 20 74 63 6c 72 65 61 64  art with tclread
1e90: 6c 69 6e 65 3a 3a 4c 6f 6f 70 0a 28 73 65 65 20  line::Loop.(see 
1ea0: 74 68 65 20 66 69 6c 65 20 74 63 6c 72 65 61 64  the file tclread
1eb0: 6c 69 6e 65 53 65 74 75 70 2e 74 63 6c 29 2e 0a  lineSetup.tcl)..
1ec0: 0a 2e 54 50 20 35 0a 5c 66 42 3a 3a 74 63 6c 72  ..TP 5.\fB::tclr
1ed0: 65 61 64 6c 69 6e 65 3a 3a 70 72 6f 6d 70 74 31  eadline::prompt1
1ee0: 5c 66 50 0a 61 20 70 72 6f 63 20 77 68 69 63 68  \fP.a proc which
1ef0: 20 69 73 20 63 61 6c 6c 65 64 20 62 79 20 3a 3a   is called by ::
1f00: 74 63 6c 72 65 61 64 6c 69 6e 65 3a 3a 4c 6f 6f  tclreadline::Loo
1f10: 70 20 61 6e 64 20 72 65 74 75 72 6e 73 20 61 20  p and returns a 
1f20: 73 74 72 69 6e 67 0a 77 68 69 63 68 20 77 69 6c  string.which wil
1f30: 6c 20 62 65 20 64 69 73 70 6c 61 79 65 64 20 61  l be displayed a
1f40: 73 20 74 68 65 20 70 72 69 6d 61 72 79 20 70 72  s the primary pr
1f50: 6f 6d 70 74 2e 20 54 68 69 73 20 70 72 6f 6d 70  ompt. This promp
1f60: 74 20 77 69 6c 6c 20 62 65 0a 73 6f 6d 65 74 68  t will be.someth
1f70: 69 6e 67 20 6c 69 6b 65 20 22 5b 69 6e 66 6f 20  ing like "[info 
1f80: 6e 61 6d 65 6f 66 65 78 65 63 75 74 61 62 6c 65  nameofexecutable
1f90: 5d 20 5c 5c 5b 5b 70 77 64 5d 5c 5c 5d 22 20 70  ] \\[[pwd]\\]" p
1fa0: 6f 73 73 69 62 6c 79 20 66 61 6e 63 79 20 63 6f  ossibly fancy co
1fb0: 6c 6f 72 65 64 2e 0a 54 68 65 20 64 65 66 61 75  lored..The defau
1fc0: 6c 74 20 70 72 6f 63 20 69 73 20 64 65 66 69 6e  lt proc is defin
1fd0: 65 64 20 6f 6e 20 65 6e 74 65 72 69 6e 67 20 74  ed on entering t
1fe0: 68 65 20 3a 3a 74 63 6c 72 65 61 64 6c 69 6e 65  he ::tclreadline
1ff0: 3a 3a 4c 6f 6f 70 2c 0a 69 66 20 69 74 20 69 73  ::Loop,.if it is
2000: 20 6e 6f 74 20 61 6c 72 65 61 64 79 20 64 65 66   not already def
2010: 69 6e 65 64 2e 20 53 6f 3a 20 49 66 20 79 6f 75  ined. So: If you
2020: 20 64 65 66 69 6e 65 20 79 6f 75 72 20 6f 77 6e   define your own
2030: 20 70 72 6f 63 0a 3a 3a 74 63 6c 72 65 61 64 6c   proc.::tclreadl
2040: 69 6e 65 3a 3a 70 72 6f 6d 70 74 31 20 62 65 66  ine::prompt1 bef
2050: 6f 72 65 20 65 6e 74 65 72 69 6e 67 20 3a 3a 74  ore entering ::t
2060: 63 6c 72 65 61 64 6c 69 6e 65 3a 3a 4c 6f 6f 70  clreadline::Loop
2070: 2c 20 74 68 69 73 0a 70 72 6f 63 20 69 73 20 63  , this.proc is c
2080: 61 6c 6c 65 64 20 65 61 63 68 20 74 69 6d 65 20  alled each time 
2090: 74 68 65 20 70 72 6f 6d 70 74 20 69 73 20 74 6f  the prompt is to
20a0: 20 62 65 20 64 69 73 70 6c 61 79 65 64 2e 0a 45   be displayed..E
20b0: 78 61 6d 70 6c 65 3a 0a 2e 43 53 0a 20 20 20 20  xample:..CS.    
20c0: 70 61 63 6b 61 67 65 20 72 65 71 75 69 72 65 20  package require 
20d0: 74 63 6c 72 65 61 64 6c 69 6e 65 0a 20 20 20 20  tclreadline.    
20e0: 6e 61 6d 65 73 70 61 63 65 20 65 76 61 6c 20 74  namespace eval t
20f0: 63 6c 72 65 61 64 6c 69 6e 65 20 7b 0a 20 20 20  clreadline {.   
2100: 20 20 20 20 20 70 72 6f 63 20 70 72 6f 6d 70 74       proc prompt
2110: 31 20 7b 7d 20 7b 0a 20 20 20 20 20 20 20 20 20  1 {} {.         
2120: 20 20 20 72 65 74 75 72 6e 20 22 5b 63 6c 6f 63     return "[cloc
2130: 6b 20 66 6f 72 6d 61 74 20 5b 63 6c 6f 63 6b 20  k format [clock 
2140: 73 65 63 6f 6e 64 73 5d 5d 3e 20 22 0a 20 20 20  seconds]]> ".   
2150: 20 20 20 20 20 7d 0a 20 20 20 20 7d 0a 20 20 20       }.    }.   
2160: 20 3a 3a 74 63 6c 72 65 61 64 6c 69 6e 65 3a 3a   ::tclreadline::
2170: 4c 6f 6f 70 0a 2e 43 45 0a 0a 4e 6f 74 65 20 74  Loop..CE..Note t
2180: 68 61 74 20 6e 6f 6e 2d 70 72 69 6e 74 61 62 6c  hat non-printabl
2190: 65 20 63 6f 6e 74 72 6f 6c 20 63 68 61 72 61 63  e control charac
21a0: 74 65 72 73 20 61 73 20 63 6f 6c 6f 72 20 63 6f  ters as color co
21b0: 6e 74 72 6f 6c 20 63 68 61 72 61 63 74 65 72 73  ntrol characters
21c0: 0a 6d 75 73 74 20 62 65 20 65 6e 63 6c 6f 73 65  .must be enclose
21d0: 64 20 69 6e 20 6c 69 74 65 72 61 6c 20 63 74 72  d in literal ctr
21e0: 6c 2d 61 20 2f 20 63 74 72 6c 2d 62 20 74 6f 20  l-a / ctrl-b to 
21f0: 74 65 6c 6c 20 72 65 61 64 6c 69 6e 65 20 74 68  tell readline th
2200: 65 20 6c 65 6e 67 74 68 0a 6f 66 20 74 68 65 20  e length.of the 
2210: 70 72 69 6e 74 61 62 6c 65 20 70 72 6f 6d 70 74  printable prompt
2220: 2e 20 53 65 65 20 66 6f 72 20 65 78 61 6d 70 6c  . See for exampl
2230: 65 20 74 68 65 20 76 61 72 69 61 62 6c 65 20 60  e the variable `
2240: 70 72 6f 6d 70 74 5f 73 74 72 69 6e 67 27 0a 69  prompt_string'.i
2250: 6e 20 74 68 65 20 66 69 6c 65 20 74 63 6c 72 65  n the file tclre
2260: 61 64 6c 69 6e 65 53 65 74 75 70 2e 74 63 6c 20  adlineSetup.tcl 
2270: 69 6e 20 79 6f 75 72 20 74 63 6c 72 65 61 64 6c  in your tclreadl
2280: 69 6e 65 20 69 6e 73 74 61 6c 6c 61 74 69 6f 6e  ine installation
2290: 20 64 69 72 65 63 74 6f 72 79 2e 0a 0a 2e 54 50   directory....TP
22a0: 20 35 0a 5c 66 42 3a 3a 74 63 6c 72 65 61 64 6c   5.\fB::tclreadl
22b0: 69 6e 65 3a 3a 70 72 6f 6d 70 74 32 5c 66 50 0a  ine::prompt2\fP.
22c0: 61 20 70 72 6f 63 20 77 68 69 63 68 20 69 73 20  a proc which is 
22d0: 63 61 6c 6c 65 64 20 62 79 20 3a 3a 74 63 6c 72  called by ::tclr
22e0: 65 61 64 6c 69 6e 65 3a 3a 4c 6f 6f 70 20 61 6e  eadline::Loop an
22f0: 64 20 72 65 74 75 72 6e 73 20 61 20 73 74 72 69  d returns a stri
2300: 6e 67 0a 77 68 69 63 68 20 77 69 6c 6c 20 62 65  ng.which will be
2310: 20 64 69 73 70 6c 61 79 65 64 20 61 73 20 74 68   displayed as th
2320: 65 20 73 65 63 6f 6e 64 61 72 79 20 70 72 6f 6d  e secondary prom
2330: 70 74 20 77 68 65 6e 20 69 6e 74 65 72 61 63 74  pt when interact
2340: 69 76 65 6c 79 0a 70 72 6f 6d 70 74 69 6e 67 20  ively.prompting 
2350: 20 66 6f 72 20 20 63 6f 6e 74 69 6e 75 61 74 69   for  continuati
2360: 6f 6e 20 20 6f 66 20 20 61 6e 20 69 6e 63 6f 6d  on  of  an incom
2370: 70 6c 65 74 65 20 63 6f 6d 6d 61 6e 64 2e 0a 0a  plete command...
2380: 2e 5c 22 20 2e 53 48 20 22 45 58 41 4d 50 4c 45  .\" .SH "EXAMPLE
2390: 53 22 0a 0a 0a 2e 5c 22 20 2e 53 48 20 22 45 4e  S"....\" .SH "EN
23a0: 56 49 52 4f 4e 4d 45 4e 54 20 56 41 52 49 41 42  VIRONMENT VARIAB
23b0: 4c 45 53 22 0a 0a 2e 53 48 20 22 56 41 52 49 41  LES"...SH "VARIA
23c0: 42 4c 45 53 22 0a 0a 5c 66 49 74 63 6c 72 65 61  BLES"..\fItclrea
23d0: 64 6c 69 6e 65 5c 66 50 20 64 65 66 69 6e 65 73  dline\fP defines
23e0: 20 74 68 65 20 66 6f 6c 6c 6f 77 69 6e 67 20 76   the following v
23f0: 61 72 69 61 62 6c 65 73 20 69 6e 20 74 68 65 0a  ariables in the.
2400: 6e 61 6d 65 73 70 61 63 65 20 5c 66 49 3a 3a 74  namespace \fI::t
2410: 63 6c 72 65 61 64 6c 69 6e 65 5c 66 50 3a 0a 28  clreadline\fP:.(
2420: 66 6f 72 20 62 61 63 6b 77 61 72 64 73 20 63 6f  for backwards co
2430: 6d 70 61 74 69 62 69 6c 69 74 79 20 74 68 65 20  mpatibility the 
2440: 67 6c 6f 62 61 6c 20 76 61 72 69 61 62 6c 65 73  global variables
2450: 20 74 63 6c 72 65 61 64 6c 69 6e 65 5f 76 65 72   tclreadline_ver
2460: 73 69 6f 6e 2c 0a 20 74 63 6c 72 65 61 64 6c 69  sion,. tclreadli
2470: 6e 65 5f 70 61 74 63 68 4c 65 76 65 6c 20 61 6e  ne_patchLevel an
2480: 64 20 74 63 6c 72 65 61 64 6c 69 6e 65 5f 6c 69  d tclreadline_li
2490: 62 72 61 72 79 20 61 72 65 20 73 74 69 6c 6c 20  brary are still 
24a0: 70 72 65 73 65 6e 74 29 2e 0a 0a 2e 54 50 20 35  present)....TP 5
24b0: 0a 5c 66 42 74 63 6c 72 65 61 64 6c 69 6e 65 3a  .\fBtclreadline:
24c0: 3a 76 65 72 73 69 6f 6e 5c 66 50 20 28 72 65 61  :version\fP (rea
24d0: 64 2d 6f 6e 6c 79 29 0a 68 6f 6c 64 73 20 74 68  d-only).holds th
24e0: 65 20 76 65 72 73 69 6f 6e 20 73 74 72 69 6e 67  e version string
24f0: 20 22 40 56 45 52 53 49 4f 4e 40 22 2e 0a 0a 2e   "@VERSION@"....
2500: 54 50 20 35 0a 5c 66 42 74 63 6c 72 65 61 64 6c  TP 5.\fBtclreadl
2510: 69 6e 65 3a 3a 70 61 74 63 68 4c 65 76 65 6c 5c  ine::patchLevel\
2520: 66 50 20 28 72 65 61 64 2d 6f 6e 6c 79 29 0a 68  fP (read-only).h
2530: 6f 6c 64 73 20 74 68 65 20 70 61 74 63 68 20 6c  olds the patch l
2540: 65 76 65 6c 20 73 74 72 69 6e 67 20 22 40 50 41  evel string "@PA
2550: 54 43 48 4c 45 56 45 4c 5f 53 54 52 40 22 2e 0a  TCHLEVEL_STR@"..
2560: 0a 2e 54 50 20 35 0a 5c 66 42 74 63 6c 72 65 61  ..TP 5.\fBtclrea
2570: 64 6c 69 6e 65 3a 3a 6c 69 62 72 61 72 79 5c 66  dline::library\f
2580: 50 20 28 72 65 61 64 2d 6f 6e 6c 79 29 0a 68 6f  P (read-only).ho
2590: 6c 64 73 20 74 68 65 20 6c 69 62 72 61 72 79 20  lds the library 
25a0: 73 74 72 69 6e 67 20 22 40 54 43 4c 52 4c 5f 44  string "@TCLRL_D
25b0: 49 52 40 22 2e 0a 0a 2e 54 50 20 35 0a 5c 66 42  IR@"....TP 5.\fB
25c0: 74 63 6c 72 65 61 64 6c 69 6e 65 3a 3a 6c 69 63  tclreadline::lic
25d0: 65 6e 73 65 5c 66 50 20 28 72 65 61 64 2d 6f 6e  ense\fP (read-on
25e0: 6c 79 29 0a 68 6f 6c 64 73 20 61 20 42 53 44 20  ly).holds a BSD 
25f0: 6c 69 63 65 6e 73 65 20 73 74 61 74 65 6d 65 6e  license statemen
2600: 74 2e 0a 0a 2e 54 50 20 35 0a 5c 66 42 74 63 6c  t....TP 5.\fBtcl
2610: 72 65 61 64 6c 69 6e 65 3a 3a 68 69 73 74 6f 72  readline::histor
2620: 79 4c 65 6e 67 74 68 5c 66 50 0a 4e 75 6d 62 65  yLength\fP.Numbe
2630: 72 20 6f 66 20 6c 69 6e 65 73 2c 20 77 68 69 63  r of lines, whic
2640: 68 20 77 69 6c 6c 20 62 65 20 77 72 69 74 74 65  h will be writte
2650: 6e 20 74 6f 20 74 68 65 20 68 69 73 74 6f 72 79  n to the history
2660: 66 69 6c 65 2e 0a 54 68 69 73 20 6e 75 6d 62 65  file..This numbe
2670: 72 20 69 73 20 2d 31 20 62 79 20 64 65 66 61 75  r is -1 by defau
2680: 6c 74 2c 20 77 68 69 63 68 20 6d 65 61 6e 73 20  lt, which means 
2690: 74 68 61 74 20 74 68 65 20 68 69 73 74 6f 72 79  that the history
26a0: 66 69 6c 65 0a 77 69 6c 6c 20 6e 6f 74 20 62 65  file.will not be
26b0: 20 74 72 75 6e 63 61 74 65 64 2e 20 20 53 65 65   truncated.  See
26c0: 20 61 6c 73 6f 20 5c 66 42 74 63 6c 72 65 61 64   also \fBtclread
26d0: 6c 69 6e 65 3a 3a 77 72 69 74 65 5c 66 50 2e 0a  line::write\fP..
26e0: 0a 2e 53 48 20 22 46 49 4c 45 53 22 0a 0a 74 68  ..SH "FILES"..th
26f0: 65 20 5c 66 42 2e 74 63 6c 73 68 72 63 5c 66 50  e \fB.tclshrc\fP
2700: 20 66 69 6c 65 20 69 6e 20 74 68 65 20 48 4f 4d   file in the HOM
2710: 45 20 64 69 72 65 63 74 6f 72 79 2c 20 77 68 69  E directory, whi
2720: 63 68 0a 69 73 20 72 65 61 64 20 6f 6e 20 74 63  ch.is read on tc
2730: 6c 73 68 20 73 74 61 72 74 75 70 2e 20 41 6c 74  lsh startup. Alt
2740: 65 72 6e 61 74 69 76 65 6c 79 2c 20 74 68 65 20  ernatively, the 
2750: 6e 61 6d 65 20 6f 66 20 74 68 69 73 20 69 6e 69  name of this ini
2760: 74 69 61 6c 69 7a 61 74 69 6f 6e 0a 66 69 6c 65  tialization.file
2770: 20 6d 69 67 68 74 20 62 65 20 5c 66 42 2e 77 69   might be \fB.wi
2780: 73 68 72 63 5c 66 50 20 2e 2e 2e 20 64 65 70 65  shrc\fP ... depe
2790: 6e 64 69 6e 67 20 6f 6e 20 77 68 61 74 20 69 6e  nding on what in
27a0: 74 65 72 70 72 65 74 65 72 20 79 6f 75 20 75 73  terpreter you us
27b0: 65 2e 0a 54 68 65 73 65 20 66 69 6c 65 73 20 73  e..These files s
27c0: 68 6f 75 6c 64 20 74 79 70 69 63 61 6c 6c 79 20  hould typically 
27d0: 63 6f 6e 74 61 69 6e 20 73 6f 6d 65 74 68 69 6e  contain somethin
27e0: 67 20 6c 69 6b 65 0a 2e 43 53 0a 20 20 20 20 69  g like..CS.    i
27f0: 66 20 7b 24 74 63 6c 5f 69 6e 74 65 72 61 63 74  f {$tcl_interact
2800: 69 76 65 7d 20 7b 0a 20 20 20 20 20 20 20 20 70  ive} {.        p
2810: 61 63 6b 61 67 65 20 72 65 71 75 69 72 65 20 74  ackage require t
2820: 63 6c 72 65 61 64 6c 69 6e 65 0a 20 20 20 20 20  clreadline.     
2830: 20 20 20 3a 3a 74 63 6c 72 65 61 64 6c 69 6e 65     ::tclreadline
2840: 3a 3a 4c 6f 6f 70 0a 20 20 20 20 7d 0a 2e 43 45  ::Loop.    }..CE
2850: 0a 0a 77 68 69 63 68 20 77 69 6c 6c 20 65 6e 74  ..which will ent
2860: 65 72 20 74 68 65 20 74 63 6c 72 65 61 64 6c 69  er the tclreadli
2870: 6e 65 20 6d 61 69 6e 20 6c 6f 6f 70 2e 0a 0a 2e  ne main loop....
2880: 50 50 0a 74 68 65 20 5c 66 42 2e 74 63 6c 73 68  PP.the \fB.tclsh
2890: 2d 68 69 73 74 6f 72 79 5c 66 50 20 66 69 6c 65  -history\fP file
28a0: 20 69 6e 20 74 68 65 20 48 4f 4d 45 20 64 69 72   in the HOME dir
28b0: 65 63 74 6f 72 79 2e 20 4f 6e 20 73 74 61 72 74  ectory. On start
28c0: 75 70 0a 63 6f 6d 6d 61 6e 64 73 20 77 69 6c 6c  up.commands will
28d0: 20 62 65 20 72 65 61 64 20 66 72 6f 6d 20 74 68   be read from th
28e0: 69 73 20 66 69 6c 65 2e 20 4f 6e 20 65 78 69 74  is file. On exit
28f0: 2c 20 74 68 65 20 72 65 61 64 6c 69 6e 65 20 68  , the readline h
2900: 69 73 74 6f 72 79 0a 69 73 20 77 72 69 74 74 65  istory.is writte
2910: 6e 20 74 6f 20 74 68 69 73 20 66 69 6c 65 2e 20  n to this file. 
2920: 4e 6f 74 65 20 74 68 61 74 20 69 66 20 79 6f 75  Note that if you
2930: 20 61 62 6f 72 74 20 74 63 6c 73 68 20 77 69 74   abort tclsh wit
2940: 68 20 3c 63 6e 74 72 6c 2d 63 3e 0a 6e 6f 20 68  h <cntrl-c>.no h
2950: 69 73 74 6f 72 79 20 69 73 20 77 72 69 74 74 65  istory is writte
2960: 6e 2e 20 46 6f 72 20 74 68 65 20 66 75 74 75 72  n. For the futur
2970: 65 20 69 74 20 69 73 20 70 6c 61 6e 6e 65 64 20  e it is planned 
2980: 74 6f 20 73 65 74 20 75 70 20 61 20 73 69 67 6e  to set up a sign
2990: 61 6c 0a 68 61 6e 64 6c 65 72 2c 20 77 68 69 63  al.handler, whic
29a0: 68 20 77 69 6c 6c 20 77 72 69 74 65 20 74 68 65  h will write the
29b0: 20 68 69 73 74 6f 72 79 20 6f 6e 20 3c 63 74 72   history on <ctr
29c0: 6c 2d 63 3e 20 62 65 66 6f 72 65 20 65 78 69 74  l-c> before exit
29d0: 69 6e 67 2e 0a 0a 2e 50 50 0a 74 68 65 20 5c 66  ing....PP.the \f
29e0: 42 2e 69 6e 70 75 74 72 63 5c 66 50 20 66 69 6c  B.inputrc\fP fil
29f0: 65 20 69 6e 20 74 68 65 20 75 73 65 72 73 20 48  e in the users H
2a00: 4f 4d 45 20 64 69 72 65 63 74 6f 72 79 2e 20 54  OME directory. T
2a10: 68 69 73 20 66 69 6c 65 0a 69 73 20 75 73 65 64  his file.is used
2a20: 20 6e 6f 72 6d 61 6c 6c 79 20 66 6f 72 20 61 6c   normally for al
2a30: 6c 20 70 72 6f 67 72 61 6d 73 20 77 68 69 63 68  l programs which
2a40: 20 75 73 65 20 74 68 65 20 67 6e 75 20 72 65 61   use the gnu rea
2a50: 64 6c 69 6e 65 20 28 65 2e 67 2e 20 20 62 61 73  dline (e.g.  bas
2a60: 68 29 2e 0a 54 68 65 20 60 67 6c 6f 62 61 6c 27  h)..The `global'
2a70: 20 72 65 61 64 6c 69 6e 65 20 73 65 74 74 69 6e   readline settin
2a80: 67 73 20 74 68 65 72 65 20 77 69 6c 6c 20 62 65  gs there will be
2a90: 20 76 61 6c 69 64 20 61 6c 73 6f 20 66 6f 72 0a   valid also for.
2aa0: 5c 66 42 74 63 6c 72 65 61 64 6c 69 6e 65 5c 66  \fBtclreadline\f
2ab0: 50 2e 20 41 64 64 69 74 69 6f 6e 61 6c 6c 79 20  P. Additionally 
2ac0: 74 68 65 20 2e 69 6e 70 75 74 72 63 20 6d 69 67  the .inputrc mig
2ad0: 68 74 20 68 6f 6c 64 20 63 6f 6e 64 69 74 69 6f  ht hold conditio
2ae0: 6e 61 6c 0a 73 65 74 74 69 6e 67 73 20 66 6f 72  nal.settings for
2af0: 20 74 68 65 20 69 6d 70 6c 65 6d 65 6e 74 61 74   the implementat
2b00: 69 6f 6e 20 6e 61 6d 65 20 5c 66 42 74 63 6c 72  ion name \fBtclr
2b10: 65 61 64 6c 69 6e 65 5c 66 50 2e 20 45 78 61 6d  eadline\fP. Exam
2b20: 70 6c 65 20 6f 66 0a 73 6f 6d 65 20 6c 69 6e 65  ple of.some line
2b30: 73 20 69 6e 20 79 6f 75 72 20 2e 69 6e 70 75 74  s in your .input
2b40: 72 63 3a 0a 2e 43 53 0a 20 20 20 20 24 69 66 20  rc:..CS.    $if 
2b50: 74 63 6c 72 65 61 64 6c 69 6e 65 0a 20 20 20 20  tclreadline.    
2b60: 22 5c 5c 43 2d 78 70 22 3a 20 22 70 75 74 73 20  "\\C-xp": "puts 
2b70: 24 65 6e 76 28 50 41 54 48 29 22 0a 20 20 20 20  $env(PATH)".    
2b80: 24 65 6e 64 69 66 0a 2e 43 45 0a 0a 46 6f 72 20  $endif..CE..For 
2b90: 66 75 72 74 68 65 72 20 64 6f 63 75 6d 65 6e 74  further document
2ba0: 61 74 69 6f 6e 20 70 6c 65 61 73 65 20 72 65 66  ation please ref
2bb0: 65 72 20 74 6f 20 74 68 65 20 67 6e 75 20 72 65  er to the gnu re
2bc0: 61 64 6c 69 6e 65 20 64 6f 63 75 6d 65 6e 74 61  adline documenta
2bd0: 74 69 6f 6e 2e 0a 0a 2e 53 48 20 22 42 55 47 53  tion....SH "BUGS
2be0: 22 0a 63 69 74 69 6e 67 20 74 68 65 20 72 65 61  ".citing the rea
2bf0: 64 6c 69 6e 65 20 6d 61 6e 75 61 6c 3a 20 20 49  dline manual:  I
2c00: 74 27 73 20 74 6f 6f 20 62 69 67 20 61 6e 64 20  t's too big and 
2c10: 74 6f 6f 20 73 6c 6f 77 2e 0a 0a 0a 2e 53 48 20  too slow.....SH 
2c20: 22 53 45 45 20 41 4c 53 4f 22 0a 0a 0a 2e 50 50  "SEE ALSO"....PP
2c30: 0a 54 68 65 20 6f 66 66 69 63 69 61 6c 20 5c 66  .The official \f
2c40: 42 74 63 6c 72 65 61 64 6c 69 6e 65 5c 66 50 20  Btclreadline\fP 
2c50: 77 65 62 20 73 69 74 65 20 61 74 3a 0a 0a 2e 50  web site at:...P
2c60: 50 0a 2e 52 53 20 34 0a 68 74 74 70 3a 2f 2f 77  P..RS 4.http://w
2c70: 77 77 2e 7a 65 6c 6c 6e 65 72 2e 6f 72 67 2f 74  ww.zellner.org/t
2c80: 63 6c 72 65 61 64 6c 69 6e 65 2f 0a 2e 52 45 0a  clreadline/..RE.
2c90: 0a 0a 2e 53 48 20 22 41 55 54 48 4f 52 22 0a 4a  ...SH "AUTHOR".J
2ca0: 6f 68 61 6e 6e 65 73 20 5a 65 6c 6c 6e 65 72 2c  ohannes Zellner,
2cb0: 20 3c 6a 6f 68 61 6e 6e 65 73 40 7a 65 6c 6c 6e   <johannes@zelln
2cc0: 65 72 2e 6f 72 67 3e 0a 0a 2e 53 48 20 22 43 4f  er.org>...SH "CO
2cd0: 4e 54 52 49 42 55 54 49 4f 4e 53 2c 20 53 55 47  NTRIBUTIONS, SUG
2ce0: 47 45 53 54 49 4f 4e 53 20 41 4e 44 20 50 41 54  GESTIONS AND PAT
2cf0: 43 48 45 53 22 0a 4d 61 67 6e 75 73 20 45 72 69  CHES".Magnus Eri
2d00: 6b 73 73 6f 6e 20 3c 6d 61 67 6e 75 73 2e 65 72  ksson <magnus.er
2d10: 69 6b 73 73 6f 6e 40 6e 65 74 69 6e 73 69 67 68  iksson@netinsigh
2d20: 74 2e 73 65 3e 2c 0a 4c 65 73 20 4a 6f 68 6e 73  t.se>,.Les Johns
2d30: 6f 6e 20 3c 6c 65 73 40 69 6e 66 6f 6c 61 62 73  on <les@infolabs
2d40: 2e 63 6f 6d 3e 2c 0a 48 61 72 61 6c 64 20 4b 69  .com>,.Harald Ki
2d50: 72 73 63 68 20 3c 6b 69 72 40 69 69 74 62 2e 66  rsch <kir@iitb.f
2d60: 68 67 2e 64 65 3e 2c 0a 43 68 72 69 73 74 69 61  hg.de>,.Christia
2d70: 6e 20 4b 72 6f 6e 65 20 3c 6b 72 69 73 63 68 61  n Krone <krischa
2d80: 6e 40 73 71 6c 2e 64 65 3e 2c 0a 4c 61 72 72 79  n@sql.de>,.Larry
2d90: 20 57 2e 20 56 69 72 64 65 6e 20 3c 6c 76 69 72   W. Virden <lvir
2da0: 64 65 6e 40 63 61 73 2e 6f 72 67 3e 2c 0a 44 61  den@cas.org>,.Da
2db0: 76 69 64 20 45 6e 67 65 6c 20 3c 64 6c 65 6e 67  vid Engel <dleng
2dc0: 65 6c 40 68 6f 6d 65 2e 63 6f 6d 3e 20 3c 64 61  el@home.com> <da
2dd0: 76 69 64 40 64 65 62 69 61 6e 2e 6f 72 67 3e 2c  vid@debian.org>,
2de0: 0a 4d 61 74 74 68 65 77 20 43 6c 61 72 6b 65 20  .Matthew Clarke 
2df0: 3c 4d 61 74 74 68 65 77 5f 43 6c 61 72 6b 65 40  <Matthew_Clarke@
2e00: 6d 69 6e 64 6c 69 6e 6b 2e 62 63 2e 63 61 3e 0a  mindlink.bc.ca>.
2e10: 0a 2e 53 48 20 22 44 45 42 49 41 4e 20 50 41 43  ..SH "DEBIAN PAC
2e20: 4b 41 47 45 22 0a 44 61 76 69 64 20 45 6e 67 65  KAGE".David Enge
2e30: 6c 20 3c 64 6c 65 6e 67 65 6c 40 68 6f 6d 65 2e  l <dlengel@home.
2e40: 63 6f 6d 3e 2c 20 3c 64 61 76 69 64 40 64 65 62  com>, <david@deb
2e50: 69 61 6e 2e 6f 72 67 3e 0a 0a 2e 53 48 20 22 44  ian.org>...SH "D
2e60: 49 53 43 4c 41 49 4d 45 52 22 0a 0a 5c 66 42 74  ISCLAIMER"..\fBt
2e70: 63 6c 72 65 61 64 6c 69 6e 65 5c 66 50 20 63 6f  clreadline\fP co
2e80: 6d 65 73 20 77 69 74 68 20 61 20 42 53 44 20 74  mes with a BSD t
2e90: 79 70 65 20 6c 69 63 65 6e 73 65 2e 0a 54 68 65  ype license..The
2ea0: 20 72 65 61 64 2d 6f 6e 6c 79 20 76 61 72 69 61   read-only varia
2eb0: 62 6c 65 20 74 63 6c 72 65 61 64 6c 69 6e 65 3a  ble tclreadline:
2ec0: 3a 6c 69 63 65 6e 73 65 20 68 6f 6c 64 73 20 74  :license holds t
2ed0: 68 65 0a 63 6f 6d 70 6c 65 74 65 20 6c 69 63 65  he.complete lice
2ee0: 6e 73 65 20 73 74 61 74 65 6d 65 6e 74 2e 0a     nse statement..