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