--------------------------------- Copyright ----------------------------------

Copyright (c) 1993 by Michael Lee Finney. All rights reserved.

--------------------------------- Shareware ----------------------------------

This program is shareware. If you find this program useful you must
register your copy. To register a private copy, send $15.00 (US funds)
for each copy to:

Michael Lee Finney
114 Old Wiggington Road
Lynchburg, Va. 24502-4669

Please make remittance payable to: Michael Lee Finney, and include your
company name (for a corporate license), name, address and phone number.
I would also appreciate the options used for your particular mouse. This
information will allow me to better tune the options in the next release
and possibly provide an installation program. The registration cost for
corporate site licenses is...

1..4 copies -- $25 each
5..10 copies -- $20 each
11..20 copies -- $15 each
21..40 copies -- $10 each
41... copies -- $5 each

These prices are accumulative, so the first four copies cost $25 each,
the next six cost $20 each, and so on. Thus, for example, a corporate
license for 23 copies would cost...

4 @ $25 ... $100
6 @ $20 ... $120
10 @ $15 ... $150
3 @ $10 ... $60
------
$430

To obtain the latest version of this program when you register, send
$10 for shipping and handling to the above address. This $10 does NOT
apply to the registration cost and only one copy will be sent regardless
of the number of copies registered (the author is NOT in the business of
diskette duplication). However, the $10 is a flat fee and not a per
registered copy charge. If you send me $25 without indicating that a
private license with requested diskette or a commercial license without
a requested diskette is desired, I will take my cue from the method of
payment and request -- namely a check that appears to be a company check
or the use of a company letterhead or the mention of a company name will
be assumed to indicate a commercial registration whereas a private check
and a simple note without the mention of any company will be assumed to
be a private registration with a request for a diskette.

Note: Registration is not required for beta releases of this program.
However, the license to use the beta release expires when the
corresponding general availability release is issued and with this
release the license to use all previous beta releases has expired.

---------------------------------- License -----------------------------------

Unregistered users (personal or corporate) are permitted to use this
program for a trial period of one month. By the end of this period you
must either register the program or remove it from your system(s).

Registered users are permitted to use this program on one system at a
time and may make as many archived copies for backup purposes as needed.
It may be used on multiple systems (for a single license) only under the
condition that only one of the systems is in use at a time. Since this
program is an operating system device driver, the assumption is that it is
in continual use when the system in use. Therefore a registered copy
is required for each system on which this program is used simultaneously.

Registered users are entitled to support. If after registration a
program error is found, the author will make every attempt possible to
repair the program. If the failure cannot be repaired and makes the
product unusable the author will refund the registration fee. Otherwise,
registered users are eligible for the "bug" reward (see details below).
Additionally, registered users will also be sent notices of new versions
of this program, and of other shareware releases by the author. In
particular a registered beta user will be notified of the general
availability release. Your name will NOT be sold to a mailing list.

This program is not intentionally crippled in any manner, therefore a
new copy of the program will NOT be sent when the program is registered
unless explicitly requested.

Note: The license to use previous beta releases has expired with this
release of the general availability version of this software.

---------------------------------- Contents ----------------------------------

The distribution file RODNT100.ZIP contains the following files...

LICENSE.DOC - Licensing information
ORDER.DOC - Ordering information
RELEASE.DOC - Release information
README.1ST - This file
RODENT.DOC - Complete documentation
RODENT.SYS - Mouse driver
RODENT.EXE - Presentation Manager test program

BUSS.DDP - Device driver installation file
CALCMP2X.DDP - Device driver installation file
CALCMP3X.DDP - Device driver installation file
CALCMP9X.DDP - Device driver installation file
CALCMPWZ.DDP - Device driver installation file
FELIX.DDP - Device driver installation file
INPORT.DDP - Device driver installation file
LOGITECH.DDP - Device driver installation file
MSOFT.DDP - Device driver installation file
MSYSTEMS.DDP - Device driver installation file
PS2.DDP - Device driver installation file
SGRAPH.DDP - Device driver installation file

If this device driver is placed on a bulletin board, all files must
be distributed -- preferably in the original RODNT100.ZIP file.

---------------------------------- Summary -----------------------------------

RODENT.SYS is a mouse driver which supports most mice. It provides
three button support. The advantages of RODENT.SYS over the IBM mouse
drivers (assuming that they even work for your mouse) are...

1. Up to 7 buttons are supported.

2. The mouse buttons can be arbitrarily reassigned (reordered).

3. The middle button on most 3 button mouse can be programmed as a
chord of the left and right buttons.

4. The interrupt handlers have been carefully tuned resulting in a
lower system load (compared to the IBM mouse drivers) when the
mouse is active.

5. The FIFO buffer of an 16550AFN or 16552 can be enabled, further
lowering the system load under the appropriate conditions.

6. More serial mice are supported using more protocols than the IBM
mouse drivers support. Some digitizer tablets are supported.
All mice supported by the IBM mouse drivers are supported.

7. Auto-detects the type of mouse, where possible.

8. Auto-detects the number of mouse buttons, where possible.

9. Auto-detects the type of uart (for serial mice).

10. Supports additional baud rates over the basic 1200 provided by the
IBM mouse drivers. Baud rates of 150, 300, 600, 1200, 2400, 4800,
9600 and 19200 are supported for those mice which allow the baud
rate to be set.

11. Supports additional reporting rates over the default provided by
the IBM mouse drivers. Reporting rates of 10, 20, 30, 40, 50,
60, 80, 100 and 200 are supported for those mice which allow the
reporting rate to be set.

12. Any 8250 compatible uart can be used at any port address and any irq.
The IBM drivers only support COM1..COM2.

13. Should not "lose" the mouse during a reboot via Ctrl-Alt-Del.

14. Mouse deinstalls correctly on ABIOS systems (a bug in some of the IBM
mouse drivers).

15. Low battery detection for serial Logitech radio mice is provided
during system boot.

16. The actual mouse resolution can be specified.

17. The mouse sensitivity can be increased or reduced by a factor of
1, 2, 4 or 8. This is useful for very low or high resolution mice
and for handicapped individuals who have problems with fine motor
control.

-------------------------------- Installation --------------------------------

This mouse driver is an OS/2 2.x device driver ONLY, it does NOT
function under OS/2 1.x or under any version of DOS, Windows or Unix.
It is not possible to install this driver under OS/2 1.x, DOS, Windows
or Unix.

Installing RODENT.SYS during OS/2 installation:

1. Unzip RODNT100.ZIP and copy the files to the root directory on
a diskette prior to installing OS/2 (unless using a diskette
received from the author, in which case this step has been done
for you).

2. Proceed with installing OS/2.

3. At the "Select Mouse" screen, select "No pointing device support".
This prevents OS/2 from placing incorrect statements in CONFIG.SYS
during installation.

4. At the "Advanced Options" screen, select "Install Device Support
Diskette".

5. At the "OS/2 2.1 Device Driver Installation" screen, place the
diskette from step 1 into the diskette drive and select "Install".

6. At the "Select Device Drivers" screen, select the appropriate mouse
driver (down arrow to change current highlighted entry and space bar
to select the current highlighted entry). Press to move to
the "Ok" button and then press . OS/2 will copy RODENT.SYS
into the \OS2 directory and update your CONFIG.SYS file. It will
then present the "OS/2 2.1 Device Driver Installation" screen again
because you might have other device drivers. If so, install them
now. After all of your device drivers have been installed use the
right arrow to select "Exit" and press . At the "Exit the
Program" dialog, select "Yes". OS/2 will then present you with a
message that your system configuration has been changed. Press
to continue with the installation of OS/2.

7. At the "Advanced Options" screen, press to continue. You
may now complete the installation of OS/2.

Warning: OS/2 will add the statements to CONFIG.SYS in the incorrect
order. If you have installed a serial mouse you may need
to edit your CONFIG.SYS file before your mouse can be used.

The mouse statements in your CONFIG.SYS file must occur in
the following order...

DEVICE=...POINTDD.SYS...
DEVICE=...RODENT.SYS...
DEVICE=...MOUSE.SYS...
DEVICE=...VMOUSE.SYS...
DEVICE=...COM.SYS...
DEVICE=...VCOM.SYS...

If this is the case, then when OS/2 is rebooted it may tell
you that it failed to install some or all of RODENT.SYS,
MOUSE.SYS and VMOUSE.SYS. Press to continue booting
OS/2, start an editor (the system editor is always available)
and change the CONFIG.SYS file so that the mouse statements
are in the correct order. This should be done when installing
a serial mouse even if OS/2 boots without error messages to
avoid conflicts with the mouse driver and the serial port
driver.

Installing RODENT.SYS after OS/2 installation:

The file RODENT.SYS should be copied to a directory of your
choice -- the C:\OS2 directory is the usual choice, but any directory
can be used. If OS/2 does not support your mouse at all then remember
that the mouse will not function correctly until RODENT.SYS has been
installed. It is necessary to modify the CONFIG.SYS files to contain
the following lines...

DEVICE=x:\OS2\POINTDD.SYS
DEVICE=x:\path\RODENT.SYS [options...]
DEVICE=x:\OS2\MOUSE.SYS TYPE=RODENT$
DEVICE=x:\OS2\MDOS\VMOUSE.SYS

and any other existing lines relating to the mouse driver should be
removed. These lines should be placed in the order given and for
serial mice must precede the "DEVICE=...COM.SYS..." line. For
example, assuming that OS/2 is located on the C: drive and that
RODENT.SYS has been placed in the C:\OS2 directory:

DEVICE=C:\OS2\POINTDD.SYS
DEVICE=C:\OS2\RODENT.SYS
DEVICE=C:\OS2\MOUSE.SYS TYPE=RODENT$
DEVICE=C:\OS2\MDOS\VMOUSE.SYS

or:

DEVICE=C:\OS2\POINTDD.SYS
DEVICE=C:\OS2\RODENT.SYS BAUD=19200 BUFFERED DPI=400
DEVICE=C:\OS2\MOUSE.SYS TYPE=RODENT$
DEVICE=C:\OS2\MDOS\VMOUSE.SYS

or:

DEVICE=C:\OS2\POINTDD.SYS
DEVICE=C:\OS2\RODENT.SYS PORT=73D8 IRQ=11 BAUD=2400 BUFFERED MOUSE=C PROTOCOL=MM BUTTONS=2 DPI=300
DEVICE=C:\OS2\MOUSE.SYS TYPE=RODENT$
DEVICE=C:\OS2\MDOS\VMOUSE.SYS

The first DEVICE line in the last example is longer than 80 characters.
In most cases an installation similar to the first two examples would
be used. If you have multiple mice attached to your system, then you
may need to specify the mouse type or the serial port for the desired
mouse. Only one mouse can be used at a time. Lines in your CONFIG.SYS
which are mouse related are...

DEVICE=C:\OS2\POINTDD.SYS
DEVICE=C:\OS2\VISION.SYS...
DEVICE=C:\OS2\PCLOGIC.SYS...
DEVICE=C:\OS2\MOUSE.SYS...
DEVICE=C:\OS2\MDOS\VMOUSE.SYS...

all such lines should be removed and replaced as shown above. There may
be other mouse related lines for different releases of OS/2 and where
mouse vendors have provided an OS/2 mouse driver. Further, the
statements in CONFIG.SYS should occur in the following order...

DEVICE=...POINTDD.SYS...
DEVICE=...RODENT.SYS...
DEVICE=...MOUSE.SYS...
DEVICE=...VMOUSE.SYS...
DEVICE=...COM.SYS...
DEVICE=...VCOM.SYS...

failure to observe this ordering may result in failure of the mouse to
load properly or of the serial ports to operate correctly. This mouse
driver has been tested under OS/2 2.0 GA, 2.0 GA+SP, 2.1 March beta and
2.1 GA. It has been tested on a 50Mhz 486DX AT-clone and on an IBM
PS/2 model 70 (25Mhz 386). The following mice have been tested...

CalComp Wiz digitizer
CalComp DrawingPad digitizer
Felix mouse
Honeywell Mouse
Keen Mouse
Logitech C9 Mouse
Logitech First Mouse (serial)
Logitech MouseMan Cordless Mouse (serial)
Logitech MouseMan Mouse (buss)
Logitech TrackMan Mouse (serial -- Mouse Systems compatible)
Microsoft Mouse (Inport buss)
Microsoft Mouse (serial)
SummaSketch III

Only these mice have been tested by the author with this mouse
driver. However, the driver is MUCH more capable because special
provisions have been made to support "partially" compatible mice
and most common mice use one of the available support protocols.

In some cases a mouse might function with the driver, but require
some of the more exotic options (see the option list below). For
example, you could have a mouse which recognized most of the protocols
associated with a Logitech type C mouse, but could not be automagically
recognized. In this case you would use the CONFIG.SYS entries:

DEVICE=C:\OS2\POINTDD.SYS
DEVICE=C:\OS2\RODENT.SYS COM=1 MOUSE=C
DEVICE=C:\OS2\MOUSE.SYS TYPE=RODENT$
DEVICE=C:\OS2\MDOS\VMOUSE.SYS

(assuming the mouse is attached to COM1) which forces the mouse
driver to accept the mouse as a Logitech type C mouse, but avoids
the recognition check used for the type C mice. However, all
programming codes are still sent to the mouse. Or as a more severe
example, you could have a mouse which supports the Mouse System's 5B
communication protocol (default with Mouse System's mice) but nothing
else works. In that case you would use the CONFIG.SYS entries:

DEVICE=C:\OS2\POINTDD.SYS
DEVICE=C:\OS2\RODENT.SYS COM=1 MOUSE=* PROTOCOL=5B
DEVICE=C:\OS2\MOUSE.SYS TYPE=RODENT$
DEVICE=C:\OS2\MDOS\VMOUSE.SYS

which forces the mouse driver to use the correct communication protocol,
but with NO attempt made at sending programming codes to the mouse.
The mouse must default to the appropriate state to use the specified
protocol. Many mice can be setup this way, however other mice either
cannot be automagically recognized or intrinsically REQUIRE programming.

------------------------- Known Setup Configurations -------------------------

Felix mouse
Honeywell Mouse (as shipped)
Keen Mouse (switch in MS mode, provides two buttons)
Logitech C7 Mouse (serial)
Logitech C9 Mouse (serial or buss)
Logitech First Mouse (serial -- model: M-MD15L-9F)
Logitech MouseMan Cordless Mouse (serial -- model: M-RA12)
Logitech MouseMan Mouse (buss -- model: M-PD13-9MD)
Logitech TrackMan Mouse (serial -- models: T-CA1- and T-CA1-9F)
Microsoft Mouse (serial or Inport buss)
PS/2 port mice

DEVICE=C:\OS2\POINTDD.SYS
DEVICE=C:\OS2\RODENT\RODENT.SYS
DEVICE=C:\OS2\MOUSE.SYS TYPE=RODENT$
DEVICE=C:\OS2\MDOS\VMOUSE.SYS

Honeywell Mouse (with jumper J3 cut)
Keen Mouse (switch in PC mode, provides three buttons)
Mouse Systems PC Mouse III

DEVICE=C:\OS2\POINTDD.SYS
DEVICE=C:\OS2\RODENT.SYS COM=# MOUSE=MS
DEVICE=C:\OS2\MOUSE.SYS TYPE=RODENT$
DEVICE=C:\OS2\MDOS\VMOUSE.SYS

CalComp Wiz and 2x00 digitizers

DEVICE=C:\OS2\POINTDD.SYS
DEVICE=C:\OS2\RODENT.SYS MOUSE=DW
DEVICE=C:\OS2\MOUSE.SYS TYPE=RODENT$
DEVICE=C:\OS2\MDOS\VMOUSE.SYS

CalComp 3300 (and newer) digitizers

DEVICE=C:\OS2\POINTDD.SYS
DEVICE=C:\OS2\RODENT.SYS MOUSE=D3
DEVICE=C:\OS2\MOUSE.SYS TYPE=RODENT$
DEVICE=C:\OS2\MDOS\VMOUSE.SYS

CalComp 9x00 digitizers

DEVICE=C:\OS2\POINTDD.SYS
DEVICE=C:\OS2\RODENT.SYS MOUSE=D9
DEVICE=C:\OS2\MOUSE.SYS TYPE=RODENT$
DEVICE=C:\OS2\MDOS\VMOUSE.SYS

Summagraphics digitizers

DEVICE=C:\OS2\POINTDD.SYS
DEVICE=C:\OS2\RODENT.SYS MOUSE=SG
DEVICE=C:\OS2\MOUSE.SYS TYPE=RODENT$
DEVICE=C:\OS2\MDOS\VMOUSE.SYS

---------------------------------- Testing -----------------------------------

After booting OS/2 preliminary testing can be accomplished simply by
moving the mouse and making sure that the mouse cursor follows the movement
of the mouse. Execute RODENT.EXE to further test this device driver. This
test program will display a Presentation Manager window. It will display
the number of buttons as perceived by OS/2 and the mouse resolution as
perceived by OS/2. Further, if you click the mouse buttons, the associated
OS/2 mouse event is displayed. The most recent mouse event is flagged by
an asterisk. If the mouse pointer follows mouse movement correctly and
all buttons operate correctly then you will probably not have any trouble
with the mouse driver. Other signs of trouble might be consistently missing
mouse events (such as clicks) or events occurring without any associated
physical mouse action.

When evaluating missing or extra events reasonable care should be taken.
It has been observed that occasionally OS/2 will "lose" a mouse click during
rapid mouse activity -- this is related to the fact that OS/2 only maintains
a small mouse event queue to avoid "piling" up an extremely large number of
events. Sometimes losing a button release has the appearance of additional
clicks if an application auto-repeats while a mouse button is pressed. The
loss, by OS/2, of mouse events is VERY rare except under very heavy mouse
activity. However, it appears to be slightly more common when using higher
baud rates because the internal OS/2 queue is more likely to overflow. This
has been seen using the Logitech radio mouse at 9600 baud. Also this loss
might not actually be the fault of OS/2, but is occurring in the applications
instead (actually more probable). Nevertheless, this behavior has sometimes
been seen, both with these mouse drivers AND with the OS/2 mouse drivers.
It has been seen most often using Logitech's radio mouse and Microsoft's PWB
in a full screen session. Sometimes if this happens when scrolling releasing
the mouse button will not stop the scrolling. Simply click the mouse button
again to stop scrolling.

This is a low-level mouse driver. OS/2 handles all of the higher level
functions, including routing mouse events to DOS sessions, OS/2 sessions,
PM sessions, WIN-OS2 sessions and VMB sessions. OS/2 reports all mouse
events (in the appropriate form) to the currently active session. Therefore
DOS sessions CAN take advantage of all three buttons. Since this mouse
driver is not involved in these actions, failure of OS/2 in that manner
is probably not caused by this device driver.

Note: The resolution reported by OS/2 is in "mickeys per centimeter".
Therefore, the dots per inch provided to the device driver is divided by
2.54 and rounded when reporting to OS/2. This device driver reports the
closest value possible. For example, 400 dpi reports as 157 mickeys.
Since the value reported to OS/2 is a fixed point number, the result if
multiplied by 2.54 is only 399 (after rounding) instead of the original 400.

------------------------------------------------------------------------------