home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_1.iso / files / 524.lha / MouseAccel_v1.01 / MouseAccelerator.doc.pp / MouseAccelerator.doc
Encoding:
Text File  |  1991-07-01  |  9.1 KB  |  227 lines
  1.  
  2.                            MouseAccelerator
  3.  
  4.                              (Commodity)
  5.  
  6.                                   by
  7.  
  8.                             Stefan Sticht
  9.  
  10.          This program (binary), sourcecode, documentation is
  11.  
  12.                             PUBLIC DOMAIN.
  13.  
  14.                      You may do anything with it!
  15.  
  16.  
  17. Purpose of this commodity:
  18. --------------------------
  19. MouseAccelerator  is  a  commodity,  which  speeds  up mousemovements.
  20. AmigaOS  2.0  has  already  a mouseaccelerator built in.  If you think
  21. it's  to  slow,  you  can  use  this  commodity.   You may specify the
  22. acceleration  factor  and  a  threshold factor (pixels/event).  If you
  23. move  the  mouse  faster  than  the  threshold  factor  in  pixels per
  24. inputevent,  the  mousepointer  is accelerated.  If you move the mouse
  25. slowly, no acceleration is done to make some jobs easier.
  26.  
  27. Requirements:
  28. -------------
  29. This  commodity  requires  at least Kickstart 37.* and Workbench 37.*.
  30. Please  check  this  out  using Version in the Shell or About from the
  31. Workbench's   Workbench   menu.    You   also   need   to   have   the
  32. commodities.library  in your libs:  directory.  Please check this out:
  33. type "dir libs:" in the shell.
  34.  
  35. How to start a commodity:
  36. -------------------------
  37. First  there  are  two  basically different ways to start a commodity:
  38. via Workbench or via Shell.
  39.  
  40.     Starting  it  via Workbench is extrem simple:  just doubleclick on
  41. its  icon  and  the  commodity gets started.  Perhaps you might change
  42. some  parameters of the commodity.  You do this with tool types.  Tool
  43. types can be changed by clicking at the commodities icon and selecting
  44. Information from the Workbench's Icon menu.  In the window which opens
  45. you  see a listview gadget in which all tool types are listed.  Please
  46. refer  to  your  Workbench  documentation  on  how to change this tool
  47. types.  Which parameters you can change for this specific commodity is
  48. described below.
  49.     Please  note  that  another  double  click on the commodity's icon
  50. forces  the  commodity  to  open  its window, if it's already running.
  51. Running  two  copies of MouseAccelerator at the same time isn't useful
  52. and  therefore  possible.   Any  changes in tool types aren't told the
  53. running copy of the MouseAccelerator; you have to kill the running one
  54. and start it again.
  55.     To  start  a commodity via shell you type in its name.  If you get
  56. an  "Unknown  command  ???"  error  message,  you  have misspelled the
  57. commodity's  name  or the commodity isn't in your current directory or
  58. in the current search path.  The easiest way is to change your current
  59. directory  to the location of the commodity using the CD command.  You
  60. can  change  parameters  of  a commodity by command line options.  The
  61. available options are listed with ?  as the first parameter:
  62.  
  63.                           MouseAccelerator ?
  64.  
  65. gives you a list of the command line options.  The explanation of each
  66. option is below.  Starting the commodity once more while it is already
  67. running  forces  the  commodity  to  open its window.  No command line
  68. option is parsed or updated if you start the commodity a second time.
  69.  
  70.     If  you  want  the  commodity to be started at every boot-up, it's
  71. best to add this line to your User-Startup file:
  72.  
  73.                      <path>MouseAccelerator <options>
  74.  
  75. Don't  forget  to  replace  <path>  by  the  path to the commodities's
  76. location  and <options> by the options you want to change. For example
  77. add this line if your commodity is located in the Tools drawer of your
  78. boot disk and if you want the pointer to be accelerated by 3:
  79.  
  80.                 Tools/MouseAccelerator ACCELERATION=3
  81.  
  82.     Another way to start the commodity at every boot-up is to drag its
  83. icon  in  the  WBStartup drawer of your boot disk.  Then the commodity
  84. gets  started  as if you had double clicked on its icon.  But you have
  85. to add the tool type DONOTWAIT to the icon.
  86.  
  87. Using Exchange:
  88. ---------------
  89. Exchange is the commodities controller program. With Exchange you can
  90. control all commodities: you can kill, disable, enable, show and hide
  91. commodities.
  92.     Start  the  Exchange  program,  which  usually is in the Utilities
  93. drawer  of your boot disk, by double clicking its icon.  Now you see a
  94. list  of  the available commodities.  Select the commodity you want to
  95. control.   The  commodities title, description and status is shown now
  96. below the listview gadget.
  97.     You  can  kill  the  commodity  using  the  Kill gadget...  If the
  98. commodity  has  a  window  to  open,  in which you usually change some
  99. parameters,  you  can  open  this window using Show.  Hide closes this
  100. window.
  101.  
  102.                         Changeable parameters:
  103.                         ----------------------
  104.  
  105. CX_Priority:
  106. ------------
  107. You  can  specify the priority of the Commodity within the commodities
  108. queue using the tool type or commandline option CX_PRIORITY=<n>, where
  109. <n> is the decimal value for the priority.  Default priority is 0.
  110.  
  111. ACCELERATION:
  112. -------------
  113. With  the  tool  type  or  command  line option ACCELERATION=n you can
  114. specify the acceleration factor. The default acceleration factor is 5.
  115.     After   having   started   the   commodity,  you  can  change  the
  116. acceleration  factor  in  a  small  pop  up window, too.  To open this
  117. window  you  need  the  Exchange  program or a hotkey installed.  Open
  118. Exchange's window, select the MouseAccelerator, then select Show.  Now
  119. the  window  of the MouseAccelerator has opened.  There you can change
  120. the  acceleration  and  threshold  factor.   Using the Hide gadget the
  121. window  closes  and  the  commodity  keeps  running.   The Quit gadget
  122. removes the commodity.
  123.  
  124. THRESHOLD:
  125. ----------
  126. With  the tool type or command line option THRESHOLD=n you can specify
  127. the  pixels  per  event you have to move the mouse before acceleration
  128. begins. Default is 4 pixels/event.
  129.  
  130. CX_POPKEY:
  131. ----------
  132. You  can  specify  a  hotkey,  with which you can open the commodity's
  133. window, using the tool type or command line option CX_POPKEY=<hotkey>.
  134. <hotkey>  is  any input description string as explained below.  If you
  135. omit  this  option,  no  hotkey  will be installed and memory usage is
  136. reduced.  Default is no hotkey installed.
  137.  
  138. Examples:
  139.  
  140.     CX_POPKEY=f1                (F1 opens the window)
  141.     "CX_POPKEY=lshift f1"       (left shift and F1)
  142.     "CX_POPKEY=alt m"           (either alt and M)
  143.  
  144. CX_POPUP:
  145. ---------
  146. With  the  tool  type  or  command line option CX_POPUP=YES|NO you can
  147. specify  wether  the commodity's window shall open at startup.  YES|NO
  148. means that you have to use either YES or NO, nothing else.  Default is
  149. NO.
  150.  
  151.                       Input description strings
  152.                       -------------------------
  153.  
  154. With  input  description  strings  you  can  specify  almost any input
  155. action,  for  example  the action lshift f1, which means that pressing
  156. the  left  shift  and  the  f1  key  together  is the action.  In this
  157. commodity  you  can specify the action to open the commodity's window,
  158. as described above.
  159.  
  160. Input description strings have the following template:
  161.  
  162.       [class] (([-]qual)|syn)* [[-]upstroke] [highmap|ANSIcode]
  163.  
  164. (* means zero or more occurances of the of the expression in brackets)
  165.  
  166. class   is one of the following strings:
  167.         rawkey, rawmouse, event, pointerpos, timer, newprefs,
  168.         diskremoved, diskinserted.
  169.         If not specified, the class is taken to be "rawkey".
  170.  
  171. qual    is one of the strings:
  172.         lshift, rshift, capslock, control, lalt, ralt, lcommand,
  173.         rcommand, numericpad, repeat, midbutton, rbutton, leftbutton,
  174.         relativemouse
  175.         A preceding '-' means that the value of the corresponding
  176.         qualifier is to be considered irrelevant.
  177.  
  178. syn     (synonym) is one of the strings: shift, caps, alt
  179.         shift means "left or right shift"
  180.         caps means "shift or capslock"
  181.         alt means "either alt key"
  182.  
  183. upstroke (literally "upstroke")
  184.         if this token is absent, only downstrokes are considered
  185.         for rawmouse (mousebuttons) and rawkey events.  If it is
  186.         present alone, only upstrokes count.  If it preceded by
  187.         '-' it means that both up and down strokes are included.
  188.  
  189. highmap one of the strings:
  190.         comma, space, backspace, tab, enter, return, esc, del, up, down,
  191.         right, left, help, f1, f2, f3, f4, f5, f6, f7, f8, f9, f10,
  192.         0, 1, 2, 3, 4, 5, 6, 7, 8, 9, (, ), /, *, -, +
  193.  
  194. ansicode a single character token is interpreted as a character code,
  195.         which is looked up in the system default keymap.
  196.  
  197. Some full examples:
  198. -------------------
  199.  
  200.     MouseAccelerator ACCELERATION=10
  201.     MouseAccelerator ACCELERATION=5 "cx_popkey=ctrl 1" cx_popup=yes
  202.     MouseAccelerator ACCELERATION=5 THRESHOLD=4 "cx_popkey=help"
  203.  
  204.  
  205. Special thanks
  206. --------------
  207. to Matt Dillon for the acceleration code.
  208.  
  209.  
  210. Send bug-reports, enhancement-requests, questions, gifts(!) to:
  211. ---------------------------------------------------------------
  212. Stefan Sticht
  213. Bibereckerweg 40a
  214. D-8390 Passau 18
  215. FRG
  216.  
  217. or (better) EMail to:
  218. Internet: cbmvax.commodore.com!cbmehq!cbmger!edith!sticht@rutgers.EDU
  219.       or: IWSTICHT@ibm.rz.uni-passau.de
  220. Fido-Net: Stefan Sticht (2:242/16:4)
  221.  
  222.  
  223.  
  224. Please include the version number of the commodity in every bug report
  225. You  get  the  version  number  using  the  Version  command:
  226.                      Version [<path>]<commodity>
  227.