home *** CD-ROM | disk | FTP | other *** search
/ High Voltage Shareware / high1.zip / high1 / DIR24 / RODNT100.ZIP / README.1ST < prev    next >
Text File  |  1993-07-13  |  21KB  |  464 lines
  1. --------------------------------- Copyright ----------------------------------
  2.  
  3.    Copyright (c) 1993 by Michael Lee Finney.  All rights reserved.
  4.  
  5. --------------------------------- Shareware ----------------------------------
  6.  
  7.    This program is shareware.  If you find this program useful you must
  8. register your copy.  To register a private copy, send $15.00 (US funds)
  9. for each copy to:
  10.  
  11.    Michael Lee Finney
  12.    114 Old Wiggington Road
  13.    Lynchburg, Va. 24502-4669
  14.  
  15. Please make remittance payable to: Michael Lee Finney, and include your
  16. company name (for a corporate license), name, address and phone number.
  17. I would also appreciate the options used for your particular mouse.  This
  18. information will allow me to better tune the options in the next release
  19. and possibly provide an installation program.  The registration cost for
  20. corporate site licenses is...
  21.  
  22.        1..4   copies -- $25 each             
  23.        5..10  copies -- $20 each        
  24.       11..20  copies -- $15 each
  25.       21..40  copies -- $10 each
  26.       41...   copies --  $5 each
  27.  
  28.    These prices are accumulative, so the first four copies cost $25 each,
  29. the next six cost $20 each, and so on.  Thus, for example, a corporate
  30. license for 23 copies would cost...
  31.  
  32.     4 @ $25 ... $100
  33.     6 @ $20 ... $120
  34.    10 @ $15 ... $150
  35.     3 @ $10 ...  $60
  36.                ------
  37.                 $430
  38.  
  39.    To obtain the latest version of this program when you register, send
  40. $10 for shipping and handling to the above address.  This $10 does NOT
  41. apply to the registration cost and only one copy will be sent regardless
  42. of the number of copies registered (the author is NOT in the business of
  43. diskette duplication).  However, the $10 is a flat fee and not a per
  44. registered copy charge.  If you send me $25 without indicating that a
  45. private license with requested diskette or a commercial license without
  46. a requested diskette is desired, I will take my cue from the method of
  47. payment and request -- namely a check that appears to be a company check
  48. or the use of a company letterhead or the mention of a company name will
  49. be assumed to indicate a commercial registration whereas a private check
  50. and a simple note without the mention of any company will be assumed to
  51. be a private registration with a request for a diskette.
  52.  
  53. Note: Registration is not required for beta releases of this program.
  54.       However, the license to use the beta release expires when the
  55.       corresponding general availability release is issued and with this
  56.       release the license to use all previous beta releases has expired.
  57.  
  58. ---------------------------------- License -----------------------------------
  59.  
  60.    Unregistered users (personal or corporate) are permitted to use this
  61. program for a trial period of one month.  By the end of this period you
  62. must either register the program or remove it from your system(s).
  63.  
  64.    Registered users are permitted to use this program on one system at a
  65. time and may make as many archived copies for backup purposes as needed.
  66. It may be used on multiple systems (for a single license) only under the
  67. condition that only one of the systems is in use at a time.  Since this
  68. program is an operating system device driver, the assumption is that it is
  69. in continual use when the system in use.  Therefore a registered copy
  70. is required for each system on which this program is used simultaneously.
  71.  
  72.    Registered users are entitled to support.  If after registration a
  73. program error is found, the author will make every attempt possible to
  74. repair the program.  If the failure cannot be repaired and makes the
  75. product unusable the author will refund the registration fee.  Otherwise,
  76. registered users are eligible for the "bug" reward (see details below).
  77. Additionally, registered users will also be sent notices of new versions
  78. of this program, and of other shareware releases by the author.  In
  79. particular a registered beta user will be notified of the general
  80. availability release.  Your name will NOT be sold to a mailing list.
  81.  
  82.    This program is not intentionally crippled in any manner, therefore a
  83. new copy of the program will NOT be sent when the program is registered
  84. unless explicitly requested.
  85.  
  86. Note: The license to use previous beta releases has expired with this
  87.       release of the general availability version of this software.
  88.  
  89. ---------------------------------- Contents ----------------------------------
  90.  
  91. The distribution file RODNT100.ZIP contains the following files...
  92.  
  93.    LICENSE.DOC  - Licensing information
  94.    ORDER.DOC    - Ordering information
  95.    RELEASE.DOC  - Release information
  96.    README.1ST   - This file
  97.    RODENT.DOC   - Complete documentation
  98.    RODENT.SYS   - Mouse driver
  99.    RODENT.EXE   - Presentation Manager test program
  100.  
  101.    BUSS.DDP     - Device driver installation file
  102.    CALCMP2X.DDP - Device driver installation file
  103.    CALCMP3X.DDP - Device driver installation file
  104.    CALCMP9X.DDP - Device driver installation file
  105.    CALCMPWZ.DDP - Device driver installation file
  106.    FELIX.DDP    - Device driver installation file
  107.    INPORT.DDP   - Device driver installation file
  108.    LOGITECH.DDP - Device driver installation file
  109.    MSOFT.DDP    - Device driver installation file
  110.    MSYSTEMS.DDP - Device driver installation file
  111.    PS2.DDP      - Device driver installation file
  112.    SGRAPH.DDP   - Device driver installation file
  113.  
  114.    If this device driver is placed on a bulletin board, all files must
  115. be distributed -- preferably in the original RODNT100.ZIP file.
  116.  
  117. ---------------------------------- Summary -----------------------------------
  118.  
  119.    RODENT.SYS is a mouse driver which supports most mice.  It provides
  120. three button support.  The advantages of RODENT.SYS over the IBM mouse
  121. drivers (assuming that they even work for your mouse) are...
  122.  
  123.    1. Up to 7 buttons are supported.
  124.  
  125.    2. The mouse buttons can be arbitrarily reassigned (reordered).
  126.  
  127.    3. The middle button on most 3 button mouse can be programmed as a
  128.       chord of the left and right buttons.
  129.  
  130.    4. The interrupt handlers have been carefully tuned resulting in a
  131.       lower system load (compared to the IBM mouse drivers) when the
  132.       mouse is active.
  133.  
  134.    5. The FIFO buffer of an 16550AFN or 16552 can be enabled, further
  135.       lowering the system load under the appropriate conditions.
  136.  
  137.    6. More serial mice are supported using more protocols than the IBM
  138.       mouse drivers support.  Some digitizer tablets are supported.
  139.       All mice supported by the IBM mouse drivers are supported.
  140.  
  141.    7. Auto-detects the type of mouse, where possible.
  142.  
  143.    8. Auto-detects the number of mouse buttons, where possible.
  144.  
  145.    9. Auto-detects the type of uart (for serial mice).
  146.  
  147.   10. Supports additional baud rates over the basic 1200 provided by the
  148.       IBM mouse drivers.  Baud rates of 150, 300, 600, 1200, 2400, 4800,
  149.       9600 and 19200 are supported for those mice which allow the baud
  150.       rate to be set.
  151.  
  152.   11. Supports additional reporting rates over the default provided by
  153.       the IBM mouse drivers.  Reporting rates of 10, 20, 30, 40, 50,
  154.       60, 80, 100 and 200 are supported for those mice which allow the
  155.       reporting rate to be set.
  156.  
  157.   12. Any 8250 compatible uart can be used at any port address and any irq.
  158.       The IBM drivers only support COM1..COM2.
  159.  
  160.   13. Should not "lose" the mouse during a reboot via Ctrl-Alt-Del.
  161.  
  162.   14. Mouse deinstalls correctly on ABIOS systems (a bug in some of the IBM
  163.       mouse drivers).
  164.  
  165.   15. Low battery detection for serial Logitech radio mice is provided
  166.       during system boot.
  167.  
  168.   16. The actual mouse resolution can be specified.
  169.  
  170.   17. The mouse sensitivity can be increased or reduced by a factor of
  171.       1, 2, 4 or 8.  This is useful for very low or high resolution mice
  172.       and for handicapped individuals who have problems with fine motor
  173.       control.
  174.  
  175. -------------------------------- Installation --------------------------------
  176.  
  177.    This mouse driver is an OS/2 2.x device driver ONLY, it does NOT
  178. function under OS/2 1.x or under any version of DOS, Windows or Unix.
  179. It is not possible to install this driver under OS/2 1.x, DOS, Windows
  180. or Unix.
  181.  
  182. Installing RODENT.SYS during OS/2 installation:
  183.  
  184.    1. Unzip RODNT100.ZIP and copy the files to the root directory on
  185.       a diskette prior to installing OS/2 (unless using a diskette
  186.       received from the author, in which case this step has been done
  187.       for you).
  188.  
  189.    2. Proceed with installing OS/2.
  190.  
  191.    3. At the "Select Mouse" screen, select "No pointing device support".
  192.       This prevents OS/2 from placing incorrect statements in CONFIG.SYS
  193.       during installation.
  194.  
  195.    4. At the "Advanced Options" screen, select "Install Device Support
  196.       Diskette".
  197.  
  198.    5. At the "OS/2 2.1 Device Driver Installation" screen, place the
  199.       diskette from step 1 into the diskette drive and select "Install".
  200.  
  201.    6. At the "Select Device Drivers" screen, select the appropriate mouse
  202.       driver (down arrow to change current highlighted entry and space bar
  203.       to select the current highlighted entry).  Press <tab> to move to
  204.       the "Ok" button and then press <Enter>.  OS/2 will copy RODENT.SYS
  205.       into the \OS2 directory and update your CONFIG.SYS file.  It will
  206.       then present the "OS/2 2.1 Device Driver Installation" screen again
  207.       because you might have other device drivers.  If so, install them
  208.       now.  After all of your device drivers have been installed use the
  209.       right arrow to select "Exit" and press <Enter>.  At the "Exit the
  210.       Program" dialog, select "Yes".  OS/2 will then present you with a
  211.       message that your system configuration has been changed.  Press
  212.       <Enter> to continue with the installation of OS/2.
  213.  
  214.    7. At the "Advanced Options" screen, press <Enter> to continue.  You
  215.       may now complete the installation of OS/2.
  216.  
  217.    Warning: OS/2 will add the statements to CONFIG.SYS in the incorrect
  218.             order.  If you have installed a serial mouse you may need
  219.             to edit your CONFIG.SYS file before your mouse can be used.
  220.             The mouse statements in your CONFIG.SYS file must occur in
  221.             the following order...
  222.  
  223.                DEVICE=...POINTDD.SYS...
  224.                DEVICE=...RODENT.SYS...
  225.                DEVICE=...MOUSE.SYS...
  226.                DEVICE=...VMOUSE.SYS...
  227.                DEVICE=...COM.SYS...
  228.                DEVICE=...VCOM.SYS...
  229.  
  230.             If this is the case, then when OS/2 is rebooted it may tell
  231.             you that it failed to install some or all of RODENT.SYS,
  232.             MOUSE.SYS and VMOUSE.SYS.  Press <Enter> to continue booting
  233.             OS/2, start an editor (the system editor is always available)
  234.             and change the CONFIG.SYS file so that the mouse statements
  235.             are in the correct order.  This should be done when installing
  236.             a serial mouse even if OS/2 boots without error messages to
  237.             avoid conflicts with the mouse driver and the serial port
  238.             driver.
  239.  
  240. Installing RODENT.SYS after OS/2 installation:
  241.  
  242.       The file RODENT.SYS should be copied to a directory of your
  243.    choice -- the C:\OS2 directory is the usual choice, but any directory
  244.    can be used.  If OS/2 does not support your mouse at all then remember
  245.    that the mouse will not function correctly until RODENT.SYS has been
  246.    installed.  It is necessary to modify the CONFIG.SYS files to contain
  247.    the following lines...
  248.  
  249.       DEVICE=x:\OS2\POINTDD.SYS
  250.       DEVICE=x:\path\RODENT.SYS [options...]
  251.       DEVICE=x:\OS2\MOUSE.SYS TYPE=RODENT$
  252.       DEVICE=x:\OS2\MDOS\VMOUSE.SYS
  253.  
  254.    and any other existing lines relating to the mouse driver should be
  255.    removed.  These lines should be placed in the order given and for
  256.    serial mice must precede the "DEVICE=...COM.SYS..." line.  For
  257.    example, assuming that OS/2 is located on the C: drive and that
  258.    RODENT.SYS has been placed in the C:\OS2 directory:
  259.  
  260.       DEVICE=C:\OS2\POINTDD.SYS
  261.       DEVICE=C:\OS2\RODENT.SYS
  262.       DEVICE=C:\OS2\MOUSE.SYS TYPE=RODENT$
  263.       DEVICE=C:\OS2\MDOS\VMOUSE.SYS
  264.  
  265.       or:
  266.  
  267.       DEVICE=C:\OS2\POINTDD.SYS
  268.       DEVICE=C:\OS2\RODENT.SYS BAUD=19200 BUFFERED DPI=400
  269.       DEVICE=C:\OS2\MOUSE.SYS TYPE=RODENT$
  270.       DEVICE=C:\OS2\MDOS\VMOUSE.SYS
  271.  
  272.       or:
  273.  
  274.       DEVICE=C:\OS2\POINTDD.SYS
  275.       DEVICE=C:\OS2\RODENT.SYS PORT=73D8 IRQ=11 BAUD=2400 BUFFERED MOUSE=C PROTOCOL=MM BUTTONS=2 DPI=300
  276.       DEVICE=C:\OS2\MOUSE.SYS TYPE=RODENT$
  277.       DEVICE=C:\OS2\MDOS\VMOUSE.SYS
  278.  
  279.    The first DEVICE line in the last example is longer than 80 characters.
  280.    In most cases an installation similar to the first two examples would
  281.    be used.  If you have multiple mice attached to your system, then you
  282.    may need to specify the mouse type or the serial port for the desired
  283.    mouse.  Only one mouse can be used at a time.  Lines in your CONFIG.SYS
  284.    which are mouse related are...
  285.  
  286.       DEVICE=C:\OS2\POINTDD.SYS
  287.       DEVICE=C:\OS2\VISION.SYS...
  288.       DEVICE=C:\OS2\PCLOGIC.SYS...
  289.       DEVICE=C:\OS2\MOUSE.SYS...
  290.       DEVICE=C:\OS2\MDOS\VMOUSE.SYS...
  291.  
  292.    all such lines should be removed and replaced as shown above.  There may
  293.    be other mouse related lines for different releases of OS/2 and where
  294.    mouse vendors have provided an OS/2 mouse driver.  Further, the
  295.    statements in CONFIG.SYS should occur in the following order...
  296.  
  297.       DEVICE=...POINTDD.SYS...
  298.       DEVICE=...RODENT.SYS...
  299.       DEVICE=...MOUSE.SYS...
  300.       DEVICE=...VMOUSE.SYS...
  301.       DEVICE=...COM.SYS...
  302.       DEVICE=...VCOM.SYS...
  303.  
  304.    failure to observe this ordering may result in failure of the mouse to
  305.    load properly or of the serial ports to operate correctly.  This mouse
  306.    driver has been tested under OS/2 2.0 GA, 2.0 GA+SP, 2.1 March beta and
  307.    2.1 GA.  It has been tested on a 50Mhz 486DX AT-clone and on an IBM
  308.    PS/2 model 70 (25Mhz 386).  The following mice have been tested...
  309.  
  310.       CalComp Wiz digitizer
  311.       CalComp DrawingPad digitizer
  312.       Felix mouse
  313.       Honeywell Mouse
  314.       Keen Mouse
  315.       Logitech C9 Mouse
  316.       Logitech First Mouse (serial)
  317.       Logitech MouseMan Cordless Mouse (serial)
  318.       Logitech MouseMan Mouse (buss)
  319.       Logitech TrackMan Mouse (serial -- Mouse Systems compatible)
  320.       Microsoft Mouse (Inport buss)
  321.       Microsoft Mouse (serial)
  322.       SummaSketch III
  323.  
  324.       Only these mice have been tested by the author with this mouse
  325.    driver.  However, the driver is MUCH more capable because special
  326.    provisions have been made to support "partially" compatible mice
  327.    and most common mice use one of the available support protocols.
  328.  
  329.       In some cases a mouse might function with the driver, but require
  330.    some of the more exotic options (see the option list below).  For
  331.    example, you could have a mouse which recognized most of the protocols
  332.    associated with a Logitech type C mouse, but could not be automagically
  333.    recognized.  In this case you would use the CONFIG.SYS entries:
  334.  
  335.       DEVICE=C:\OS2\POINTDD.SYS
  336.       DEVICE=C:\OS2\RODENT.SYS COM=1 MOUSE=C
  337.       DEVICE=C:\OS2\MOUSE.SYS TYPE=RODENT$
  338.       DEVICE=C:\OS2\MDOS\VMOUSE.SYS
  339.  
  340.    (assuming the mouse is attached to COM1) which forces the mouse
  341.    driver to accept the mouse as a Logitech type C mouse, but avoids
  342.    the recognition check used for the type C mice.  However, all
  343.    programming codes are still sent to the mouse.  Or as a more severe
  344.    example, you could have a mouse which supports the Mouse System's 5B
  345.    communication protocol (default with Mouse System's mice) but nothing
  346.    else works.  In that case you would use the CONFIG.SYS entries:
  347.  
  348.       DEVICE=C:\OS2\POINTDD.SYS
  349.       DEVICE=C:\OS2\RODENT.SYS COM=1 MOUSE=* PROTOCOL=5B
  350.       DEVICE=C:\OS2\MOUSE.SYS TYPE=RODENT$
  351.       DEVICE=C:\OS2\MDOS\VMOUSE.SYS
  352.  
  353.    which forces the mouse driver to use the correct communication protocol,
  354.    but with NO attempt made at sending programming codes to the mouse.
  355.    The mouse must default to the appropriate state to use the specified
  356.    protocol.  Many mice can be setup this way, however other mice either
  357.    cannot be automagically recognized or intrinsically REQUIRE programming.
  358.  
  359. ------------------------- Known Setup Configurations -------------------------
  360.  
  361.    Felix mouse
  362.    Honeywell Mouse (as shipped)
  363.    Keen Mouse (switch in MS mode, provides two buttons)
  364.    Logitech C7 Mouse (serial)
  365.    Logitech C9 Mouse (serial or buss)
  366.    Logitech First Mouse (serial -- model: M-MD15L-9F)
  367.    Logitech MouseMan Cordless Mouse (serial -- model: M-RA12)
  368.    Logitech MouseMan Mouse (buss -- model: M-PD13-9MD)
  369.    Logitech TrackMan Mouse (serial -- models: T-CA1- and T-CA1-9F)
  370.    Microsoft Mouse (serial or Inport buss)
  371.    PS/2 port mice
  372.  
  373.       DEVICE=C:\OS2\POINTDD.SYS
  374.       DEVICE=C:\OS2\RODENT\RODENT.SYS
  375.       DEVICE=C:\OS2\MOUSE.SYS TYPE=RODENT$
  376.       DEVICE=C:\OS2\MDOS\VMOUSE.SYS
  377.  
  378.    Honeywell Mouse (with jumper J3 cut)
  379.    Keen Mouse (switch in PC mode, provides three buttons)
  380.    Mouse Systems PC Mouse III
  381.  
  382.       DEVICE=C:\OS2\POINTDD.SYS
  383.       DEVICE=C:\OS2\RODENT.SYS COM=# MOUSE=MS
  384.       DEVICE=C:\OS2\MOUSE.SYS TYPE=RODENT$
  385.       DEVICE=C:\OS2\MDOS\VMOUSE.SYS
  386.  
  387.    CalComp Wiz and 2x00 digitizers
  388.  
  389.       DEVICE=C:\OS2\POINTDD.SYS
  390.       DEVICE=C:\OS2\RODENT.SYS MOUSE=DW
  391.       DEVICE=C:\OS2\MOUSE.SYS TYPE=RODENT$
  392.       DEVICE=C:\OS2\MDOS\VMOUSE.SYS
  393.  
  394.    CalComp 3300 (and newer) digitizers
  395.  
  396.       DEVICE=C:\OS2\POINTDD.SYS
  397.       DEVICE=C:\OS2\RODENT.SYS MOUSE=D3
  398.       DEVICE=C:\OS2\MOUSE.SYS TYPE=RODENT$
  399.       DEVICE=C:\OS2\MDOS\VMOUSE.SYS
  400.  
  401.    CalComp 9x00 digitizers
  402.  
  403.       DEVICE=C:\OS2\POINTDD.SYS
  404.       DEVICE=C:\OS2\RODENT.SYS MOUSE=D9
  405.       DEVICE=C:\OS2\MOUSE.SYS TYPE=RODENT$
  406.       DEVICE=C:\OS2\MDOS\VMOUSE.SYS
  407.  
  408.    Summagraphics digitizers
  409.  
  410.       DEVICE=C:\OS2\POINTDD.SYS
  411.       DEVICE=C:\OS2\RODENT.SYS MOUSE=SG
  412.       DEVICE=C:\OS2\MOUSE.SYS TYPE=RODENT$
  413.       DEVICE=C:\OS2\MDOS\VMOUSE.SYS
  414.  
  415. ---------------------------------- Testing -----------------------------------
  416.  
  417.    After booting OS/2 preliminary testing can be accomplished simply by
  418. moving the mouse and making sure that the mouse cursor follows the movement
  419. of the mouse.  Execute RODENT.EXE to further test this device driver.  This
  420. test program will display a Presentation Manager window.  It will display
  421. the number of buttons as perceived by OS/2 and the mouse resolution as
  422. perceived by OS/2.  Further, if you click the mouse buttons, the associated
  423. OS/2 mouse event is displayed.  The most recent mouse event is flagged by
  424. an asterisk.  If the mouse pointer follows mouse movement correctly and
  425. all buttons operate correctly then you will probably not have any trouble
  426. with the mouse driver.  Other signs of trouble might be consistently missing
  427. mouse events (such as clicks) or events occurring without any associated
  428. physical mouse action.
  429.  
  430.    When evaluating missing or extra events reasonable care should be taken.
  431. It has been observed that occasionally OS/2 will "lose" a mouse click during
  432. rapid mouse activity -- this is related to the fact that OS/2 only maintains
  433. a small mouse event queue to avoid "piling" up an extremely large number of
  434. events.  Sometimes losing a button release has the appearance of additional
  435. clicks if an application auto-repeats while a mouse button is pressed.  The
  436. loss, by OS/2, of mouse events is VERY rare except under very heavy mouse
  437. activity.  However, it appears to be slightly more common when using higher
  438. baud rates because the internal OS/2 queue is more likely to overflow.  This
  439. has been seen using the Logitech radio mouse at 9600 baud.  Also this loss
  440. might not actually be the fault of OS/2, but is occurring in the applications
  441. instead (actually more probable).  Nevertheless, this behavior has sometimes
  442. been seen, both with these mouse drivers AND with the OS/2 mouse drivers.
  443. It has been seen most often using Logitech's radio mouse and Microsoft's PWB
  444. in a full screen session.  Sometimes if this happens when scrolling releasing
  445. the mouse button will not stop the scrolling.  Simply click the mouse button
  446. again to stop scrolling.
  447.  
  448.    This is a low-level mouse driver.  OS/2 handles all of the higher level
  449. functions, including routing mouse events to DOS sessions, OS/2 sessions,
  450. PM sessions, WIN-OS2 sessions and VMB sessions.  OS/2 reports all mouse
  451. events (in the appropriate form) to the currently active session.  Therefore
  452. DOS sessions CAN take advantage of all three buttons.  Since this mouse
  453. driver is not involved in these actions, failure of OS/2 in that manner
  454. is probably not caused by this device driver.
  455.  
  456.    Note: The resolution reported by OS/2 is in "mickeys per centimeter".
  457. Therefore, the dots per inch provided to the device driver is divided by
  458. 2.54 and rounded when reporting to OS/2.  This device driver reports the
  459. closest value possible.  For example, 400 dpi reports as 157 mickeys.
  460. Since the value reported to OS/2 is a fixed point number, the result if
  461. multiplied by 2.54 is only 399 (after rounding) instead of the original 400.
  462.  
  463. ------------------------------------------------------------------------------
  464.