home *** CD-ROM | disk | FTP | other *** search
/ Columbia Kermit / kermit.zip / mskermit / msugold.txt < prev    next >
Text File  |  2020-01-01  |  6KB  |  155 lines
  1.              GOLD - Simulate GOLD Key with NUM LOCK - Version 2.4
  2.  
  3.                              Bob Eager, June 1992
  4.  
  5. Overview
  6. -------- 
  7. GOLD.COM (MSUGOLD.COM) is a simple TSR (Terminate and Stay Resident) program
  8. intended to make it easier to use MS-DOS Kermit as an emulator for DEC VT100
  9. and higher model VT series terminals on a PC with an enhanced keyboard (the
  10. one with separate numeric pad and cursor keys).
  11.  
  12. What GOLD does is make the NUM LOCK key transmit the code for some other
  13. key (normally the F1 key; this is usually mapped by Kermit to the VTnnn
  14. GOLD key).  This makes it possible (by using the SET KEY command of
  15. Kermit) to make the keypad look almost exactly the same as a VTnnn
  16. keypad (the long + key is the only exception; that is two keys on the
  17. real terminal). 
  18.  
  19. Using GOLD
  20. ----------
  21. To use GOLD, simply place the GOLD.COM file into a directory on the
  22. normal program path, then type the command:
  23.  
  24.   GOLD
  25.  
  26. This activates the program, and NUM LOCK will cease to work as Num Lock and
  27. will instead operate the same as the F1 key (or whatever else has been
  28. configured).  This may not always be convenient, so it is possible to turn off
  29. the effect by typing:
  30.  
  31.   GOLD OFF
  32.  
  33. and later to turn it on again by typing:
  34.  
  35.   GOLD ON
  36.  
  37. The current GOLD state may be displayed by typing:
  38.  
  39.   GOLD
  40.  
  41. (after the first call, this is the only effect if the command is used without
  42. parameters).  The program can be set to an initial OFF state by calling it the
  43. first time with the OFF parameter if required.  Later calls operate with the
  44. initially installed copy of the program, which cannot be unloaded (it is,
  45. however, very small; only 528 or 592 bytes of memory are required, depending
  46. on the operating mode (see below)).
  47.  
  48. It is possible to get the original Num Lock function without turning GOLD
  49. OFF.  This is useful if you are inside an application and realise Num Lock has
  50. been left ON accidentally, and GOLD is also ON.  The key combination Shift and
  51. Num Lock will toggle the Num Lock state each time it is used (just as Num Lock
  52. does on its own when GOLD is OFF).
  53.  
  54. It is also possible to turn GOLD on and off without calling it as a command.
  55. The key combination Alt and Num Lock will turn GOLD off if it is on, and on if
  56. it is off.  Note that Alt and Num Lock normally operates exactly as a normal
  57. Num Lock, so no functionality is lost when GOLD is loaded.
  58.  
  59. If you are using DOS 5, GOLD may be loaded using the LOADHIGH command; this
  60. saves space if upper memory space is available.
  61.  
  62. Compatibility
  63. -------------
  64. Some machines may not contain BIOS support for this program; in such cases,
  65. GOLD automatically uses an alternate operating mode (direct interception of
  66. keyboard interrupts) which will work on true compatible machines.  However,
  67. this method uses slightly more memory (544 bytes against 480 bytes) and
  68. requires a high degree of machine compatibility.
  69.  
  70. Problems have been reported where GOLD appears to have no effect, even if each
  71. of the particular modes is forced.  In many cases this appears to be due to a
  72. version of the KEYB (or KEYBxx) command used for reconfiguring non-US
  73. keyboards; it steals the keyboard interrupt vector and fails to honour the
  74. keyboard intercept request from GOLD.  The solution is generally to use an
  75. earlier version of the KEYB program (or one of the country specific versions
  76. such as KEYBUK) or to use a KEYB program from a PC-DOS system; these appear
  77. not to have the problem.
  78.  
  79.  
  80. Configuration
  81. -------------
  82. The program uses the INT 2FH multiplex interrupt to install itself; it uses a
  83. multiplex ID of 0DCH.  This may be changed if it clashes with other TSR
  84. programs.  The key to which NUM LOCK is mapped may also be changed, and it may
  85. also be transmitted as if SHIFT, CTRL or ALT is held down at the same time.
  86. It is also possible to force GOLD to use a particular operating mode (BIOS
  87. keyboard intercept, or direct keyboard interrupt intercept).
  88.  
  89. Alteration of the above items is obvious on examination of the program source
  90. code.  If you do not have MASM, it is easy to patch the program since the
  91. relevant values are stored in easy to find places - offsets 102H, 103H, 104H
  92. and 105H.
  93.  
  94. GOLD has been tested on PC-DOS 3.0, 3.1, 3.3, 5.0, MS-DOS 3.2, 3.3 and 5.0,
  95. and in the DOS mode sessions of IBM OS/2 versions 1.2, 1.3 and 2.0.  Tests
  96. were performed on an IBM PC/XT compatible (PC-DOS and MS-DOS all versions), an
  97. IBM PC/XT (PC-DOS version 3.3) and an IBM PS/2 Model 80-111 (PC-DOS versions
  98. 3.3 and 5.0, and OS/2).
  99.  
  100. Files included
  101. --------------
  102. This package should consist of the following files.  Please distribute
  103. all of these files if you pass the package on. 
  104.  
  105. GOLD.COM   - Executable program for GOLD
  106. GOLD.DOC   - Documentation (this file)
  107. GOLD.ASM   - MASM source code
  108. GOLD.BAT   - Batch file to build GOLD
  109. GOLD.INI   - Kermit TAKE file to define keyboard for DEC terminal
  110.  
  111. NOTE: In the Kermit Distribution area, all these filenames are prefixed by
  112. the letters MSU, e.g. MSUGOLD.COM, to keep them together with other MS-DOS
  113. Kermit files.
  114.  
  115. Acknowledgement
  116. ---------------
  117. Thanks to all those, all over the world, who have contacted me with
  118. suggestions for improvements to GOLD.  There are too many to mention
  119. individually, and many people made the same or similar suggestions.
  120.  
  121. Contact
  122. -------
  123. Please send any comments or suggestions to me, Bob Eager:
  124.  
  125. rde@ukc.ac.uk (USENET) (preferred over ibmpcug)
  126. rde@ibmpcug.co.uk (USENET)
  127. 100016,2770   (CompuServe)
  128. +44 227 764000 ext 7589 (Telephone)
  129.  
  130. Update history
  131. --------------
  132.  
  133. 2.4 - fixed problem where PAUSE was being recognised as if NUM LOCK
  134.       had been pressed. This was because PAUSE generates a six byte
  135.       data sequence containing, as its third byte, the scan code used
  136.       by NUM LOCK
  137.  
  138. 2.3 - added facility to include CTRL, ALT or SHIFT with replacement key code
  139.  
  140. 2.2 - added some additional safety code to the installation check
  141.  
  142. 2.1 - changed default multiplex ID value to 09FH to fix problems with
  143.       some versions of KEYB
  144.  
  145. 2.0 - added SHIFT and NUM LOCK facility to provide original NUM LOCK capability
  146.     - added ALT and NUM LOCK facility to change GOLD status directly
  147.     - fixed interrupt intercept incompatibility with some clone BIOSes
  148.     - fixed non-detection of BIOS intercept support in some cases
  149.     - added code to use direct keyboard interrupt handler if BIOS
  150.       interrupt intercept facility not available
  151.  
  152. 1.0 - initial program version
  153.  
  154. (End of GOLD.DOC / MSUGOLD.DOC)
  155.