home *** CD-ROM | disk | FTP | other *** search
/ ARM Club 3 / TheARMClub_PDCD3.iso / programs / misc / keyfix / ReadMe
Text File  |  1998-12-17  |  12KB  |  257 lines
  1.                                 KeyFix v1.05
  2.                                 ------------
  3.  
  4. Introduction
  5. ------------
  6. Users of older Acorn computers (BBC B, Master, etc.) will be familiar with a
  7. keyboard Shift Lock key as well as Caps Lock; this key is not available on
  8. the Archimedes and later ranges of Acorn computers. A Shift Lock key
  9. provides access to upper case characters, as Caps Lock, and those normally
  10. obtained by holding down Shift. Its operation is identical to Caps Lock -
  11. i.e., once toggled on, remains active until toggled off. KeyFix provides
  12. this missing Shift Lock and, in addition, a Ctrl Lock and Alt Lock.
  13.  
  14. Although it only performs a seemingly minor function, KeyFix can be big help
  15. to some users with special needs. Many people can only use the keyboard with
  16. one hand or, indeed, with a mouth-stick or other such adaptation. Holding
  17. down one key whilst pressing another can prove awkward, if not impossible.
  18. Likewise, using the mouse and keyboard together - e.g., Shift drag.
  19.  
  20. KeyFix can 'hold down' the shifting keys (Shift/Ctrl/Alt) for keyboard and
  21. mouse operations. The various options are described in detail below.
  22.  
  23. Whilst KeyFix cannot claim to enable anyone to use the computer's keyboard,
  24. it can go a long way to making it easier for some.
  25.  
  26. From version 1.03, KeyFix has a keyboard mouse emulator controlled using the
  27. keypad keys. Everything you can do with the real mouse can be done with the
  28. emulated mouse.
  29.  
  30. Getting started
  31. ---------------
  32. KeyFix is run in the usual way, by double-clicking on the !KeyFix icon in
  33. the directory viewer. It will install an icon on the right of the iconbar.
  34. Once installed, KeyFix is ready to use, according to the settings in its
  35. configuration file.
  36.  
  37. The iconbar menu
  38. ----------------
  39. Pressing the middle or Menu button over the iconbar icon will display the
  40. iconbar menu. The items on this behave as follows:
  41.  
  42. 'Info' leads to an 'About this program' info box. This will show which
  43. version of KeyFix you have.
  44.  
  45. 'Config...' opens the KeyFix configuration dialogue box. It can also be
  46. opened by clicking on the iconbar icon with Adjust.
  47.  
  48. 'Quit' removes the KeyFix program from memory.
  49.  
  50. Configuring KeyFix
  51. ------------------
  52. The first two options in the configuration dialogue, 'Use shifts for mouse
  53. actions' and 'Use shifts for keyboard actions' determine whether or not the
  54. shifting keys will be 'held down' for mouse or keyboard operations. They can
  55. be selected individually, together or not at all. If, for example, you just
  56. want KeyFix to act on keystrokes, then select 'Use shifts for keyboard
  57. actions' but leave 'Use shifts for mouse actions' unselected.
  58.  
  59. For keyboard use, the type of shift applied can be 'Locking' or 'Resetting'.
  60. If 'Locking' is selected the shift is toggled on and off in the same manner
  61. as Caps Lock. If 'Resetting' is selected the shift is also released after
  62. the next keypress, excluding Shift, Ctrl and Alt. A 'Resetting' shift is,
  63. for example, particularly useful when entering a large amount of text as it
  64. saves toggling Shift off after an initial capital letter, thereby saving
  65. many keypresses.
  66.  
  67. The next group of icons determine the use of 'Hot keys'. These are the keys
  68. KeyFix assigns to perform the shift functions. There is another way to use
  69. KeyFix, see below.
  70.  
  71. The first nine icons select which of the Shift/Ctrl/Alt keys will be
  72. assigned as the hot keys. The choices are 'Either', 'Left' or 'Right' for
  73. each shift.
  74.  
  75. 'Either' assigns both Shift/Ctrl/Alt keys.
  76. 'Left' assigns the left Shift/Ctrl/Alt key.
  77. 'Right' assigns the right Shift/Ctrl/Alt key.
  78.  
  79. Note that you can, if you wish, choose not to use a particular lock. For
  80. example, if you wanted Shift Lock and Ctrl Lock but not Alt Lock, deselect
  81. the Alt hot key by clicking on it with Adjust.
  82.  
  83. 'Audio feedback' if on sounds a beep each time a hot key is pressed. The
  84. tone of the beep varies depending on whether the shift is being turned on or
  85. off.
  86.  
  87. The 'Mouse emulator' group of icons can be configured as follows:
  88.  
  89. 'Pointer speed' controls the speed the pointer moves across the screen in OS
  90. units per second when the emulator is in continuous mode. This is the
  91. default mode.
  92.  
  93. 'Pointer nudge' controls how far the pointer moves in OS units when the
  94. emulator is in step mode.
  95.  
  96. 'On/off key' defines a key to use for turning the emulator on or off. There
  97. is a syntax for defining key presses. The keys are all given names F1 to F12
  98. for the function keys or the letter on the key for the other keys. This name
  99. can be prefixed with C_ for the key plus Ctrl, S_ for the key and Shift or
  100. CS_ for the key and Ctrl plus Shift. Some other names are Tab, Escape,
  101. Insert, Delete, Copy, CUp, CDown, CLeft, CRight, Space and Return. It is up
  102. to the user to find key presses that are compatible with their other
  103. applications.
  104.  
  105. KeyFix also has the ability to define the on/off key by its low-level key
  106. number in the form Xnn where nn is a hex number - e.g., X0E would be the
  107. Scroll Lock key. However, you cannot use the Xnn form in conjunction with
  108. C_, S_, or CS_. This may not seem very useful, but if you have a Risc PC and
  109. have replaced the original keyboard with one that has the 3 extra 'Windows'
  110. keys, you can dedicate one of these to the hot key.
  111.  
  112. In order for RISC OS to be aware of the extra keys we need to patch the
  113. PS2Driver module. One such patch, WinKbdPat, already exists and is included
  114. in the KeyFix distribution by kind permission of its author, Robin Watts.
  115. See WinKbdPat's !Help file for details of its use.
  116.  
  117. The 'Windows' keys map as: Windows key left - X68, Windows key right - X69
  118. and Application key - X6A.
  119.  
  120. Note that you can choose not to use an on/off key by leaving a blank entry.
  121.  
  122. 'Button click type' controls whether the emulator produces 'Short' or 'Long'
  123. clicks. Long clicks are akin to the usual use of the mouse; clicks are held
  124. as long as the emulated button is pressed. For most users this is likely to
  125. be the preferred mode. Short clicks are brief and cannot be held. This mode
  126. is useful if you are imprecise with your button clicks. A side effect of
  127. setting the button click type to short is that you will no longer be able to
  128. perform drags using the real mouse buttons while the emulator is active.
  129.  
  130. The final row of four buttons act on your choices when clicked on with
  131. Select or Adjust.
  132.  
  133. 'Default' will restore KeyFix to the settings in its configuration file.
  134.  
  135. 'Save' will apply the current settings and save them in the file
  136. !KeyFix.Resources.Config for use as the program's defaults.
  137.  
  138. 'Cancel' will ignore any changes made and close the dialogue box. While the
  139. configuration dialogue box has input focus, pressing Escape has the same
  140. effect.
  141.  
  142. 'Set' will apply the current settings. While the configuration dialogue box
  143. has input focus, pressing Return in the last writable icon has the same
  144. effect.
  145.  
  146. Using KeyFix
  147. ------------
  148. If you have not used Keyfix before, you should first configure it for your
  149. preferred default settings. Choose 'Config...' from the KeyFix menu or click
  150. Adjust on the iconbar icon and set the appropriate options. Finally, click
  151. on 'Save'.
  152.  
  153. There are two ways to use KeyFix, from the KeyFix window or with hot keys.
  154. Clicking on the iconbar icon with Select will open the KeyFix window. This
  155. will provide a simulation of the lock keys which can be toggled on or off by
  156. clicking on them with the mouse. The simulated keys, like real ones, will
  157. jog down and an indicator will 'illuminate' when on. The iconbar icon will
  158. also reflect the status of the various locks by turning an indicator on or
  159. off above each of the letters, S, C or A - representing Shift, Ctrl and Alt.
  160. Likewise, when using hot keys, the status of the locks is shown on the icon
  161. bar icon and in the KeyFix window, if open.
  162.  
  163. The locks can be used individually or together. So, for example, to press
  164. Shift+Ctrl+F1 to cause Edit to expand tabs:
  165.  
  166. 1. Ensure 'Use shifts for keyboard actions' and 'Hot keys' are selected (it
  167.    doesn't matter if the key shift type is 'Locking' or 'Resetting'),
  168. 2. give Edit the caret and press the Shift Lock and Ctrl Lock hot keys
  169.    (it doesn't matter in which order),
  170. 4. Press F1,
  171. 5. if necessary, release the locks by pressing the hot keys again.
  172.  
  173. The KeyFix window could have been used instead of hot keys, but is probably
  174. more convenient when using the mouse. For example, to open an application
  175. directory, first click on the Shift button, then double-click on an
  176. application icon in a directory viewer. The application directory will have
  177. been opened without using the keyboard.
  178.  
  179. The position of the KeyFix window opens at on screen is also saved in the
  180. configuration file.
  181.  
  182. The mouse emulator
  183. ------------------
  184. As the emulated mouse works transparently alongside the real mouse, it can
  185. be used as well as or instead of it. In the following descriptions,
  186. therefore, where I refer to button clicks, they could equally be performed
  187. using the emulated or real mouse.
  188.  
  189. The keypad plays the role of mouse emulator as follows:
  190.  
  191. Num Lock, / and * act as Select, Menu and Adjust.
  192.  
  193. 0 makes the next click a double-click. To, for example, run an application,
  194. press keypad 0, position the pointer over the application's icon in the
  195. directory viewer and click on it with Select. This key also has audio
  196. feedback (dependant on the 'Audio feedback' setting in the 'Hot keys'
  197. section).
  198.  
  199. Enter starts a drag for the next button click. To, for example, drag an
  200. application to the Pinboard, press keypad Enter, position the pointer over
  201. the application's icon in the directory viewer and click on it with Select,
  202. the drag will begin and the application's icon will be 'picked up'. Position
  203. the application where you want it and either click again with Select or
  204. press keypad Enter. This key also has audio feedback (dependant on the
  205. 'Audio feedback' setting in the 'Hot keys' section).
  206.  
  207. 1, 2, 3, 4, 6, 7, 8 and 9 control pointer direction SW, S, SE, W, E, NW, N
  208. and NE. The pointer will move according the which mode it is in.
  209.  
  210. 5 places the pointer at screen centre.
  211.  
  212. . toggles between continuous and stepped mode - i.e., the pointer moves as
  213. long as a direction key is held down, or in discrete steps. Continuous
  214. pointer movement is the default. Stepped mode is useful for accurate
  215. positioning of the pointer. Note that auto-repeat is active in this mode.
  216. This key also has audio feedback (dependant on the 'Audio feedback' setting
  217. in the 'Hot keys' section).
  218.  
  219. + and - adjust pointer speed/step. In continuous mode each press of + or -
  220. will increase or decrease the pointer speed by 50 OS units per second. In
  221. stepped mode each press of + or - will increase or decrease the pointer step
  222. by 2 OS units.
  223.  
  224. When the mouse emulator is active the KeyFix window expands to show some
  225. additional icons. From left to right these represent: double-click pending,
  226. pointer movement mode and drag pending. Not only do these icons reflect the
  227. state of the emulator, they can also be clicked on and used like their
  228. keypad equivalents.
  229.  
  230. Distribution
  231. ------------
  232. KeyFix may be freely distributed. We encourage you to pass it on to anyone
  233. who may find it useful. We discourage you from making any charge for this
  234. service.
  235.  
  236. Comments, suggestions, bugs
  237. ---------------------------
  238. To:
  239.  
  240. #330, Fargo (John Ferguson)
  241. #134, David Pilling
  242.  
  243. at Arcade BBS Fido Node 2:254/27.0,
  244.  
  245. or Internet
  246.  
  247.  john@fergusn.demon.co.uk
  248. david@pilling.demon.co.uk
  249.  
  250. Author! Author!
  251. ---------------
  252. KeyFix was designed and documented by John Ferguson, and coded
  253. by David Pilling.
  254.  
  255. WinKbdPat is copyright Robin Watts (Robin.Watts@wss.co.uk) and is available
  256. from ftp://ftp.comlab.ox.ac.uk/tmp/Robin.Watts/
  257.