home *** CD-ROM | disk | FTP | other *** search
/ Simtel MSDOS 1992 September / Simtel20_Sept92.cdr / msdos / sysutl / stack.arc / STACK.DOC < prev    next >
Text File  |  1988-03-07  |  7KB  |  181 lines
  1. STACK - Command Line Editor/Enhancer, Version 1.0  - by Shane Bergl
  2. =================================================
  3.  
  4.  
  5. WHAT IS IT ?
  6. ------------
  7.  
  8. There are a number of programs around that record the last few
  9. commands that were typed in a stack and allow you to recall them
  10. with a few key strokes.  I've always used one and feel a bit lost
  11. on a computer that doesn't have one.  The problem that I have
  12. with such utilities is that the stack quickly gets cluttered up
  13. with a 'rubbish' commands that I don't want to use again and I
  14. quickly loose track of whether the command I want is still in the
  15. stack or has been pushed out.
  16.  
  17. STACK is my solution to this problem.  In addition to the usual
  18. command line editing features STACK allows you to flip open a
  19. window showing you what commands are in the stack.  You can also
  20. cop∙ thesσ command≤ t∩ ß separatσ lis⌠ associateΣ witΦ the
  21. function keys.  A complete list of the commands for STACK appears
  22. below.
  23.  
  24.  
  25. ACKNOWLEDGMENT
  26. --------------
  27.  
  28. STACK originally started life as DOSKEY by Jeff Prosise as
  29. published in Australian Personal Computer.  While I have made
  30. extensive modifications some of the code remains much the same.
  31.  
  32.  
  33. COMPATIBILITY WITH OTHER UTILITIES
  34. ----------------------------------
  35.  
  36. STACK patches some DOS interrupts and can clash with other
  37. resident utilities especially keyboard enhancers such as
  38. SMARTKEY.  If you load it before such utilities there shouldn't
  39. be any problem.
  40.  
  41.  
  42. COPYWRITE, ETC
  43. --------------
  44.  
  45. While I claim ownership of the code there are no restrictions on
  46. who can use STACK or under what conditions.  Go for it.
  47.  
  48.  
  49. COMMANDS
  50. --------
  51.  
  52. Note: STACK is only active at the DOS prompt.
  53.  
  54. Windows  - some notes about how windows are controlled.
  55.          . When the window is opened and the command stack is
  56.            showing, the current command is highlighted.
  57.          . STACK only opens a window if PGUP or PGDN is pressed.
  58.            This saves having windows flashing around the place
  59.            when you know where the command you want is.
  60.          . If a window is displayed (using PGUP or PGDN) and theè           other key is pressed (PGDN or PGUP respectively) then
  61.            the window content is swapped.
  62.          . although up to 80 characters of command are stored, to
  63.            save space on the screen, only the first 32 characters
  64.            of commands are displayed in the window
  65.  
  66.  
  67. U╨       ¡ selec⌠ thσ precedinτ commanΣ anΣ displa∙ i⌠ a⌠ the
  68.            DOS prompt.  If the window is open select the correct
  69.            command list to display and highlight the command.
  70.  
  71. DOWN     - select the next command and display it at the DOS
  72.            prompt.  If the window is open select the correct
  73.            command list to display and highlight the command.
  74.  
  75. PGUP     - open a window and display the command stack
  76.  
  77. PGDN     - open a window and display the commands for the
  78.            function keys
  79.  
  80. HOME     - move the cursor to the left of the command line
  81.  
  82. END      - move the cursor to the right of the command line
  83.  
  84. DEL      - delete the character at the cursor
  85.  
  86. INS      - toggle insert mode.  Insert on is indicated by a block
  87.            shaped cursor
  88.  
  89. Backspace- delete the character to the left of the cursor
  90.  
  91. ESC      - clear the command line and close the window
  92.  
  93. TAB      - delete the currently highlighted command from the stack
  94.  
  95. Fn       - issue the command associated with that function key.
  96. Shift Fn   You can't issue the command associated with a function
  97.            key using the highlight bar - you must press the
  98.            function key.  The function keys that can be programmed
  99.            in this way are F1 to F10 and shift F1 to shift F5.
  100.  
  101. Ctrl Fn  - copy the current command to this function key.  Ctrl F1
  102.            to ctrl F10 copy to the corresponding function key,
  103.            alt F1 to alt F5 copy to shift F1 to shift F5
  104.            respectively.  If STACK is currently in insert mode (ie.
  105.            you pressed INS and the block cursor is showing) then NO
  106.            carriage return is added to the end.  This means that when
  107.            you use that function key you can add some more to the end
  108.            before pressing Return/Enter.  If insert mode if off then
  109.            a carriage return is added to the end and the command will
  110.            be executed as soon as you press the function key.
  111.  
  112. Ctrl END - modify STACK.COM by writing the current (ie. in memory)
  113.            definitions of the function keys to STACK.COM.  The memory
  114.            copy of STACK expects STACK.COM to be located in the
  115.            current drive and directory, if it isn't you'll get a
  116.            cryptic error message on the command line (it isn't placed
  117.            in the DOS buffer so just type over the error message).
  118.  
  119.  
  120. MODIFICATIONS
  121. -------------
  122.  
  123. For those who are game, the following information is provided to
  124. help you modify the colours using DEBUG, PCTOOLS, etc.  (Addresses are
  125. offset from start of file - add 100h if using DEBUG).
  126.  
  127. Address
  128. 06Ch     - this byte controls the main window colours.  The
  129.            first 4 bits are the back ground colour, the next 4è           are the text colour
  130.  
  131. 06Dh     - as above but controls the colours for the highlight
  132.            bar
  133.  
  134.  
  135.  
  136. CONTACTING THE AUTHOR
  137. ---------------------
  138.  
  139. If you discover bugs in STACK or would like to discuss some
  140. aspects of it I can be contacted at home on (062) 369 216 or by
  141. writing to PO Box 78, Dickson, Australian Capital Territory, 2602
  142.  
  143.  
  144. REVISION HISTORY
  145. ----------------
  146.  
  147. Version 1.1
  148.  
  149. Like most programmers I can't resist adding just that one extra
  150. feature.  So STACK didn't make it further than a few of my friends
  151. before I added the following "improvements":
  152.  
  153.          - commands can now be deleted from the stack using the
  154.            TAB key
  155.          - the function keys which can be programmed have been
  156.            extended to include shift F1 to shift F5.
  157.  
  158.  
  159. Version 1.2
  160.  
  161. After giving some friends three versions of STACK in less than a week I
  162. sort of promised that I'd stop changing it at least for a while.  But
  163. you see there was this bug and while I was there ....   Anyway here
  164. are the changes in Version 1.2
  165.  
  166.          - fixed a bug with insert so that STACK didn't stay in insert
  167.            mode between commands.
  168.          - fixed TAB (delete) command.
  169.          - ESC now closes the window (just for you Dave).
  170.          - dropped dedicated support for function keys F11 and F12 -
  171.            it just wasn't worth maintaining two versions.
  172.          - modified "copy current command to function key" so that it
  173.            optionally added a carriage return depending on insert
  174.            mode.
  175.          - added facility to allow current copy of function keys to
  176.            be written back to disk (this ones for you Lyell).
  177.  
  178.  
  179. (The documentation has been updated to include these changes.)
  180.  
  181.