home *** CD-ROM | disk | FTP | other *** search
/ CD Actual 45 / cda45.iso / Linux / XFree86-4.0 / doc / README.mouse < prev    next >
Encoding:
Text File  |  2000-03-09  |  34.2 KB  |  930 lines
  1.                           Mouse Support in XFree86
  2.  
  3.                                Kazutaka Yokota
  4.  
  5.                                9 February 2000
  6.  
  7. 1.  Introduction
  8.  
  9. This document describes mouse support in XFree86 4.0.
  10.  
  11. Mouse configuration has often been mysterious task for novice users.  How-
  12. ever, once you learn several basics, it is straightforward to write the mouse
  13. "InputDevice" section in the XF86Config file by hand.
  14.  
  15. 2.  Supported Hardware
  16.  
  17. The XFree86 X server supports three classes of mice: serial, bus and PS/2
  18. mice.
  19.  
  20.       Serial mouse
  21.             The serial mouse has been the most popular pointing device for
  22.             PCs.  There have been numerous serial mouse models from a number
  23.             of manufactures.  Despite the wide range of variations, there
  24.             have been relatively few protocols (data format) with which the
  25.             serial mouse talks to the host computer.
  26.  
  27.             The modern serial mouse conforms to the PnP COM device specifica-
  28.             tion so that the host computer can automatically detect the mouse
  29.             and load an appropriate driver.  The XFree86 X server supports
  30.             this specification and can detect popular PnP serial mouse models
  31.             on most platforms.
  32.  
  33.       Bus mouse
  34.             The bus mouse connects to a dedicated interface card in an expan-
  35.             sion slot.  Some video cards, notably those from ATI, and inte-
  36.             grated I/O cards may also have a bus mouse connector.  Some bus
  37.             mice are known as `InPort mouse'.
  38.  
  39.             Note that some mouse manufactures have sold a package including a
  40.             serial mouse and a serial interface card.  Don't confuse this
  41.             type of products with the genuine bus mouse.
  42.  
  43.       PS/2 mouse
  44.             They are sometimes called `Mouse-port mouse'.  The PS/2 mouse is
  45.             becoming increasingly common and popular.
  46.  
  47.             The PS/2 mouse is an intelligent device and may have more than
  48.             three buttons and a wheel or a roller.  The PS/2 mouse is usually
  49.             compatible with the original PS/2 mouse from IBM immediately
  50.             after power up.  The PS/2 mouse with additional features requires
  51.             a specialized initialization procedure to enable these features.
  52.             Without proper initialization, it behaves as though it were an
  53.             ordinary two or three button mouse.
  54.  
  55.       USB mouse
  56.             USB (Universal Serial Bus) ports are present on most modern com-
  57.             puters. Several devices can be plugged into this bus, including
  58.             mices and keyboards.
  59.  
  60.             The XFree86 server includes support for USB mices on some sys-
  61.             tems.
  62.  
  63. Many mice nowadays can be used both as a serial mouse and as a PS/2 mouse.
  64. They has a logic to distinguish which interface it is connected to.  However,
  65. the mouse which is not marketed as compatible with both serial and PS/2 mouse
  66. interface lacks this logic and cannot be used in such a way, even if you can
  67. find an appropriate adapter with which you can connect the PS/2 mouse to a
  68. serial port or visa versa.
  69.  
  70. XFree86 supports the mouse with a wheel, a roller or a knob.  Its action is
  71. detected as the Z (third) axis motion of the mouse.  As the X server or
  72. clients normally do not use the Z axis movement of the pointing device, a
  73. configuration option, "ZAxisMapping", is provided to assign the Z axis move-
  74. ment to another axis or a pair of buttons (see below).
  75.  
  76. 3.  OS Support for Mice
  77.  
  78. 3.1  Summary of Supported Mouse Protocol Types
  79.  
  80.                                      Protocol Types
  81.                      serial     PnP     BusMouse    PS/2   Extended PS/2
  82.      OS platforms   protocols  serial   protocol  protocol  protocols
  83.                                "Auto"  "BusMouse"  "PS/2"   "xxxPS/2"    USB
  84.      -------------------------------------------------------------------------
  85.      BSD/OS            Ok        ?         ?         ?         ?          ?
  86.      FreeBSD           Ok        Ok        Ok        Ok        SP*1       SP*1
  87.      FreeBSD(98)       Ok        ?         Ok        NA        NA         ?
  88.      Interactive Unix  Ok        NA        ?*1       ?*1       NA         ?
  89.      Linux             Ok        Ok        Ok        Ok        Ok         ?
  90.      Linux/98          Ok        ?         Ok        NA        NA         ?
  91.      LynxOS            Ok        NA        Ok        Ok        NA         ?
  92.      NetBSD            Ok        Ok        Ok        SP*1      SP*1       SP*1
  93.      NetBSD/pc98       Ok        ?         Ok        NA        NA         NA
  94.      OpenBSD           Ok        Ok        Ok        Ok*1      Ok*1       Ok*1
  95.      OS/2              SP*2      SP*2      SP*2      SP*2      SP*2       ?
  96.      SCO               Ok        ?         SP*1      SP*1      NA         ?
  97.      Solaris 2.x       Ok        NA*1      ?*1       Ok        Ok         ?
  98.      SVR4              Ok        NA*1      SP*1      SP*1      NA         ?
  99.      PANIX             Ok        ?         SP*1      SP*1      NA         ?
  100.  
  101.      Ok: support is available,  NA: not available, ?: untested or unknown.
  102.      SP: support is available in a different form
  103.  
  104.      *1 Refer to the following sections for details.
  105.      *2 XFree86/OS2 will support any type of mouse that the OS supports,
  106.         whether it is serial, bus mouse, or PnP type.
  107.  
  108. 3.2  BSD/OS
  109.  
  110. No testing has been done with BSD/OS.
  111.  
  112. 3.3  FreeBSD
  113.  
  114. FreeBSD supports the "SysMouse" protocol which must be specified when the
  115. moused daemon is running in versions 2.2.1 or later.
  116.  
  117. When running the mouseddaemon, you must always specify the /dev/sysmouse
  118. device and the "SysMouse" protocol to the X server, regardless of the actual
  119. type of your mouse.
  120.  
  121. FreeBSD versions 2.2.6 or later include the kernel-level support for extended
  122. PS/2 mouse protocols and there is no need to specify the exact protocol name
  123. to the X server.  Instead specify the "PS/2" or "Auto" protocol and the X
  124. server will automatically make use of the kernel-level support.
  125.  
  126. In fact, "Auto" protocol support is really efficient in these versions.  You
  127. may always specify "Auto" to any mouse, serial, bus or PS/2, unless the mouse
  128. is an old serial model which doesn't support PnP.
  129.  
  130. FreeBSD versions 2.2.5 or earlier do not support extended PS/2 mouse proto-
  131. cols ("xxxPS/2").  Always specify the "PS/2" protocol for any PS/2 mouse in
  132. these versions regardless of the brand of the mouse.
  133.  
  134. FreeBSD versions 3.1 or later have support for USB mice.  Specify the "Auto"
  135. protocol for the /dev/ums0 device.  (If the moused daemon is running for the
  136. USB mouse, you must use /dev/sysmouse instead of /dev/ums0 as explained
  137. above.) See the ums(4) manual page for details.
  138.  
  139. 3.4  FreeBSD(98)
  140.  
  141. The PS/2 mouse is not supported.
  142.  
  143. 3.5  Interactive Unix
  144.  
  145. The PnP serial mouse support (the "Auto" protocol) is not supported for the
  146. moment.
  147.  
  148. The bus mouse and PS/2 mouse should be supported by using the appropriate
  149. device drivers.  Use /dev/mouse for the "BusMouse" protocol and /dev/kdmouse
  150. for the "PS/2" protocol.  These protocols are untested but may work.  Please
  151. send success/failure reports to <michael.rohleder@stadt-frankfurt.de>.
  152.  
  153. 3.6  Linux
  154.  
  155. All protocol types should work.
  156.  
  157. 3.7  Linux/98
  158.  
  159. The PS/2 mouse is not supported.
  160.  
  161. 3.8  LynxOS
  162.  
  163. The PnP serial mouse support (the "Auto" protocol) is disabled in LynxOS,
  164. because of limited TTY device driver functionality.
  165.  
  166. 3.9  NetBSD
  167.  
  168. NetBSD 1.3.x and former does not support extended PS/2 mouse protocols
  169. ("xxxPS/2").  The PS/2 mouse device driver /dev/pms emulates the bus mouse.
  170. Therefore, you should always specify the "BusMouse" protocol for any PS/2
  171. mouse regardless of the brand of the mouse.
  172.  
  173. The "wsmouse" protocol introduced in NetBSD 1.4 along with the wscons console
  174. driver is supported. You need to run binaries compiled on NetBSD 1.4 to have
  175. support for it though. Use "/dev/wsmouse0" for the device. Refer to the
  176. wsmouse(4) manual page for kernel configuration informations.
  177.  
  178. This driver also provides support for USB mices. See the ums(4) manual page
  179. for details.
  180.  
  181. 3.10  NetBSD/pc98
  182.  
  183. The PS/2 mouse is not supported.
  184.  
  185. 3.11  OpenBSD
  186.  
  187. The raw PS/2 mouse device driver /dev/psm0 uses the raw PS/2 mouse protocol.
  188.  
  189. OpenBSD 2.2 and earlier does not support extended PS/2 mouse protocols
  190. ("xxxPS/2") .  Therefore, you should specify the "PS/2" protocol for any PS/2
  191. mouse regardless of the brand of the mouse.
  192.  
  193. OpenBSD 2.3 and later support all extended PS/2 mouse protocols.  You can
  194. select the "Auto" protocol for PnP PS/2 mice or any specific extended
  195. ("xxxPS/2") protocol for non PnP mice.
  196.  
  197. There is also a cooked PS/2 mouse device driver /dev/pms0 which emulates the
  198. bus mouse.  Specify the "BusMouse" protocol for any PS/2 mouse regardless of
  199. the brand of the mouse when using this device.
  200.  
  201. XFree86 3.3.6 support USB mices on OpenBSD 2.6 and later though the generic
  202. Human Interface Device (hid) /dev/uhid*. Select the "usb" protocol and the
  203. /dev/uhid* instance corresponding to your mouse as the device name.
  204.  
  205. 3.12  OS/2
  206.  
  207. XFree86/OS2 always uses the native mouse driver of the operating system and
  208. will support any type of pointer that the OS supports, whether it is serial,
  209. bus mouse, or PnP type.  If the mouse works under Presentation Manager, it
  210. will also work under XFree86/OS2.
  211.  
  212. Always specify "OSMouse" as the protocol type.
  213.  
  214. 3.13  SCO
  215.  
  216. The bus and PS/2 mouse are supported with the "OSMouse" protocol type.
  217.  
  218. The "OSMouse" may also be used with the serial mouse.
  219.  
  220. 3.14  Solaris
  221.  
  222. Testing has been done with Solaris 2.5.1 and 2.6.  Logitech and Microsoft bus
  223. mice have not been tested, but might work with the /dev/logi and /dev/msm
  224. devices.  Standard 2 and 3 button PS/2 mice work with the "PS/2" protocol
  225. type and the /dev/kdmouse device.  The PnP serial mouse support (the "Auto"
  226. protocol) has been tested and does not work.
  227.  
  228. 3.15  SVR4
  229.  
  230. The bus and PS/2 mouse may be supported with the "Xqueue" protocol type.
  231.  
  232. The "Xqueue" may also be used with the serial mouse.
  233.  
  234. The PnP serial mouse support (the "Auto" protocol) is not tested.
  235.  
  236. 3.16  PANIX
  237.  
  238. The PC/AT version of PANIX supports the bus and PS/2 mouse with the "Xqueue"
  239. protocol type.  The PC-98 version of PANIX supports the bus mouse with the
  240. "Xqueue" protocol type.
  241.  
  242. 4.  Configuring Your Mouse
  243.  
  244. Before using the xf86config program to set up mouse configuration, you must
  245. identify the interface type, the device name and the protocol type of your
  246. mouse.  Blindly trying every possible combination of mouse settings will lead
  247. you nowhere.
  248.  
  249. The first thing you need to know is the interface type of the mouse you are
  250. going to use.  It can be determined by looking at the connector of the mouse.
  251. The serial mouse has a D-Sub female 9- or 25-pin connector.  The bus mice
  252. have either a D-Sub male 9-pin connector or a round DIN 9-pin connector.  The
  253. PS/2 mouse is equipped with a small, round DIN 6-pin connector.  Some mice
  254. come with adapters with which the connector can be converted to another.  If
  255. you are to use such an adapter, remember that the connector at the very end
  256. of the mouse/adapter pair is what matters.
  257.  
  258. The next thing to decide is a device node to use for the given interface.
  259. For the bus and PS/2 mice, there is little choice; your OS most possibly
  260. offers just one device node each for the bus mouse and PS/2 mouse.  There may
  261. be more than one serial port to which the serial mouse can be attached.
  262.  
  263. The next step is to guess the appropriate protocol type for the mouse.  The X
  264. server may be able to select a protocol type for the given mouse automati-
  265. cally in some cases.  Otherwise, the user has to choose one manually.  Follow
  266. the guidelines below.
  267.  
  268.       Bus mouse
  269.             The bus and InPort mice always use "BusMouse" protocol regardless
  270.             of the brand of the mouse.
  271.  
  272.             Some OSs may allow you to specify "Auto" as the protocol type for
  273.             the bus mouse.
  274.  
  275.       PS/2 mouse
  276.             The "PS/2" protocol should always be tried first for the PS/2
  277.             mouse regardless of the brand of the mouse.  Any PS/2 mouse
  278.             should work with this protocol type, although wheels and other
  279.             additional features are unavailable in the X server.
  280.  
  281.             After verifying the mouse works with this protocol, you may
  282.             choose to specify one of "xxxPS/2" protocols so that extra fea-
  283.             tures are made available in the X server.  However, support for
  284.             these PS/2 mice assumes certain behavior of the underlying OS and
  285.             may not always work as expected.  Support for some PS/2 mouse
  286.             models may be disabled all together for some OS platforms for
  287.             this reason.
  288.  
  289.             Some OSs may allow you to specify "Auto" as the protocol type for
  290.             the PS/2 mouse and the X server will automatically adjust itself.
  291.  
  292.       Serial mouse
  293.             The XFree86 server supports a wide range of mice, both old and
  294.             new.  If your mouse is of a relatively new model, it may conform
  295.             to the PnP COM device specification and the X server may be able
  296.             to detect an appropriate protocol type for the mouse automati-
  297.             cally.
  298.  
  299.             Specify "Auto" as the protocol type and start the X server.  If
  300.             the mouse is not a PnP mouse, or the X server cannot determine a
  301.             suitable protocol type, the server will print the following error
  302.             message and abort.
  303.  
  304.                  <mousename>: cannot determine the mouse protocol
  305.  
  306.             If the X server generates the above error message, you need to
  307.             manually specify a protocol type for your mouse.  Choose one from
  308.             the following list:
  309.  
  310.                o GlidePoint
  311.  
  312.                o IntelliMouse
  313.  
  314.                o Logictech
  315.  
  316.                o Microsoft
  317.  
  318.                o MMHittab
  319.  
  320.                o MMSeries
  321.  
  322.                o MouseMan
  323.  
  324.                o MouseSystems
  325.  
  326.                o ThinkingMouse
  327.  
  328.             When you choose, keep in mind the following rule of thumb:
  329.  
  330.               1.  "Logitech" protocol is for old serial mouse models from
  331.                   Logitech.  Modern Logitech mice use either "MouseMan" or
  332.                   "Microsoft" protocol.
  333.  
  334.               2.  Most 2-button serial mice support the "Microsoft" protocol.
  335.  
  336.               3.  3-button serial mice may work with the "Mousesystems" pro-
  337.                   tocol. If it doesn't, it may work instead with the
  338.                   "Microsoft" protocol although the third (middle) button
  339.                   won't function.  3-button serial mice may also work with
  340.                   the "Mouseman" protocol under which the third button may
  341.                   function as expected.
  342.  
  343.               4.  3-button serial mice may have a small switch at the bottom
  344.                   of the mouse to choose between ``MS'' and ``PC'', or ``2''
  345.                   and ``3''.  ``MS'' or ``2'' usually mean the "Microsoft"
  346.                   protocol.  ``PC'' or ``3'' will choose the "MouseSystems"
  347.                   protocol.
  348.  
  349.               5.  If the serial mouse has a roller or a wheel, it may be com-
  350.                   patible with the "IntelliMouse" protocol.
  351.  
  352.               6.  If the serial mouse has a roller or a wheel and it doesn't
  353.                   work with the "IntelliMouse" protocol, you have to use it
  354.                   as a regular 2- or 3-button serial mouse.
  355.  
  356.             If the "Auto" protocol is specified and the mouse seems working,
  357.             but you find that not all features of the mouse is available,
  358.             that is because the X server does not have native support for
  359.             that model of mouse and is using a ``compatible'' protocol
  360.             according to PnP information.
  361.  
  362.             If you suspect this is the case with your mouse, please send a
  363.             report to <XFree86@XFree86.Org>.
  364.  
  365.       USB mouse
  366.             If your mouse is connected to the USB port, it can either be sup-
  367.             ported by the "Auto" protocol, or by an OS-specific protocol (see
  368.             below), or as a generic Human Interface Device by the "usb" pro-
  369.             tocol.
  370.  
  371.       Standardized protocols
  372.             Mouse device drivers in your OS may use the standardized protocol
  373.             regardless of the model or the class of the mouse.  For example,
  374.             SVR4 systems may support "Xqueue" protocol.  In FreeBSD the sys-
  375.             tem mouse device /dev/sysmouse uses the "SysMouse" protocol.
  376.             Please refer to the OS support section of this file for more
  377.             information.
  378.  
  379. 5.  XF86Config Options
  380.  
  381. The old Pointer section has been replaced by a more general InputDevice sec-
  382. tion.  The following is a minimal example of an InputDevice section for a
  383. mouse:
  384.  
  385.      Section "InputDevice"
  386.           Identifier     "Mouse 1"
  387.           Driver         "mouse"
  388.           Option         "Device"  "/dev/mouse"
  389.           Option         "Protocol"     "Auto"
  390.      EndSection
  391.  
  392. The mouse driver supports the following config file options:
  393.  
  394. 5.1  Buttons
  395.  
  396. This option tells the X server the number of buttons on the mouse.  Currently
  397. there is no reliable way to automatically detect the correct number.  This
  398. option is the only means for the X server to obtain it.  The default value is
  399. three.
  400.  
  401. Note that if you intend to assign Z axis movement to button events using the
  402. ZAxisMapping option below, you need to take account of those buttons into N
  403. too.
  404.  
  405.           Option    "Buttons" "N"
  406.  
  407. 5.2  ZAxisMappping
  408.  
  409. This option maps the Z axis (wheel) motion to buttons or to another axis.
  410.  
  411.           Option    "ZAxisMapping" "X"
  412.           Option    "ZAxisMapping" "Y"
  413.           Option    "ZAxisMapping" "N1 N2"
  414.           Option    "ZAxisMapping" "N1 N2 N3 N4"
  415.  
  416. The first example will map the Z axis motion to the X axis motion.  Whenever
  417. the user moves the wheel/roller, its movement is reported as the X axis
  418. motion.  When the wheel/roller stays still, the real X axis motion is
  419. reported as is.  The third example will map negative Z axis motion to the
  420. button N1 and positive Z axis motion to the button N2.  If this option is
  421. used and the buttons N1 or N2 actually exists in the mouse, their actions
  422. won't be detected by the X server.
  423.  
  424. The last example is useful for the mouse with two wheels of which the second
  425. wheel is used to generate horizontal scroll action, and the mouse which has a
  426. knob or a stick which can detect the horizontal force applied by the user.
  427. The motion of the second wheel will be mapped to the buttons N3, for the neg-
  428. ative direction, and N4, for the positive direction.  If the buttons N3 and
  429. N4 actually exist in this mouse, their actions won't be detected by the X
  430. server.
  431.  
  432. NOTE #1: horizontal movement may not always be detected by the current ver-
  433. sion of the XFree86 X servers, because there appears to be no accepted stan-
  434. dard as to how the horizontal direction is encoded in mouse data.
  435.  
  436. NOTE #2: Some mice think left is the negative horizontal direction, others
  437. may think otherwise.  Moreover, there are some mice whose two wheels are both
  438. mounted vertically, and the direction of the second vertical wheel does not
  439. match the first one's.
  440.  
  441. Currently this option can not be set in the XF86Setup program.  You need to
  442. edit the XF86Config file by hand to add this option.
  443.  
  444. 5.3  Resolution
  445.  
  446. The following option will set the mouse device resolution to N counts per
  447. inch, if possible:
  448.  
  449.           Option    "Resolution"   "N"
  450.  
  451. Not all mice and OSs can support this option.  This option can be set in the
  452. XF86Setup program.
  453.  
  454. 6.  Mouse Gallery
  455.  
  456. In all of the examples below, it is assumed that /dev/mouse is a link to the
  457. appropriate serial port or PS/2 mouse device.
  458.  
  459. 6.1  MS IntelliMouse  (serial, PS/2)
  460.  
  461. This mouse has a wheel which also acts as the button 2 (middle button).  The
  462. wheel movement is recognized as the Z axis motion.  This behavior is not com-
  463. patible with XFree86 versions prior to 3.3.2, but is more consistent with the
  464. support for other mice with wheels or rollers.  If you want to make the wheel
  465. behave like before, you can use the "ZAxisMapping" option as described above.
  466.  
  467. IntelliMouse supports the PnP COM device specification.
  468.  
  469. To use this mouse as a serial device:
  470.  
  471.           Option    "Protocol"     "Auto"
  472.  
  473. or:
  474.  
  475.           Option    "Protocol"     "IntelliMouse"
  476.  
  477. To use this mouse as the PS/2 device and the OS supports PS/2 mouse initial-
  478. ization:
  479.  
  480.           Option    "Protocol"     "IMPS/2"
  481.  
  482. To use this mouse as the PS/2 device but the OS does not support PS/2 mouse
  483. initialization (the wheel won't work in this case):
  484.  
  485.           Option    "Protocol"     "PS/2"
  486.  
  487. To use this mouse as the PS/2 device and the OS supports automatic PS/2 mouse
  488. detection:
  489.  
  490.           Option    "Protocol"     "Auto"
  491.  
  492. 6.2  MS IntelliMouse Explorer (PS/2, USB)
  493.  
  494. This mouse has a wheel which also acts as the button 2 (middle button).
  495. There are two side buttons; they are recognized as the buttons 4 and 5.  The
  496. wheel movement is recognized as the Z axis motion.
  497.  
  498. To use this mouse as the PS/2 device and the OS supports PS/2 mouse initial-
  499. ization:
  500.  
  501.           Option    "Protocol"     "ExplorerPS/2"
  502.  
  503. To use this mouse as the PS/2 device but the OS does not support PS/2 mouse
  504. initialization (the wheel and the side buttons won't work in this case):
  505.  
  506.           Option    "Protocol"     "PS/2"
  507.  
  508. To use this mouse as the PS/2 device and the OS supports automatic PS/2 mouse
  509. detection:
  510.  
  511.           Option    "Protocol"     "Auto"
  512.  
  513. To use this mouse as the USB device and the OS supports the generic HID pro-
  514. tocol:
  515.  
  516.           Option    "Protocol"     "usb"
  517.  
  518. To use this mouse as the USB device and the OS supports automatic mouse
  519. detection:
  520.  
  521.           Option    "Protocol"     "Auto"
  522.  
  523. 6.3  Kensington Thinking Mouse (serial, PS/2)
  524.  
  525. This mouse has four buttons.  Thinking Mouse supports the PnP COM device
  526. specification.
  527.  
  528. To use this mouse as a serial device:
  529.  
  530.           Option    "Protocol"     "Auto"
  531.  
  532. or:
  533.  
  534.           Option    "Protocol"     "ThinkingMouse"
  535.  
  536. To use this mouse as the PS/2 device and the OS supports PS/2 mouse initial-
  537. ization:
  538.  
  539.           Option    "Protocol"     "ThinkingMousePS/2"
  540.  
  541. To use this mouse as the PS/2 device but the OS does not support PS/2 mouse
  542. initialization (the third and the fourth buttons act as though they were the
  543. first and the second buttons):
  544.  
  545.           Option    "Protocol"     "PS/2"
  546.  
  547. To use this mouse as the PS/2 device and the OS supports automatic PS/2 mouse
  548. detection:
  549.  
  550.           Option    "Protocol"     "Auto"
  551.  
  552. 6.4  Genius NetScroll (PS/2)
  553.  
  554. This mouse has four buttons and a roller.  The roller movement is recognized
  555. as the Z axis motion.
  556.  
  557. To use this mouse as the PS/2 device and the OS supports PS/2 mouse initial-
  558. ization:
  559.  
  560.           Option    "Protocol"     "NetScrollPS/2"
  561.  
  562. To use this mouse as the PS/2 device but the OS does not support PS/2 mouse
  563. initialization (the roller and the fourth button won't work):
  564.  
  565.           Option    "Protocol"     "PS/2"
  566.  
  567. To use this mouse as the PS/2 device and the OS supports automatic PS/2 mouse
  568. detection:
  569.  
  570.           Option    "Protocol"     "Auto"
  571.  
  572. 6.5  Genius NetMouse and NetMouse Pro (serial, PS/2)
  573.  
  574. These mice have a "magic button" which is used like a wheel or a roller.  The
  575. "magic button" action is recognized as the Z axis motion.  NetMouse Pro is
  576. identical to NetMouse except that it has the third button on the left hand
  577. side.
  578.  
  579. NetMouse and NetMouse Pro support the PnP COM device specification.  When
  580. used as a serial mouse, they are compatible with MS IntelliMouse.
  581.  
  582. To use these mice as a serial device:
  583.  
  584.           Option    "Protocol"     "Auto"
  585.  
  586. or:
  587.  
  588.           Option    "Protocol"     "IntelliMouse"
  589.  
  590. To use this mouse as the PS/2 device and the OS supports PS/2 mouse initial-
  591. ization:
  592.  
  593.           Option    "Protocol"     "NetMousePS/2"
  594.  
  595. To use this mouse as the PS/2 device but the OS does not support PS/2 mouse
  596. initialization (the "magic button" and the third button won't work):
  597.  
  598.           Option    "Protocol"     "PS/2"
  599.  
  600. To use this mouse as the PS/2 device and the OS supports automatic PS/2 mouse
  601. detection:
  602.  
  603.           Option    "Protocol"     "Auto"
  604.  
  605. 6.6  Genius NetScroll Optical (PS/2, USB)
  606.  
  607. This mouse has a wheel which also acts as the button 2 (middle button), and
  608. two side buttons which are recognized as the buttons 4 and 5.  It is compati-
  609. ble with NetMouse and NetMouse Pro.
  610.  
  611. To use this mouse as the PS/2 device and the OS supports PS/2 mouse initial-
  612. ization:
  613.  
  614.           Option    "Protocol"     "NetMousePS/2"
  615.  
  616. To use this mouse as the PS/2 device but the OS does not support PS/2 mouse
  617. initialization (the wheel and the side buttons won't work):
  618.  
  619.           Option    "Protocol"     "PS/2"
  620.  
  621. To use this mouse as the PS/2 device and the OS supports automatic PS/2 mouse
  622. detection:
  623.  
  624.           Option    "Protocol"     "Auto"
  625.  
  626. To use this mouse as the USB device and the OS supports the generic HID pro-
  627. tocol:
  628.  
  629.           Option    "Protocol"     "usb"
  630.  
  631. To use this mouse as the USB device and the OS supports automatic mouse
  632. detection:
  633.  
  634.           Option    "Protocol"     "Auto"
  635.  
  636. 6.7  ALPS GlidePoint (serial, PS/2)
  637.  
  638. The serial version of this pad device has been supported since XFree86 3.2.
  639. `Tapping' action is interpreted as the fourth button press.  (IMHO, the
  640. fourth button of GlidePoint should always be mapped to the first button in
  641. order to make this pad behave like the other pad products.)
  642.  
  643. To use this pad as a serial device:
  644.  
  645.           Option    "Protocol"     "GlidePoint"
  646.  
  647. To use this mouse as the PS/2 device and the OS supports PS/2 mouse initial-
  648. ization:
  649.  
  650.           Option    "Protocol"     "GlidePointPS/2"
  651.  
  652. To use this mouse as the PS/2 device but the OS does not support PS/2 mouse
  653. initialization:
  654.  
  655.           Option    "Protocol"     "PS/2"
  656.  
  657. To use this mouse as the PS/2 device and the OS supports automatic PS/2 mouse
  658. detection:
  659.  
  660.           Option    "Protocol"     "Auto"
  661.  
  662. 6.8  ASCII MieMouse (serial, PS/2)
  663.  
  664. This mouse appears to be OEM from Genius.  Although its shape is quite dif-
  665. ferent, it works like Genius NetMouse Pro.  This mouse has a "knob" which is
  666. used like a wheel or a roller.  The "knob" action is recognized as the Z axis
  667. motion.
  668.  
  669. MieMouse supports the PnP COM device specification.  When used as a serial
  670. mouse, it is compatible with MS IntelliMouse.
  671.  
  672. To use this mouse as a serial device:
  673.  
  674.           Option    "Protocol"     "Auto"
  675.  
  676. or:
  677.  
  678.           Option    "Protocol"     "IntelliMouse"
  679.  
  680. To use this mouse as the PS/2 device and the OS supports PS/2 mouse initial-
  681. ization:
  682.  
  683.           Option    "Protocol"     "NetMousePS/2"
  684.  
  685. To use this mouse as the PS/2 device but the OS does not support PS/2 mouse
  686. initialization (the knob and the third button won't work):
  687.  
  688.           Option    "Protocol"     "PS/2"
  689.  
  690. To use this mouse as the PS/2 device and the OS supports automatic PS/2 mouse
  691. detection:
  692.  
  693.           Option    "Protocol"     "Auto"
  694.  
  695. 6.9  Logitech MouseMan+ and FirstMouse+ (serial, PS/2)
  696.  
  697. MouseMan+ has two buttons on top, one side button and a roller.  FirstMouse+
  698. has two buttons and a roller.  The roller movement is recognized as the Z
  699. axis motion.  The roller also acts as the third button.  The side button is
  700. recognized as the fourth button.
  701.  
  702. MouseMan+ and FirstMouse+ support the PnP COM device specification.  They
  703. have MS IntelliMouse compatible mode when used as a serial mouse.
  704.  
  705. To use these mice as a serial device:
  706.  
  707.           Option    "Protocol"     "Auto"
  708.  
  709. or:
  710.  
  711.           Option    "Protocol"     "IntelliMouse"
  712.  
  713. To use this mouse as the PS/2 device and the OS supports PS/2 mouse initial-
  714. ization:
  715.  
  716.           Option    "Protocol"     "MouseManPlusPS/2"
  717.  
  718. To use this mouse as the PS/2 device but the OS does not support PS/2 mouse
  719. initialization (the wheel and the fourth button won't work):
  720.  
  721.           Option    "Protocol"     "PS/2"
  722.  
  723. To use this mouse as the PS/2 device and the OS supports automatic PS/2 mouse
  724. detection:
  725.  
  726.           Option    "Protocol"     "Auto"
  727.  
  728. 6.10  IBM ScrollPoint (PS/2)
  729.  
  730. ScrollPoint has a "stick" in between the two buttons.  This "stick" is the
  731. same as the stick-shaped pointing device often found on notebook computers,
  732. on which you move the mouse cursor by pushing the stick.  The stick movement
  733. is recognized as the Z axis motion.  You can push the stick to right and
  734. left, as well as forward and backward.  Give four numbers to ZAxisMapping
  735. option to map movement along all these four directions to button actions.
  736.  
  737. This mouse is compatible with Logitech MouseMan+.  To use this mouse as the
  738. PS/2 device and the OS supports PS/2 mouse initialization:
  739.  
  740.           Option    "Protocol"     "MouseManPlusPS/2"
  741.  
  742. To use this mouse as the PS/2 device but the OS does not support PS/2 mouse
  743. initialization (the stick won't work):
  744.  
  745.           Option    "Protocol"     "PS/2"
  746.  
  747. To use this mouse as the PS/2 device and the OS supports automatic PS/2 mouse
  748. detection:
  749.  
  750.           Option    "Protocol"     "Auto"
  751.  
  752. 6.11  8D ScrollMouse (serial, PS/2)
  753.  
  754. ScrollMouse, also known as GyroMouse, has a "stick" similar to IBM Scroll-
  755. Point.  The stick movement is recognized as the Z axis motion.  You can push
  756. the stick to right and left, as well as forward and backward.  Give four num-
  757. bers to ZAxisMapping option to map movement along all these four directions
  758. to button actions.
  759.  
  760. ScrollMouse supports the PnP COM device specification.  When used as a serial
  761. mouse, it is compatible with MS IntelliMouse.
  762.  
  763. To use this mouse as a serial device:
  764.  
  765.           Option    "Protocol"     "Auto"
  766.  
  767. or:
  768.  
  769.           Option    "Protocol"     "IntelliMouse"
  770.  
  771. To use this mouse as the PS/2 device and the OS supports PS/2 mouse initial-
  772. ization:
  773.  
  774.           Option    "Protocol"     "IMPS/2"
  775.  
  776. To use this mouse as the PS/2 device but the OS does not support PS/2 mouse
  777. initialization (the stick won't work):
  778.  
  779.           Option    "Protocol"     "PS/2"
  780.  
  781. To use this mouse as the PS/2 device and the OS supports automatic PS/2 mouse
  782. detection:
  783.  
  784.           Option    "Protocol"     "Auto"
  785.  
  786. 6.12  A4 Tech 4D mice (serial, PS/2, USB)
  787.  
  788. A4 Tech produces quit a number of mice with one or two wheels.  Their mice
  789. may have 2, 3, or 4 buttons.  The wheels movement is recognized as the Z axis
  790. motion.  Give four numbers to ZAxisMapping option to map movement of both
  791. wheels to button actions.
  792.  
  793. 4D mice support the PnP COM device specification.  When used as a serial
  794. mouse, it is compatible with MS IntelliMouse.
  795.  
  796. To use this mouse as a serial device:
  797.  
  798.           Option    "Protocol"     "Auto"
  799.  
  800. or:
  801.  
  802.           Option    "Protocol"     "IntelliMouse"
  803.  
  804. To use this mouse as the PS/2 device and the OS supports PS/2 mouse initial-
  805. ization:
  806.  
  807.           Option    "Protocol"     "IMPS/2"
  808.  
  809. To use this mouse as the PS/2 device but the OS does not support PS/2 mouse
  810. initialization (the wheels won't work):
  811.  
  812.           Option    "Protocol"     "PS/2"
  813.  
  814. To use this mouse as the PS/2 device and the OS supports automatic PS/2 mouse
  815. detection:
  816.  
  817.           Option    "Protocol"     "Auto"
  818.  
  819. To use this mouse as the USB device and the OS supports the generic HID pro-
  820. tocol:
  821.  
  822.           Option    "Protocol"     "usb"
  823.  
  824. To use this mouse as the USB device and the OS supports automatic mouse
  825. detection:
  826.  
  827.           Option    "Protocol"     "Auto"
  828.  
  829. 7.  Configuration Examples
  830.  
  831. This section shows some example InputDevice section for popular mice.  All
  832. the examples assume that the mouse is connected to the PS/2 mouse port, and
  833. the OS supports the PS/2 mouse initialization.  It is also assumed that
  834. /dev/mouse is a link to the PS/2 mouse port.
  835.  
  836. Logitech MouseMan+ has 4 buttons and a wheel.  The following example makes
  837. the wheel movement available as the button 5 and 6.
  838.  
  839.      Section "InputDevice"
  840.           Identifier     "MouseMan+"
  841.           Driver         "mouse"
  842.           Option         "Device"  "/dev/mouse"
  843.           Option         "Protocol"     "MouseManPlusPS/2"
  844.           Option         "Buttons" "6"
  845.           Option         "ZAxisMapping" "5 6"
  846.      EndSection
  847.  
  848. You can change button number assignment using the xmodmap command AFTER you
  849. start the X server with the above configuration.  You may not like to use the
  850. wheel as the button 2 and rather want the side button (button 4) act like the
  851. button 2.  You may also want to map the wheel movement to the button 4 and 5.
  852. This can be done by the following command:
  853.  
  854.           xmodmap -e "pointer = 1 6 3 2 4 5"
  855.  
  856. After this command is run, the correspondence between the buttons and button
  857. numbers will be as shown in the following table.
  858.  
  859.      Physical Buttons    Reported as:
  860.      ------------------------------------
  861.      1 Left Button         Button 1
  862.      2 Wheel Button        Button 6
  863.      3 Right Button        Button 3
  864.      4 Side Button         Button 2
  865.      5 Wheel Negative Move      Button 4
  866.      6 Wheel Positive Move      Button 5
  867.  
  868. For the MS IntelliMouse Explorer which as a wheel and 5 buttons, you may have
  869. the following InputDevice section.
  870.  
  871.      Section "InputDevice"
  872.           Identifier     "IntelliMouse Explorer"
  873.           Driver         "mouse"
  874.           Option         "Device"  "/dev/mouse"
  875.           Option         "Protocol"     "ExplorerPS/2"
  876.           Option         "Buttons" "7"
  877.           Option         "ZAxisMapping" "6 7"
  878.      EndSection
  879.  
  880. The IntelliMouse Explorer has 5 buttons, thus, you should give "7" to the
  881. Buttons option if you want to map the wheel movement to buttons (6 and 7).
  882. With this configuration, the correspondence between the buttons and button
  883. numbers will be as follows:
  884.  
  885.      Physical Buttons    Reported as:
  886.      ------------------------------------
  887.      1 Left Button         Button 1
  888.      2 Wheel Button        Button 2
  889.      3 Right Button        Button 3
  890.      4 Side Button 1            Button 4
  891.      5 Side Button 2            Button 5
  892.      6 Wheel Negative Move      Button 6
  893.      7 Wheel Positive Move      Button 7
  894.  
  895. You can change button number assignment using xmodmap AFTER you started the X
  896. server with the above configuration.
  897.  
  898.           xmodmap -e "pointer = 1 2 3 4 7 5 6"
  899.  
  900. The above command will moves the side button 2 to the button 7 and make the
  901. wheel movement reported as the button 5 and 6.  See the table below.
  902.  
  903.      Physical Buttons    Reported as:
  904.      ------------------------------------
  905.      1 Left Button         Button 1
  906.      2 Wheel Button        Button 2
  907.      3 Right Button        Button 3
  908.      4 Side Button 1            Button 4
  909.      5 Side Button 2            Button 7
  910.      6 Wheel Negative Move      Button 5
  911.      7 Wheel Positive Move      Button 6
  912.  
  913. For the A4 Tech WinEasy mouse which has two wheels and 3 buttons, you may
  914. have the following InputDevice section.
  915.  
  916.      Section "InputDevice"
  917.           Identifier     "WinEasy"
  918.           Driver         "mouse"
  919.           Option         "Device"  "/dev/mouse"
  920.           Option         "Protocol"     "IMPS/2"
  921.           Option         "Buttons" "7"
  922.           Option         "ZAxisMapping" "4 5 6 7"
  923.      EndSection
  924.  
  925. The movement of the first wheel is mapped to the button 4 and 5.  The second
  926. wheel's movement will be reported as the buttons 6 and 7.
  927.  
  928.      Generated from XFree86: xc/programs/Xserver/hw/xfree86/doc/sgml/mouse.sgml,v 1.11 2000/03/01 00:25:23 dawes Exp $
  929.  
  930.