home *** CD-ROM | disk | FTP | other *** search
/ Best Objectech Shareware Selections / UNTITLED.iso / boss / grap / util / 001 / buffit.doc < prev   
Text File  |  1991-04-18  |  15KB  |  304 lines

  1.  
  2.  
  3.  
  4.                  BUFFIT v3.0 a screen text capturing program
  5.                           Written by: D.T.Hamilton
  6.                                Copyright 1990
  7.  
  8.  
  9.  
  10.                                 INTRODUCTION
  11.  
  12. How many times have you done a 'dir' and had the top few filenames scroll
  13. off the top of your screen then wished you could get them back?  Or you are
  14. working in 'debug' and you have just traced 10 more instructions and wished
  15. you could see what the registers were before you traced the 10 instructions?
  16. How about when you 'type' a long text file and want to re-read one of the
  17. first lines after they are gone?
  18.  
  19. To solve these and other problems use BUFFIT. BUFFIT becomes memory resident
  20. and can be invoked whenever a program is awaiting keyboard input by typing
  21. a 'Hot Key' (the 'Hot Key' is user definable). BUFFIT will automatically
  22. capture and when invoked, allow you to redisplay all text output through DOS
  23. (but not text output directly to the video buffer or through Interupt 10H).
  24. You may move through the captured text a single line at a time or a page at a
  25. time. You can also go directly to the top or bottom of the captured text. Some
  26. of BUFFIT'S other features include printing the capture buffer or writing it
  27. out to a disk file.
  28.  
  29.  
  30.  
  31.                      NEW FEATURES ADDED SINCE VERSION 2.4
  32.  
  33. -BUFFIT can now use Extended Memory (XMS) Upper Memory Blocks (UMB's). See the
  34.   notes at the end of this document for details.
  35. -Control Panel Functions have been integrated into the Main Display.
  36. -BUFFIT can now unload itself from memory.
  37. -The method used by BUFFIT to determine if it is already presenst in memory
  38.   has been changed to be compatible with NOVELL Netware and BANYAN Vines.
  39. -Screen handling has been improved and simplified. Also better support for
  40.   EGA/VGA 43 and 50 line modes has been added.
  41. -Interrupts are now turned back on while BUFFIT is doing background processing
  42.   of DOS functions.
  43.  
  44.  
  45.  
  46.                              HARDWARE REQUIRED
  47.  
  48. BUFFIT will run on any IBM PC/XT/AT/PS2 or compatible with either a CGA, EGA,
  49. VGA or Monochrome monitor. BUFFIT will use about 10K of resident memory plus
  50. the size of the capture buffer (capture buffer size is user definable and
  51. defaults to 20000 bytes, which is enough to capture about 15 - 25 pages of
  52. screen text). BUFFIT will print to any standard 'parrallel' type 80/132 column
  53. printer that is attached to the port configured as 'LPT1' or 'PRN'.
  54.  
  55.  
  56.  
  57.                               LOADING BUFFIT
  58.  
  59. To load BUFFIT just type the command BUFFIT from your DOS prompt or put the
  60. command BUFFIT in your AUTOEXEC.BAT startup file if you have one. Note that
  61. the file 'BUFFIT.COM' must be in your current directory or in your DOS search
  62. PATH to load succesfully. You need only load BUFFIT once and it will remain in
  63. memory until the next time you re-boot. Note that if you are using a memory
  64. resident command line capture/edit program like DOSEDIT, CED or SUPERKEY that
  65. these programs should be loaded BEFORE you load BUFFIT for the best
  66. performance. BUFFIT may also be loaded with several optional command line
  67. parameters to customize its performance. The valid parameters are;
  68.  
  69.   /B  This parameter must be followed by a decimal number which represents
  70.         the size of the capture buffer that BUFFIT will use. This value    must
  71.         be between 1000 and 40000 and will be adjusted automatically if    not
  72.         divisible by 4.
  73.   /K  This parameter must be followed by a string which will tell BUFFIT what
  74.         'Hot Key' to use for invoking. The string consists of a letter chosen
  75.     from the following list:
  76.       N for normal keys
  77.       L for the Left shift key
  78.       R for the Right shift key
  79.       C for the Ctrl key
  80.       A for the Alt key
  81.         Next must come a quote character then the letter, number or symbol
  82.     for the key you wish to use followed by another quote character.
  83.     The function keys are indicated by the letter F followed by the 
  84.     appropriate number (use F0 to represent F10) instead of the letter,
  85.         number or symbol explained above.
  86.   /E or /V  These parameters will activate support for EGA 43 and VGA 50 line
  87.         modes. This will cause BUFFIT to use 4K of additional memory.
  88.   /L  This parameter forces BUFFIT to allocate and use regular DOS ram (LOW)
  89.         even if an appropriately sized Upper Memory Block (HIGH ram) exists.
  90.   /R  This parameter will cause BUFFIT to wait for video retrace when writing
  91.         to the video screen. This will eliminate 'snow' during BUFFIT displays
  92.     if your video controller is subject to snow. Only use this parameter
  93.     if you have snow as it slows down BUFFIT's display rate.
  94.   /C  This parameter will cause BUFFIT to use black and white attributes for
  95.         video displays even if you have a color monitor.
  96.  
  97.   /U  This parameter is used when BUFFIT is already loaded and will cause 
  98.         BUFFIT to unload itself from memory. If BUFFIT detects a problem
  99.         trying to unload it will issue an error message and remain in memory.
  100.   /D  This parameter is used when BUFFIT is already loaded and will cause
  101.         the 'Hot Key' to be disabled, using the command a second time will
  102.     cause it to be re-enabled. Use this parameter if you need to use 
  103.     BUFFIT'S 'Hot Key' for something else but you don't want to take 
  104.     BUFFIT out of memory.
  105.  
  106.  
  107.  
  108. Parameters may also be entered using a '-' in place of the '/' and you may
  109. string parameters together, for example the command:
  110.        BUFFIT -RKA'Z'
  111. would cause BUFFIT to load with the default capture buffer size of 20000
  112. bytes, wait for video retrace on displays and use 'Alt Z' as the 'Hot Key'
  113. for invoking it. The command:
  114.        BUFFIT /KC'F0' -C /B25000
  115. would achieve the same results as:
  116.        BUFFIT /KC'F0'CB25000
  117. which would cause BUFFIT to load with a capture buffer of 25000 bytes, use 
  118. only black and white display attributes and use 'CTRL F10' as the 'Hot Key'
  119. to invoke it.
  120.  
  121. If you have entered any invalid parameters or there is some other problem
  122. BUFFIT will tell you the cause and abort loading. Once BUFFIT has loaded
  123. succesfully it will print a start-up message indicating the selected
  124. 'Hot Key', whether HIGH or LOW ram is used, capture buffer size and video
  125. retrace status.
  126.  
  127.  
  128.  
  129.                         INVOKING AND USING BUFFIT
  130.          
  131. Invoking BUFFIT to redisplay captured text is as easy as pressing the defined
  132. 'Hot Key'. For example if you chose 'CTRL F10' as your 'Hot Key' you would
  133. hold down the CTRL key and then push the F10 function key. If the 'Hot Key'
  134. has been disabled by using the /D command line parameter you must re-enable it
  135. before BUFFIT will invoke. If you are not sure if the 'Hot Key' is enabled or
  136. disabled or you forget which key you have selected as the 'Hot Key' typing the
  137. command BUFFIT at your DOS prompt will cause BUFFIT to display it's current
  138. 'Hot Key' status. If the status is enabled it will also show you the current
  139. 'Hot Key' setting, if disabled BUFFIT will show the command used to re-enable
  140. it.
  141.  
  142. Note that BUFFIT will not allow you to invoke it if your screen is in a
  143. graphics mode, if this happens BUFFIT will give a couple of strange tones in
  144. your speaker when you press the 'Hot Key'.
  145.  
  146. Once invoked you will see a portion of captured text redisplayed on the screen
  147. with a special status line at the bottom. 
  148.  
  149. From the main display screen the following keys can be used:
  150.  
  151.     Up Arrow - moves the display window up 1 line if not already at top of 
  152.                captured text.
  153.  
  154.     Dn Arrow - moves the display window down 1 line if not already at bottom
  155.                of captured text.
  156.  
  157.     PgUp - moves the display window up 24 lines if not already at top of
  158.            captured text.
  159.  
  160.     PgDn - moves the display window down 24 lines if not already at bottom of
  161.            captured text.
  162.  
  163.     Home - moves the display window directly to the top of captured text.
  164.  
  165.     End  - moves the display window directly to the bottom of captured text.
  166.  
  167.     H, ? or F1 - will bring up the Help Window which contains a list of all
  168.                  available keys with a brief ex