home *** CD-ROM | disk | FTP | other *** search
/ Programmer 7500 / MAX_PROGRAMMERS.iso / INFO / KEYBOARD / RECALL11.ZIP / RECALL.DOC < prev    next >
Encoding:
Text File  |  1991-05-07  |  9.4 KB  |  249 lines
  1.  
  2.  
  3.                                 RECALL, v1.1a
  4.                                 -------------
  5.                                 from TifaWARE
  6.  
  7.  
  8.  
  9.  
  10. What's New
  11. ----------
  12.  
  13.  
  14.      Version 1.1 was the first public release of RECALL.
  15.  
  16.  
  17.  
  18.  
  19. Introduction
  20. ------------
  21.  
  22.  
  23.      RECALL is a memory-resident commandline editor and history utility.
  24. If until now you've been using DOS' built-in yet primitive editing keys
  25. you'll be pleasantly surprised. With RECALL you get improved commandline
  26. editing - including cursor movement and deletion by character/word/line -
  27. as well as a 1K LIFO buffer for keeping track of previously entered
  28. commandlines, commandlines which can be recalled with a single keystroke.
  29.  
  30.      Once installed in memory (it takes less than 2.5K) RECALL intercepts
  31. requests for buffered input and processes them itself. Typically, this
  32. type of input is used by DOS to read commands at the familiar "C>" prompt,
  33. although programs like DEBUG and LIST use it too. Ordinary keystrokes are
  34. saved in a buffer while you edit the commandline and then passed along
  35. when you hit <ENTER> just as they would be if RECALL were not active. A
  36. few special keys, however, let you edit what you've just typed or even
  37. recall commands entered earlier. These special keys - described below -
  38. are what make RECALL so useful.
  39.  
  40.  
  41.  
  42.  
  43. Usage
  44. -----
  45.  
  46.  
  47.      Running this program is quite simple. Assuming you've put RECALL.COM
  48. where DOS can find it, type "RECALL -?" to display a brief help message
  49. similar to the following:
  50.  
  51.      TifaWARE RECALL, v1.1a, 10/31/90 - commandline editor and history TSR.
  52.      Usage: recall [-options]
  53.      
  54.      Options:
  55.        -i = install in memory
  56.        -l = list commandlines in recall buffer
  57.        -r = remove from memory
  58.        -? = display this help message
  59.      
  60.      Only one option can be specified at a time.
  61.  
  62. [If you don't remember anything else from reading the documentation, at
  63. least remember how to display this help message.]
  64.  
  65.      There are two points of interest about RECALL's syntax. First, you
  66. must explicitly request that RECALL be installed in memory using the '-i'
  67. option. The reason for this extra work is that I consider it impolite for
  68. a program to alter a user's environment without permission. Second,
  69. options are mutually exclusive. (Who'd want to specify more than one
  70. option anyway?)
  71.  
  72.      Generally it's easiest to install RECALL from your AUTOEXEC.BAT -
  73. this way you'll have it available at all times. If you install other TSRs
  74. too, note that RECALL does not care where in the TSR chain it lies, except
  75. if you want to uninstall it later on. Should you choose not to install
  76. RECALL at boot time though, please be aware that it's generally unwise to
  77. install any TSR while "shelled out" to DOS from some other program.
  78.  
  79.      With RECALL resident chances are you won't even notice its presence -
  80. not, that is, until you need it. You'll enter commandlines just as you did
  81. before, only now RECALL's power, as summarized by the following table, is
  82. just a keystroke away:
  83.  
  84.  
  85.           Key                 Action
  86.           ---------------     -----------------------------------------
  87. Movement: <LEFT>              Move cursor 1 character to left
  88.           <RIGHT>             Move cursor 1 character to right
  89.           <PGUP>              Move cursor 1 "word" to left
  90.           <PGDN>              Move cursor 1 "word" to right
  91.           <HOME>              Move cursor to start of line
  92.           <END>               Move cursor to end of line
  93.  
  94. History:  <UP>                Display previous command in recall buffer
  95.           <DOWN>              Display next command in recall buffer
  96.  
  97. Deletion:
  98.           <CTRL><LEFT>        Delete 1 character to left of cursor
  99.           <BS>                "
  100.           <CTRL><RIGHT>       Delete 1 character at cursor
  101.           <DEL>               "
  102.           <CTRL><PGUP>        Delete to start of previous "word"
  103.           <CTRL><PGDN>        Delete to start of next "word"
  104.           <CTRL><HOME>        Delete to start of line
  105.           <CTRL><END>         Delete to end of line
  106.           <ESC>               Delete entire line
  107.  
  108. Toggle:   <INS>               Toggle insert/overwrite mode
  109.           ---------------     -----------------------------------------
  110.  
  111.  
  112. [A "word" is delineated by blanks or the start/end of a commandline.] As a
  113. general rule of thumb then, <KEY> is used to move along a commandline
  114. while <CTRL><KEY> deletes the corresponding group of characters. 
  115.  
  116.      After you've worked for a while you may want to list commandlines
  117. entered earlier. In this case invoke RECALL with the '-l' option, and the
  118. current buffer contents will be displayed. You can redirect this output to
  119. a file, printer, or even another program using DOS' redirection characters
  120. '>', '>>', and '|'. 
  121.  
  122.      Like any good memory-resident program RECALL can be removed
  123. completely from memory - just specify the '-r' option. RECALL will sense
  124. whether it is the last TSR to hook into the main DOS interrupt (21h) and
  125. abort if not. 
  126.  
  127.  
  128.  
  129.  
  130. If You Have Any Trouble
  131. -----------------------
  132.  
  133.  
  134.      RECALL will attempt to let you know of any problems that arise. Here
  135. are the possible error messages and how you should deal with each:
  136.  
  137.      recall: illegal option -- x.
  138.           - Type "RECALL -?" for a list of valid options.
  139.  
  140.      recall: already resident.
  141.           - RECALL found a copy of itself already active in
  142.             memory. Use the '-r' option to remove it if 
  143.             that's what you want.
  144.  
  145.      recall: memory control blocks corrupt.
  146.           - DOS detected an error when RECALL tried to free
  147.             its environment block. Your machine was likely
  148.             left in an unstable state by some earlier 
  149.             program.
  150.  
  151.      recall: not yet installed.
  152.           - You must install RECALL before you can remove it
  153.             from memory or list commandlines in its buffer.
  154.             This may also arise if you install some other 
  155.             TSR after RECALL which intercepts INT 21h; in 
  156.             this case you must remove the other TSR first.
  157.  
  158. These messages are written to the standard error device. In this way, they
  159. won't disappear down a pipe or into a file when redirecting RECALL's
  160. output.
  161.  
  162.      Additionally, RECALL uses a return code to convey information about
  163. the success or failure of its operation. Possible return values are:
  164.  
  165.      Code      Meaning
  166.      ----      -------
  167.      0         RECALL was successfully installed or removed
  168.      1         Help message was displayed
  169.      10        Installation failed
  170.      20        RECALL has not yet been installed
  171.  
  172. You can test for these codes using the ERRORLEVEL construct in a batch file.
  173.  
  174.  
  175.  
  176.  
  177. Requirements
  178. ------------
  179.  
  180.  
  181.      TifaWARE RECALL should run properly on any machine operating under
  182. MS-DOS v2.xx or later. PC compatibility should not be a concern unless
  183. your system uses something other than extended codes to represent keys on
  184. the numeric keypad. It requires less than 2.5K of memory. 
  185.  
  186.      I regularly work with RECALL in a variety of environments - including
  187. DESQview, PC-LAN, and PolyShell. [Of interest to DV users is the fact that
  188. RECALL does not churn thru CPU cycles while waiting for keystrokes and can
  189. be loaded into high memory with LOADHI.] While it is impossible to test
  190. RECALL in every possible configuration, I believe the techniques used here
  191. are fairly standard and should not lead to problems with other, well-
  192. behaved TSRs, shells, or operating environments.
  193.  
  194.  
  195.  
  196.  
  197. Who Owns It?
  198. ------------
  199.  
  200.  
  201.      I am releasing this implementation of RECALL into the public domain. 
  202. Since my involvement with MS-DOS began in 1984, I've been a heavy user of
  203. public domain software.  Public domain software is a terrific idea.  For
  204. the most part, programs are useful and the source code instructive ... all
  205. at no cost! With this small contribution to the public domain I hope to
  206. pay back, in some sense, my gratitude to those other programmers who have
  207. made my computing so much easier. 
  208.  
  209.      As a public domain program, RECALL carries no obligation on my part
  210. to support users or provide future upgrades.  I have tried to write clean
  211. code and believe it to be "bug-free".  Nevertheless, you must use this
  212. program ***AT YOUR OWN RISK***.  I strongly urge you to scan the source
  213. code yourself, make any desired changes, and recompile the program, if
  214. this is possible.  If you make this standard practice with newly acquired
  215. public domain software, you'll not only protect your system from worms and
  216. viruses but also get a better feel for exactly how each program works!
  217.  
  218.      As author of RECALL, I ask of you two things: First, if you
  219. distribute this program, please keep together my original source code,
  220. documentation, and executable.  This just makes it easier for others to
  221. use the software. Second, let me hear what you think of RECALL - your
  222. comments on a postcard would be appreciated. Enjoy!
  223.  
  224.  
  225.  
  226.  
  227. Kudos
  228. -----
  229.  
  230.  
  231.      Many thanks to Borland for v2.0 of its stand-alone debugger, which
  232. greatly reduced the time spent developing this program. I highly recommend
  233. it, especially if you plan on developing TSRs or device drivers.
  234.  
  235.  
  236.  
  237.  
  238.  
  239.                           George A. Theall
  240.  
  241.                              TifaWARE
  242.                        506 South 41st St., #3M
  243.                       Philadelphia, PA.  19104
  244.                               U.S.A.
  245.  
  246.                         +1 215 662 0558
  247.  
  248.                 GTHEALL@PENNDRLS.UPENN.EDU (Internet)
  249.