1MOUSE(4) Kernel Interfaces Manual MOUSE(4)
2
6 mouse - Mouse input driver
7
9 Section "InputDevice"
10 Identifier "idevname"
11 Driver "mouse"
12 Option "Protocol" "protoname"
13 Option "Device" "devpath"
14 ...
15 EndSection
16
18 mouse is an XFree86 input driver for mice. The driver supports most
19 available mouse types and interfaces. USB mice are only supported on
20 some OSs, and the level of support for PS/2 mice depends on the OS.
21 The mouse driver functions as a pointer input device, and may be used
23 as the X server's core pointer. Multiple mice are supported by multi‐
24 ple instances of this driver.
25
27 There is a detailed list of hardware that the mouse driver supports in
28 the README.mouse document. This can be found in /usr/lib/X11/doc/, or
29 online at http://www.xfree86.org/current/mouse.html.
30
32 Please refer to XF86Config(5x) for general configuration details and
33 for options that can be used with all input drivers. This section only
34 covers configuration details specific to this driver.
35 The driver can auto-detect the mouse type on some platforms On some
37 platforms this is limited to plug and play serial mice, and on some the
38 auto-detection works for any mouse that the OS's kernel driver sup‐
39 ports. On others, it is always necessary to specify the mouse protocol
40 in the config file. The README.mouse document contains some detailed
41 information about this.
42 The following driver Options are supported:
44 Option "Protocol" "string"
46 Specify the mouse protocol. Valid protocol types include:
47 Auto, Microsoft, MouseSystems, MMSeries, Logitech, Mouse‐
49 Man, MMHitTab, GlidePoint, IntelliMouse, ThinkingMouse,
50 AceCad, PS/2, ImPS/2, ExplorerPS/2, ThinkingMousePS/2,
51 MouseManPlusPS/2, GlidePointPS/2, NetMousePS/2,
52 NetScrollPS/2, BusMouse, SysMouse, WSMouse, USB, Xqueue.
53 Not all protocols are supported on all platforms. The "Auto"
55 platform specifies that protocol auto-detection should be
56 attempted. There is no default protocol setting, and specifying
57 this option is mandatory.
58 Option "Device" "string"
60 Specifies the device through which the mouse can be accessed. A
61 common setting is "/dev/mouse", which is often a symbolic link
62 to the real device. This option is mandatory, and there is no
63 default setting.
64 Option "Buttons" "integer"
66 Specifies the number of mouse buttons. In cases where the num‐
67 ber of buttons cannot be auto-detected, the default value is 3.
68 Option "Emulate3Buttons" "boolean"
70 Enable/disable the emulation of the third (middle) mouse button
71 for mice which only have two physical buttons. The third button
72 is emulated by pressing both buttons simultaneously. Default:
73 off
74 Option "Emulate3Timeout" "integer"
76 Sets the timeout (in milliseconds) that the driver waits before
77 deciding if two buttons where pressed "simultaneously" when 3
78 button emulation is enabled. Default: 50.
79 Option "ChordMiddle" "boolean"
81 Enable/disable handling of mice that send left+right events when
82 the middle button is used. Default: off.
83 Option "EmulateWheel" "boolean"
85 Enable/disable "wheel" emulation. Wheel emulation means emulat‐
86 ing button press/release events when the mouse is moved while a
87 specific real button is pressed. Wheel button events (typically
88 buttons 4 and 5) are usually used for scrolling. Wheel emula‐
89 tion is useful for getting wheel-like behaviour with trackballs.
90 It can also be useful for mice with 4 or more buttons but no
91 wheel. See the description of the EmulateWheelButton, Emulate‐
92 WheelInertia, XAxisMapping, and YAxisMapping options below.
93 Default: off.
94 Option "EmulateWheelButton" "integer"
96 Specifies which button must be held down to enable wheel emula‐
97 tion mode. While this button is down, X and/or Y pointer move‐
98 ment will generate button press/release events as specified for
99 the XAxisMapping and YAxisMapping settings. Default: 4.
100 Option "EmulateWheelInertia" "integer"
102 Specifies how far (in pixels) the pointer must move to generate
103 button press/release events in wheel emulation mode. Default:
104 50.
105 Option "XAxisMapping" "N1 N2"
107 Specifies which buttons are mapped to motion in the X direction
108 in wheel emulation mode. Button number N1 is mapped to the neg‐
109 ative X axis motion and button number N2 is mapped to the posi‐
110 tive X axis motion. Default: no mapping.
111 Option "YAxisMapping" "N1 N2"
113 Specifies which buttons are mapped to motion in the Y direction
114 in wheel emulation mode. Button number N1 is mapped to the neg‐
115 ative Y axis motion and button number N2 is mapped to the posi‐
116 tive Y axis motion. Default: "4 5".
117 Option "ZAxisMapping" "X"
119 Option "ZAxisMapping" "Y"
121 Option "ZAxisMapping" "N1 N2"
123 Option "ZAxisMapping" "N1 N2 N3 N4"
125 Set the mapping for the Z axis (wheel) motion to buttons or
126 another axis (X or Y). Button number N1 is mapped to the nega‐
127 tive Z axis motion and button number N2 is mapped to the posi‐
128 tive Z axis motion. For mice with two wheels, four button num‐
129 bers can be specified, with the negative and positive motion of
130 the second wheel mapped respectively to buttons number N3 and
131 N4. Default: no mapping.
132 Option "FlipXY" "boolean"
134 Enable/disable swapping the X and Y axes. This transformation
135 is applied after the InvX, InvY and AngleOffset transformations.
136 Default: off.
137 Option "InvX" "boolean"
139 Invert the X axis. Default: off.
140 Option "InvY" "boolean"
142 Invert the Y axis. Default: off.
143 Option "AngleOffset" "integer"
145 Specify a clockwise angular offset (in degrees) to apply to the
146 pointer motion. This transformation is applied before the
147 FlipXY, InvX and InvY transformations. Default: 0.
148 Option "SampleRate" "integer"
150 Sets the number of motion/button events the mouse sends per sec‐
151 ond. Setting this is only supported for some mice, including
152 some Logitech mice and some PS/2 mice on some platforms.
153 Default: whatever the mouse is already set to.
154 Option "Resolution" "integer"
156 Sets the resolution of the device in counts per inch. Setting
157 this is only supported for some mice, including some PS/2 mice
158 on some platforms. Default: whatever the mouse is already set
159 to.
160 Option "DragLockButtons" "L1 B2 L3 B4"
162 Sets "drag lock buttons" that simulate holding a button down, so
163 that low dexterity people do not have to hold a buttton down at
164 the same time they move a mouse cursor. Button numbers occur in
165 pairs, with the lock button number occurring first, followed by
166 the button number that is the target of the lock button.
167 Option "DragLockButtons" "M1"
169 Sets a "master drag lock button" that acts as a "Meta Key" indi‐
170 cating that the next button pressed is to be "drag locked".
171 Option "ClearDTR" "boolean"
173 Enable/disable clearing the DTR line on the serial port used by
174 the mouse. Some dual-protocol mice require the DTR line to be
175 cleared to operate in the non-default protocol. This option is
176 for serial mice only. Default: off.
177 Option "ClearRTS" "boolean"
179 Enable/disable clearing the RTS line on the serial port used by
180 the mouse. Some dual-protocol mice require the RTS line to be
181 cleared to operate in the non-default protocol. This option is
182 for serial mice only. Default: off.
183 Option "BaudRate" "integer"
185 Set the baud rate to use for communicating with a serial mouse.
186 This option should rarely be required because the default is
187 correct for almost all situations. Valid values include: 300,
188 1200, 2400, 4800, 9600, 19200. Default: 1200.
189 There are some other options that may be used to control various param‐
191 eters for serial port communication, but they are not documented here
192 because the driver sets them correctly for each mouse protocol type.
193
195 XFree86(1), XF86Config(5x), xf86config(1), Xserver(1), X(7),
196 README.mouse.
197X Version 11 xf86-input-vmmouse 12.4.0 MOUSE(4)