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 Xorg 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.x.org/current/mouse.html.
30
32 Please refer to xorg.conf(5) for general configuration details and for
33 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 ValuMouseScroll, AceCad, PS/2, ImPS/2, ExplorerPS/2, Think‐
51 ingMousePS/2, MouseManPlusPS/2, GlidePointPS/2, Net‐
52 MousePS/2, NetScrollPS/2, BusMouse, SysMouse, WSMouse, USB,
53 VUID, Xqueue.
54 Not all protocols are supported on all platforms. The "Auto"
56 platform specifies that protocol auto-detection should be
57 attempted. There is no default protocol setting, and specifying
58 this option is mandatory.
59 Option "Device" "string"
61 Specifies the device through which the mouse can be accessed. A
62 common setting is "/dev/mouse", which is often a symbolic link
63 to the real device. This option is mandatory, and there is no
64 default setting.
65 Option "Buttons" "integer"
67 Specifies the number of mouse buttons. In cases where the num‐
68 ber of buttons cannot be auto-detected, the default value is 3.
69 The maximum number is 24.
70 Option "Emulate3Buttons" "boolean"
72 Enable/disable the emulation of the third (middle) mouse button
73 for mice which only have two physical buttons. The third button
74 is emulated by pressing both buttons simultaneously. Default:
75 off
76 Option "Emulate3Timeout" "integer"
78 Sets the timeout (in milliseconds) that the driver waits before
79 deciding if two buttons where pressed "simultaneously" when 3
80 button emulation is enabled. Default: 50.
81 Option "ChordMiddle" "boolean"
83 Enable/disable handling of mice that send left+right events when
84 the middle button is used. Default: off.
85 Option "EmulateWheel" "boolean"
87 Enable/disable "wheel" emulation. Wheel emulation means emulat‐
88 ing button press/release events when the mouse is moved while a
89 specific real button is pressed. Wheel button events (typically
90 buttons 4 and 5) are usually used for scrolling. Wheel emula‐
91 tion is useful for getting wheel-like behaviour with trackballs.
92 It can also be useful for mice with 4 or more buttons but no
93 wheel. See the description of the EmulateWheelButton, Emulate‐
94 WheelInertia, XAxisMapping, and YAxisMapping options below.
95 Default: off.
96 Option "EmulateWheelButton" "integer"
98 Specifies which button must be held down to enable wheel emula‐
99 tion mode. While this button is down, X and/or Y pointer move‐
100 ment will generate button press/release events as specified for
101 the XAxisMapping and YAxisMapping settings. Default: 4.
102 Option "EmulateWheelInertia" "integer"
104 Specifies how far (in pixels) the pointer must move to generate
105 button press/release events in wheel emulation mode. Default:
106 10.
107 Option "EmulateWheelTimeout" "integer"
109 Specifies the time in milliseconds the EmulateWheelButton must
110 be pressed before wheel emulation is started. If the Emulate‐
111 WheelButton is released before this timeout, the original button
112 press/release event is sent. Default: 200.
113 Option "XAxisMapping" "N1 N2"
115 Specifies which buttons are mapped to motion in the X direction
116 in wheel emulation mode. Button number N1 is mapped to the neg‐
117 ative X axis motion and button number N2 is mapped to the posi‐
118 tive X axis motion. Default: no mapping.
119 Option "YAxisMapping" "N1 N2"
121 Specifies which buttons are mapped to motion in the Y direction
122 in wheel emulation mode. Button number N1 is mapped to the neg‐
123 ative Y axis motion and button number N2 is mapped to the posi‐
124 tive Y axis motion. Default: no mapping.
125 Option "ZAxisMapping" "X"
127 Option "ZAxisMapping" "Y"
129 Option "ZAxisMapping" "N1 N2"
131 Option "ZAxisMapping" "N1 N2 N3 N4"
133 Set the mapping for the Z axis (wheel) motion to buttons or
134 another axis (X or Y). Button number N1 is mapped to the nega‐
135 tive Z axis motion and button number N2 is mapped to the posi‐
136 tive Z axis motion. For mice with two wheels, four button num‐
137 bers can be specified, with the negative and positive motion of
138 the second wheel mapped respectively to buttons number N3 and
139 N4. Note that the protocols for mice with one and two wheels
140 can be different and the driver may not be able to autodetect
141 it. Default: "4 5".
142 Option "ButtonMapping" "N1 N2 [...]"
144 Specifies how physical mouse buttons are mapped to logical but‐
145 tons. Physcial button 1 is mapped to logical button N1, physi‐
146 cal button 2 to N2, and so forth. This enables the use of phys‐
147 ical buttons that are obscured by ZAxisMapping.
148 Default: "1 2 3 8 9 10 ...".
149 Option "FlipXY" "boolean"
151 Enable/disable swapping the X and Y axes. This transformation
152 is applied after the InvX, InvY and AngleOffset transformations.
153 Default: off.
154 Option "InvX" "boolean"
156 Invert the X axis. Default: off.
157 Option "InvY" "boolean"
159 Invert the Y axis. Default: off.
160 Option "AngleOffset" "integer"
162 Specify a clockwise angular offset (in degrees) to apply to the
163 pointer motion. This transformation is applied before the
164 FlipXY, InvX and InvY transformations. Default: 0.
165 Option "SampleRate" "integer"
167 Sets the number of motion/button events the mouse sends per sec‐
168 ond. Setting this is only supported for some mice, including
169 some Logitech mice and some PS/2 mice on some platforms.
170 Default: whatever the mouse is already set to.
171 Option "Resolution" "integer"
173 Sets the resolution of the device in counts per inch. Setting
174 this is only supported for some mice, including some PS/2 mice
175 on some platforms. Default: whatever the mouse is already set
176 to.
177 Option "DragLockButtons" "L1 B2 L3 B4"
179 Sets "drag lock buttons" that simulate holding a button down, so
180 that low dexterity people do not have to hold a button down at
181 the same time they move a mouse cursor. Button numbers occur in
182 pairs, with the lock button number occurring first, followed by
183 the button number that is the target of the lock button.
184 Option "DragLockButtons" "M1"
186 Sets a "master drag lock button" that acts as a "Meta Key" indi‐
187 cating that the next button pressed is to be "drag locked".
188 Option "ClearDTR" "boolean"
190 Enable/disable clearing the DTR line on the serial port used by
191 the mouse. Some dual-protocol mice require the DTR line to be
192 cleared to operate in the non-default protocol. This option is
193 for serial mice only. Default: off.
194 Option "ClearRTS" "boolean"
196 Enable/disable clearing the RTS line on the serial port used by
197 the mouse. Some dual-protocol mice require the RTS line to be
198 cleared to operate in the non-default protocol. This option is
199 for serial mice only. Default: off.
200 Option "BaudRate" "integer"
202 Set the baud rate to use for communicating with a serial mouse.
203 This option should rarely be required because the default is
204 correct for almost all situations. Valid values include: 300,
205 1200, 2400, 4800, 9600, 19200. Default: 1200.
206 There are some other options that may be used to control various param‐
208 eters for serial port communication, but they are not documented here
209 because the driver sets them correctly for each mouse protocol type.
210
212 Xorg(1), xorg.conf(5), xorgconfig(1), Xserver(1), X(7), README.mouse.
213X Version 11 xf86-input-mouse 1.2.1 MOUSE(4)