home *** CD-ROM | disk | FTP | other *** search
/ ftp.barnyard.co.uk / 2015.02.ftp.barnyard.co.uk.tar / ftp.barnyard.co.uk / cpm / walnut-creek-CDROM / BEEHIVE / TESERACT / TESS-025.ZIP / FK.DOC < prev    next >
Text File  |  1989-01-22  |  7KB  |  149 lines
  1. .margin10
  2. .pagelines66
  3. .lines52
  4. .top9
  5. .formstop
  6. .page7,75,#1
  7. .titlea,7,          FK--A Function Key Handler
  8. **********************************************************************
  9.   DOCUMENTATION FOR FK : A FUNCTION KEY HANDLER FOR PC-DOS 1.0 and 1.1
  10. **********************************************************************
  11.  
  12. I.  Introduction
  13.  
  14.        This document describes the program FK, a function key handler for
  15. use under IBM PC-DOS versions 1.0 and 1.1.  The program may not work 
  16. under other versions of DOS.
  17.  
  18.        The program was developed under a grant from Userview Corporation.
  19.  
  20.  
  21. II.  Rationale
  22.  
  23.        Under standard PC-DOS, the ten function keys are not used to their
  24. full potential.  The keys are used for simple command line editing, and
  25. several of the functions are duplicated by other keys on the keyboard.
  26. FK allows you to assign strings up to 24 characters in length to each
  27. of the function keys, so you can give an entire command or file name
  28. with a single keypress.
  29.  
  30.        For those who use the normal PC-DOS command line editing facilities,
  31. FK moves functions not already duplicated to keys on the cursor moving pad.
  32.  
  33.  
  34. III.  Using the program
  35.  
  36.        There are five different actions available with FK.  They all
  37. begin with the command name 'FK'; of course, the FK program (FK.COM) must be
  38. available on the selected disk drive when the command is issued.
  39.                                                            
  40.        The actions are as follows:
  41.  
  42.        SHOWING THE DEFINITIONS:  You may display the current definitions
  43. of the ten function keys by giving the command "FK". Control characters
  44. imbedded in the strings are displayed as ^x (just as they are echoed
  45. during command line input) except for carriage return (ENTER), which is 
  46. displayed as a leftward-pointing arrow.  Users with a printer may get
  47. a hardcopy of their definitions by pressing CTRL-PRTSC before giving the
  48. FK command.
  49.  
  50.        REDEFINING A KEY:  You may assign a string to one of the function
  51. keys by giving the command "FK Fn <string>" where n is the number of the
  52. key to assign (1 thru 10), and <string> is the string of characters you
  53. wish to get when you press that key.  For example, "FK F1 DIR" would
  54. assign the directory command "DIR" to function key F1.  You may include
  55. a carriage return in the string by using the vertical line character (|)
  56. wherever you want the CR; for example, "FK F1 DIR|" would do the directory
  57. command immediately upon your pressing F1 (in the previous case, you would
  58. have to press ENTER yourself after pressing F1).  Keys may only be assigned 
  59. strings of up to 24 characters in length; strings which are too long will
  60. be truncated without warning.
  61.  
  62.        SAVING THE DEFINITIONS:  You may save the current definitions of
  63. the function keys to a disk file for later use (see LOADING below).  To
  64. do so, give the command "FK SAVE <fname>" where <fname> is the name of
  65. the file in which to save the definitions.  For example, "FK SAVE MY.KEY"
  66. would save all current key assignments in the file "MY.KEY".  Any valid
  67. filename may be used, but the use of the ".KEY" extension is recommended
  68. for clarity.
  69.  
  70.        LOADING KEY DEFINITIONS:  You may recover key definitions previously
  71. saved with "FK SAVE" by typing "FK LOAD <fname>", where <fname> is the
  72. name of the file containing the key definitions.  You should *only* use
  73. this command on files which have been created by "FK SAVE"; if you don't,
  74. FK will probably not accept the file.  The key definitions which are
  75. automatically loaded with FK when it is first called should be available
  76. in the file "STD.KEY" on the disk with this document.
  77.  
  78.        GETTING HELP: You can get a rundown of these command formats by
  79. typing "FK HELP".
  80.  
  81.  
  82. IV.  Notes
  83.  
  84.        Abbreviations: You can use S, L, and H as abbreviations for
  85. "SAVE", "LOAD", and "HELP", respectively.  For example, you might type
  86. "FK L STD.KEY" to recover those definitions.
  87.  
  88.        Warning concerning key files:  Attempting to load key files
  89. which were not created with "FK SAVE" or which were altered with DEBUG
  90. or some editor may result in system crashes.
  91.  
  92.        Command line editing facilities:  As mentioned, the old actions
  93. assigned to the function keys have been moved to the cursor keypad.
  94. F1 (copy one char from template) has always been duplicated by the cursor-
  95. right key.  With FK active, the skip/copy function of F2 is moved to
  96. the cursor-up key.  Copy-remaining (F3) is moved to the END key.
  97. Skip/delete (F4) is now assigned to the down-arrow key. Move-displayed (F5)
  98. has been reassigned to the BACKTAB (shift-tab) key. (NOTE: versions
  99. of FK before 8/27/82 used the HOME key for this purpose.)
  100.  
  101.        F6 was used by DOS to issue the end-of-file mark, ^Z.  The
  102. standard key definitions leave ^Z assigned to F6, but if you need to
  103. change this, you can always signal end-of-file by typing CTRL-Z.
  104.  
  105.  
  106. V. Additions to revision 2 
  107.  
  108.        The following enhancements have been added to FK (version 08/27/82).
  109. Thanks to Webb Blackman, Jr. , and Michael Sullivan for suggestions and
  110. comments.
  111.  
  112.        * QUIET MODE: To prevent extraneous output during FK processing
  113.          (for example, the possibly unwanted listing of key definitions
  114.          during a "load" in an autoexec file), the 'quiet mode' option 
  115.          has been added.  Preceeding any command letter with 'Q' causes
  116.          most output to be suppressed.  Copyright notices and error 
  117.          messages will be displayed even if quiet mode is requested.
  118.          Example: "FK QL DEV.KEY" to 'quietly' load the definition file
  119.          "DEV.KEY".
  120.  
  121.        * WIDE DISPLAY:  Preceeding any command letter with 'W' causes
  122.          key definitions to be displayed two per line.  One can
  123.          also use "FK W" to simply display the keys in the wide format.
  124.  
  125.        * DEFAULT EXTENSION:  If no extension is supplied on loading
  126.          or saving keys, FK adds ".KEY" to the file name. 
  127.  
  128.        * ONE-KEY SCREEN CLEAR: The HOME key now clears the screen and
  129.          issues a carriage return.  As mentioned above, previous versions
  130.          of FK had used HOME for the old F5 function; 08/27/82 FK uses
  131.          BACKTAB for this function.
  132.  
  133.        * EASIER PATCHING:  FK has been recoded to facilitate patching
  134.          to support nonstandard versions of DOS (i.e. RAMDrive, Davong,
  135.          JEL, etc). Patching methods are beyond the scope of this
  136.          document, and users requiring patching should contact the
  137.          author at:
  138.  
  139.                Jeffrey P. Garbers
  140.                890E Clubhouse Circle West
  141.                Decatur, GA 30032
  142.  
  143.                or via SourceMail at CL0040.
  144. .page
  145. .formstopoff
  146. .eject
  147. bhouⁿAALLOT-V      17220of DOS (i.e. RAMDrive, Davong,
  148.          JEL, etc). Patching methods are beyond the scope of this
  149.          document, and users