home *** CD-ROM | disk | FTP | other *** search
/ 17 Bit Software 3: The Continuation / 17-Bit_The_Continuation_Disc.iso / files / amg18.dms / amg18.adf / QMouse_v1.3 / qmouse.doc < prev    next >
Text File  |  1993-12-02  |  20KB  |  548 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.                        QMouse 1.3 Copyright 1988 by Lyman Epp
  8.  
  9.           Another "Mouse  Accelerator???"  What for?  It seems that all the
  10.           other mouse accelerators have been written in "C".  This is okay,
  11.           but the  programs are  10-30K.  This mouse accelerator is written
  12.           in assembler and contains most of the features of the others, but
  13.           the program size is less than 4K bytes!  QMouse stands for "Quick
  14.           Mouse."
  15.  
  16.           This is being distributed as ShareWare.  If you think that QMouse
  17.           is  useful,  please  send  $10.    Your  response will insure the
  18.           release of more quality programs for  your  Amiga!    Be  sure to
  19.           check out the latest shareware version of QView.
  20.  
  21.           The latest  version of  QMouse can  always be  found first on the
  22.           Wind Dragon Inn BBS, (402)-291-8053.
  23.  
  24.  
  25.                                     Lyman R. Epp
  26.                                 10072 Wirt Plaza #15
  27.                                 Omaha, Nebraska 68134
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.                                   REGISTERED USERS
  37.  
  38.  
  39.           Thanks to these users of QMouse for your ShareWare donation.
  40.  
  41.                D. J. James                   Ted Michelse
  42.  
  43.                Scott Brickner                Paul O'Keefe
  44.  
  45.                Elliott Hammett               Ken Rahmoeller
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.                                           1
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.                                    QMOUSE FEATURES
  71.  
  72.  
  73.           o    Screen blanks if keyboard or  mouse  is  idle  for  a while.
  74.                This will prevent an image "burning" onto your monitor while
  75.                left unattended.
  76.  
  77.           o    The mouse pointer blanks if mouse is idle for a  while.  The
  78.                mouse pointer  will also  blank when  the first keystroke is
  79.                typed.
  80.  
  81.           o    Mouse accelerator with configurable  threshold to  allow for
  82.                precise mouse pointer positioning.
  83.  
  84.           o    Automatic  window  activation  (i.e.  Sun Mouse).  Makes the
  85.                window under the mouse pointer the active window.  Sun Mouse
  86.                will  not   activate  windows  if  either  mouse  button  is
  87.                depressed--this  will  allow  you  to  move  WorkBench icons
  88.                between windows.
  89.  
  90.           o    Multiple configurable  hot keys,  ala PopCli, activated with
  91.                the <Left Amiga><hotkey> combination.  The <Left Amiga><Esc>
  92.                combination is  preset to execute "NewCLI".  The RUN command
  93.                must be in your C: directory.
  94.  
  95.           o    Keyboard  record/playback.    <Left  Alt><Esc>  toggles  the
  96.                keystroke recorder  on and off.  Press <Left Alt><Return> to
  97.                playback the previously recorded keystrokes.
  98.  
  99.           o    Window to front.  Left Mouse Button click(s)  in window will
  100.                bring it to the front.  Won't try to bring the window to the
  101.                front if it is already in the front.   The  number of clicks
  102.                required  is  configurable.    The  time  between  clicks is
  103.                determined by Preferences.
  104.  
  105.           o    Window to back.  Hold down the Left Mouse Button in a window
  106.                and click  the Right Mouse Button to send that window to the
  107.                back.
  108.  
  109.           o    The smallest clock yet!  Can be turned off if you don't like
  110.                clocks.   The amount  of available  memory can optionally be
  111.                displayed.  Starting column is also configurable.  The clock
  112.                window  will  be  brought  to  the  front  (of the WorkBench
  113.                screen) whenever it becomes obscured.
  114.  
  115.           o    Every option can be turned off or modified.  Options  can be
  116.                entered  from  the  command  line (e.g. Startup-Sequence) or
  117.                from a user specifiable configuration file.
  118.  
  119.  
  120.  
  121.                                           2
  122.  
  123.  
  124.  
  125.  
  126.  
  127.           o    Uses a background CLI.   Programs  like  DMouse  and PopCLI3
  128.                don't  use  a  background  CLI,  and  therefore any NewCLI's
  129.                spawned by them will have no  default directory,  no default
  130.                path, etc.   Using a background CLI simply requires that you
  131.                use RunBack (included) instead of Run (to allow  closing the
  132.                initial  CLI.)    This  should be viewed as very beneficial!
  133.                You can now set the stack size for any spawned  CLI's.  This
  134.                will allow  you to  set a  lower stack  size before starting
  135.                QMouse, but insure an adequate stack size for spawned CLI's.
  136.  
  137.  
  138.  
  139.  
  140.  
  141.  
  142.  
  143.  
  144.  
  145.  
  146.  
  147.  
  148.  
  149.  
  150.  
  151.  
  152.  
  153.  
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.                                           3
  183.  
  184.  
  185.  
  186.                                COMMAND LINE ARGUMENTS
  187.  
  188.  
  189.           Arguments can be typed in upper or lower case.   Arguments can be
  190.           enclosed  in  quotes,  e.g.  "-A3".    Quotes are required if the
  191.           argument contains spaces, otherwise they are  optional.  Commands
  192.           can also be in a configuration file and used with the -F option.
  193.  
  194.  
  195.           -A#            Set acceleration  to #.   Can be in the range of 0
  196.                          to 65,535.  Mouse movement events that have X or Y
  197.                          motion  greater  than  the  acceleration threshold
  198.                          (see  option  -T)  will  be  accelerated  by  this
  199.                          factor.   The default acceleration value is 3.  To
  200.                          disable this feature, specify 0 or 1.
  201.  
  202.  
  203.           -B             Enable click to back feature.
  204.  
  205.  
  206.           -C[E][M][#]    Activate clock.    To  display  clock  in  24 hour
  207.                          format (European),  specify an  "E" after the "C".
  208.                          To display available memory, specify an  "M" after
  209.                          the "C" (e.g. -CM).  If both "E" and "M" are used,
  210.                          the "E" must come  before the  "M".   You can also
  211.                          specify an optional column where the clock will be
  212.                          displayed.  The width  of the  clock is  44 pixels
  213.                          (92 if available memory is displayed.)  The column
  214.                          number must be in the range of 0  to [screen width
  215.                          - clock  width].   To place  the clock next to the
  216.                          front/back gadgets, use a value of [screen width -
  217.                          clock width - 53].  With a screen width of 640 and
  218.                          with available memory displayed,  this would  be a
  219.                          column value  of 495 (-CM495).  The default column
  220.                          value is 280.
  221.  
  222.  
  223.           -Ecommand      Set command to execute  when <Left  Amiga><Esc> is
  224.                          pressed.  If the command contains spaces, then the
  225.                          entire command  must be  enclosed in  quotes.  The
  226.                          default  command  is  "NewCLI".  The "Run" command
  227.                          must be in your C: directory.   The  "Run" command
  228.                          must  precede  any  commands  other  than "NewCLI"
  229.                          (e.g. "-eRun ed".)
  230.  
  231.  
  232.           -Fname         Read configuration information from  the specified
  233.                          file.   The -F  option can be nested any number of
  234.                          levels (or until the stack overflows.)  The format
  235.                          for  the  configuration  file  is identical to the
  236.                          command line format.   Each option  can be entered
  237.                          on  a  separate  line.    Anything between a semi-
  238.                          colon character ";" and the end  of the  line will
  239.                          be considered  a comment.   A sample configuration
  240.                          file is included.
  241.  
  242.  
  243.                                           4
  244.  
  245.  
  246.  
  247.  
  248.           -Hxx=command   Set the command to  execute when  this hot  key is
  249.                          invoked.   The 'xx'  parameter defines the raw key
  250.                          code for this  hot  key.    Whenever  this  key is
  251.                          pressed in combination with the <Left Amiga><key>,
  252.                          the command will be executed.  The raw  key values
  253.                          are printed later in this documentation.  For more
  254.                          information, see option -E.
  255.  
  256.  
  257.           -K#            Set number of clicks required to bring a window to
  258.                          the front.   The  default value  is 2  clicks.  To
  259.                          disable this feature, specify 0 clicks.  Can be in
  260.                          the range of 0 to 65,535 clicks.
  261.  
  262.  
  263.           -M             Deactivate the  screen shuffler.  The <Left Amiga>
  264.                          <M> combination  will revert  to Intuition pushing
  265.                          the WorkBench screen to the back.
  266.  
  267.  
  268.           -P#            Set the  number of  seconds to  wait after a mouse
  269.                          event before blanking  the  mouse  pointer.   Just
  270.                          move  the   mouse  again   and  the  pointer  will
  271.                          reappear.  The default  value is  10 seconds.   To
  272.                          disable this  feature, specify  0 seconds.  Can be
  273.                          in the range of 0 to 65,535 seconds.
  274.  
  275.  
  276.           -R             Enable automatic window activation.
  277.  
  278.  
  279.           -S#            Set the number of seconds to  wait after  any user
  280.                          event  (keyboard,  mouse  or  disk changed) before
  281.                          blanking the screen.  Just move the mouse,  type a
  282.                          key  or  insert  a  disk  and  the  screen will be
  283.                          restored.  The default value is  600 seconds.   To
  284.                          disable this  feature, specify  0 seconds.  Can be
  285.                          in the range of 0 to 65,535 seconds.
  286.  
  287.  
  288.           -T#            Set mouse  acceleration  threshold  in  pixels per
  289.                          event (see option -A).  This option provides a way
  290.                          to position  the mouse  pointer precisely, without
  291.                          the acceleration factor "getting in the way."  The
  292.                          default value is 3.  Can be in  the range  of 0 to
  293.                          65,535 pixels per event.
  294.  
  295.  
  296.           -V#            Set the  stack size  for any  spawned CLI's.  This
  297.                          allows the stack size for the  QMouse's CLI  to be
  298.                          set to  a minimum.   The default value is obtained
  299.                          from the CLI that QMouse was run from.  Can  be in
  300.                          the range of 1800 to 655,360 bytes.
  301.  
  302.  
  303.  
  304.                                           5
  305.  
  306.  
  307.  
  308.  
  309.  
  310.                                      HOW TO USE
  311.  
  312.  
  313.           QMouse must  be executed from a CLI (or from a Startup-Sequence.)
  314.           It can't be run from WorkBench.  It  is recommended  that you set
  315.           the stack  size option  of RunBack  to 4000 when starting QMouse.
  316.           It is also recommended that you  use the  -V option  of QMouse to
  317.           set the stack size for any spawned CLI's to at least 20000.
  318.  
  319.                1> Stack 20000
  320.                   ...
  321.                1> RunBack -S4000 QMouse -B -CEM543 -R -V20000
  322.  
  323.  
  324.  
  325.                                   TO REMOVE QMOUSE
  326.  
  327.  
  328.           Press <Control><Left Amiga><Esc> (all at the same time.)
  329.  
  330.  
  331.  
  332.                                      SOURCE CODE
  333.  
  334.  
  335.           Due to  the large size of the source code for V1.3 (over 45K), it
  336.           will no longer be distributed.   If you  desire the  source code,
  337.           please send a SASE and a disk with your QMouse donation.
  338.  
  339.  
  340.  
  341.                                        CREDITS
  342.  
  343.  
  344.           This program  has been inspired by PopCLI, Mach, DMouse, MouseOff
  345.           and  others.    Thanks  to  the  authors  of  these  programs for
  346.           providing good examples of how to make the Amiga "do its thing!"
  347.  
  348.           RunBack is copyrighted by MicroSmiths, Inc.
  349.  
  350.  
  351.  
  352.                                      KNOWN BUGS
  353.  
  354.           Intuition will often restore the mouse pointer to the Preferences
  355.           pointer.  QMouse  will  reblank  the  pointer  within  1/10  of a
  356.           second,  but  this  can  be  very annoying (especially when using
  357.           WordPerfect.)  This seems to be a tug-of-war match with Intuition
  358.           over control  of the mouse pointer.  If it bothers you, just turn
  359.           off the mouse pointer blanking option.
  360.  
  361.  
  362.  
  363.  
  364.  
  365.                                           6
  366.  
  367.  
  368.  
  369.                                  RAW KEY DEFINITIONS
  370.  
  371.  
  372.                   Raw Key                       Raw Key
  373.                   Number      Key               Number      Key
  374.  
  375.                     00        `                   30        Undefined
  376.                     01        1                   31        Z
  377.                     02        2                   32        X
  378.                     03        3                   33        C
  379.                     04        4                   34        V
  380.                     05        5                   35        B
  381.                     06        6                   36        N
  382.                     07        7                   37        M
  383.                     08        8                   38        <
  384.                     09        9                   39        >
  385.                     0A        0                   3A        /
  386.                     0B        -                   3B        Undefined
  387.                     0C        =                   3C        NK.
  388.                     0D        \                   3D        NK7
  389.                     0E        Undefined           3E        NK8
  390.                     0F        NK0                 3F        NK9
  391.                     10        Q                   40        Space
  392.                     11        W                   41        Back Space
  393.                     12        E                   42        Tab
  394.                     13        R                   43        Enter
  395.                     14        T                   44        Return
  396.                     15        Y                   45        Escape
  397.                     16        U                   46        Del
  398.                     17        I                   47        Undefined
  399.                     18        O                   48        Undefined
  400.                     19        P                   49        Undefined
  401.                     1A        {                   4A        NK-
  402.                     1B        }                   4B        Undefined
  403.                     1C        Undefined           4C        UP
  404.                     1D        NK1                 4D        DOWN
  405.                     1E        NK2                 4E        RIGHT
  406.                     1F        NK3                 4F        LEFT
  407.                     20        A                   50        F1
  408.                     21        S                   51        F2
  409.                     22        D                   52        F3
  410.                     23        F                   53        F4
  411.                     24        G                   54        F5
  412.                     25        H                   55        F6
  413.                     26        J                   56        F7
  414.                     27        K                   57        F8
  415.                     28        L                   58        F9
  416.                     29        ;                   59        F10
  417.                     2A        "                   5A        Undefined
  418.                     2B        Undefined           5B        Undefined
  419.                     2C        Undefined           5C        Undefined
  420.                     2D        NK4                 5D        Undefined
  421.                     2E        NK5                 5E        Undefined
  422.                     2F        NK6                 5F        Help
  423.  
  424.  
  425.  
  426.                                           7
  427.  
  428.  
  429.  
  430.                                   RELEASE 1.1 NOTES
  431.                                      08-Jul-1988
  432.  
  433.  
  434.           o    Made the clock come to the front whenever its been obscured,
  435.                rather  than  every  10  seconds.    This was bothering some
  436.                programs.  Thanks to D. J. James for this idea.
  437.  
  438.           o    The manual incorrectly documented  the <Control><Left Amiga>
  439.                <Esc> method  of terminating  QMouse.  This should have read
  440.                <Control><Left Amiga><F1>, but I changed the program to work
  441.                as documented.
  442.  
  443.           o    Intuition will  restore the  mouse pointer  occasionally.  I
  444.                changed QMouse  to re-blank  the mouse  pointer quicker than
  445.                before.
  446.  
  447.  
  448.  
  449.                                   RELEASE 1.2 NOTES
  450.                                      30-Aug-1988
  451.  
  452.  
  453.           o    Modified  to  assemble  with  the  Manx assembler.  The Manx
  454.                assembler  creates  about  5-10%  smaller  code.    See  the
  455.                included  makefile  for  assembling with the Manx assembler.
  456.                Source will still assemble  with the  Metacomco assembler as
  457.                before!
  458.  
  459.           o    Intuition calls  are now  made from  the QMouse task, rather
  460.                than from  the  input  handler.    This  should  resolve any
  461.                Intuition lockups.
  462.  
  463.           o    WindowToFront() not  called for BACKDROP type windows.  This
  464.                should help eliminate the  possibility of  WorkBench locking
  465.                up.
  466.  
  467.           o    Added automatic window activation (i.e. Sun Mouse).  Specify
  468.                option -R to activate Sun Mouse (-S was already used.)
  469.  
  470.           o    Added click to back feature.  Specify option  -B to activate
  471.                click to back.
  472.  
  473.           o    Added  stack  size  feature.    Allows  QMouse to run with a
  474.                smaller stack while insuring adequate stack size for spawned
  475.                CLI's.  Specify option -V to change the default stack size.
  476.  
  477.           o    Fixed bug  with clicking  to front a window on a screen that
  478.                is in the background.  No one had reported this bug yet. ;-)
  479.  
  480.           o    Cleaned up documentation and  fixed any  inaccuracies that I
  481.                found.      Documentation   for   option  -M  now  reads  to
  482.                "deactivate" the screen shuffler.   Actually,  the -M option
  483.                was ignored until release 1.2.
  484.  
  485.  
  486.  
  487.                                           8
  488.  
  489.  
  490.  
  491.                                   RELEASE 1.3 NOTES
  492.                                      8-Oct-1988
  493.  
  494.  
  495.           o    Added multiple hot key support.  Specify option -H to define
  496.                multiple hot key commands.  Thanks  to Clete  Baker for this
  497.                idea.
  498.  
  499.           o    Added  keyboard  record/playback  support.   <Left Alt><Esc>
  500.                toggles  the  recorder  on  and  off.    <Left  Alt><Return>
  501.                activates the keyboard playback.
  502.  
  503.           o    Added ability  to read  commands from  a configuration file.
  504.                This was needed to  support  multiple  hot  key definitions.
  505.                Specify option -F to read commands from a file.
  506.  
  507.           o    Added option  to display the amount of available memory with
  508.                the clock.  Add the "M" modifier to option -C to display the
  509.                amount of available memory (e.g. -CM).
  510.  
  511.           o    Added option  to display  the time  in 24 hour format.  This
  512.                option was added at the request of Jim Cooper.
  513.  
  514.           o    When  pointer  blanking  is  enabled,  the  pointer  will be
  515.                blanked immediately  when a  key is  typed.   Thanks to Eric
  516.                Schwertfeger for this idea.
  517.  
  518.           o    Changed the method of  screen blanking.   Previously, QMouse
  519.                opened  an  Intuition  screen  and  changed it's colors, now
  520.                QMouse turns off DMA  for the  COPPER.   This shaved  off 88
  521.                bytes from QMouse.  Thanks to Jim Cooper for this idea.
  522.  
  523.           o    General code  cleanup.  Tried to make the code more reliable
  524.                in certain situations.  The code  size grew  several hundred
  525.                bytes on account of this effort.
  526.  
  527.  
  528.  
  529.  
  530.  
  531.  
  532.  
  533.  
  534.  
  535.  
  536.  
  537.  
  538.  
  539.  
  540.  
  541.  
  542.  
  543.  
  544.  
  545.  
  546.  
  547.                                           9
  548.