summaryrefslogtreecommitdiff
path: root/README
blob: 0a651ac46188c2ce262cc1a62cd7c09ef92cbcf4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
Synaptics TouchPad driver for XFree86
-------------------------------------

Introduction
------------

This is a driver for the Synaptics TouchPad for XFree86 4.x. A
Synaptics touchpad by default operates in compatibility mode by
emulating a standard mouse. However, by using a dedicated driver, more
advance features of the touchpad becomes available, such as:

- Movement with adjustable, non-linear acceleration and speed.
- Button events through short touching of the touchpad.
- Double-Button events through double short touching of the touchpad.
- Dragging through short touching and holding down the finger on the
  touchpad.
- Middle and right button events on the upper and lower corner of
  the touchpad.
- Vertical scrolling (button four and five events) through moving
  the finger on the right side of the touchpad.
- The up/down button sends button four/five events.
- Horizontal scrolling (button six and seven events) through moving
  the finger on the lower side of the touchpad.
- The multi-buttons send button four/five events, and six/seven
  events for horizontal scrolling.
- Adjustable finger detection.
- Multifinger taps: two finger for middle button and three finger
  for right button events. (Needs hardware support. Not all models
  implement this feature.)
- Run-time configuration using shared memory. This means you can
  change parameter settings without restarting the X server.

Note that depending on the touchpad firmware, some of these features
might be available even without using the synaptics driver. Note also
that some functions are not available on all touchpad models, because
they need support from the touchpad hardware/firmware. (Multifinger
taps for example.)


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

See the INSTALL file for detailed installation instructions.


Compatibility
-------------

The driver has been reported to work on a number of different laptop
computers. See the COMPATIBILITY file for the list. If your computer
is not listed, please let me (petero2@telia.com) know if the driver
works on your computer.


Parameters
----------

The driver behavior can be configured with parameters. These
parameters are options in the InputDevice section in the XFree86
config file. See the INSTALL file for a working example. If you have
the SHMConfig parameter enabled, these parameters can also be changed
at runtime with the synclient program.

Parameter:		Type:   Description:

Device			String	Synaptics device
Protocol		String	"auto-dev" (automatic, default), "psaux" (raw) or
				"event" (linux 2.5 kernel events)
SHMConfig		Bool	switch on/off shared memory for configuration
LeftEdge		Int	coordinates for left edge
RightEdge		Int	coordinates for right edge
TopEdge			Int	coordinates for top edge
BottomEdge		Int	coordinates for bottom edge
FingerLow		Int	When finger pressure drops below this value, the
				driver counts it as a release.
FingerHigh		Int	When finger pressure goes above this value, the
				driver counts it as a touch.
MaxTapTime		Int	max. time (in milliseconds) for detecting a tap
MaxTapMove		Int	max. movement of the finger for detecting a tap
VertScrollDelta		Int	move distance of the finger for a scroll event
HorizScrollDelta	Int	move distance of the finger for a scroll event
EdgeMotionSpeed		Int	edge motion speed when dragging
Repeater		String	repeater device
MinSpeed		Float	min. Speed factor
MaxSpeed		Float	max. Speed factor
AccelFactor		Float	acceleration factor
UpDownScrolling		Bool	If on, the up/down buttons generate button 4/5 events.
				If off, the up button generates a double click and
				the down button generates a button 2 event.
EmulateMidButtonTime	Int	max time (in milliseconds) for middle button emulation.
TouchpadOff		Bool	If on, the Touchpad is switched off (useful
				if an external mouse is connected)
LockedDrags		Bool	If off, a tap and drag gesture ends when you release
				the finger. If on, the gesture is active until you
				tap a second time.
RTCornerButton		Int	Which mouse button is reported on a right top corner tap
				0=No action, 1=Left Button, 2=Middle Button, 3=Right Button
RBCornerButton		Int	Which mouse button is reported on a right bottom corner tap
				0=No action, 1=Left Button, 2=Middle Button, 3=Right Button
LTCornerButton		Int	Which mouse button is reported on a left top corner tap
				0=No action, 1=Left Button, 2=Middle Button, 3=Right Button
LBCornerButton		Int	Which mouse button is reported on a left bottom corner tap
				0=No action, 1=Left Button, 2=Middle Button, 3=Right Button
TapButton1		Int	Which mouse button is reported on a non-corner one-finger tap
				0=No action, 1=Left Button, 2=Middle Button, 3=Right Button
TapButton2		Int	Which mouse button is reported on a non-corner two-finger tap
				0=No action, 1=Left Button, 2=Middle Button, 3=Right Button
TapButton3		Int	Which mouse button is reported on a non-corner three-finger tap
				0=No action, 1=Left Button, 2=Middle Button, 3=Right Button

A tap event happens when the finger is touched and released in a time
interval shorter than MaxTapTime, and the touch and release
coordinates are less than MaxTapMove units apart. A "touch" event
happens when the Z value goes above FingerHigh, and an "untouch" event
happens when the Z value goes below FingerLow.

The MinSpeed, MaxSpeed and AccelFactor parameters control the pointer
motion speed. The speed value defines the scaling between touchpad
coordinates and screen coordinates. When moving the finger very
slowly, the MinSpeed value is used, when moving very fast the MaxSpeed
value is used. When moving the finger at moderate speed, you get a
pointer motion speed somewhere between MinSpeed and MaxSpeed. If you
don't want any acceleration, set MinSpeed and MaxSpeed to the same
value.

The MinSpeed, MaxSpeed and AccelFactor parameters don't have any
effect on scrolling speed. Scrolling speed is determined solely from
the VertScrollDelta and HorizScrollDelta parameters.

Since synaptics touchpads don't have a button that corresponds to the
middle button on a mouse, the driver can emulate middle mouse button
events. If you press both the left and right mouse buttons at almost
the same time (no more than EmulateMidButtonTime milliseconds apart)
the driver generates a middle mouse button event.


FAQ
---

* Is this free software?

    Yes, the source code is released under the GNU General Public
    License.

* How do I use this driver with Linux kernel 2.6.x?

    You need kernel 2.6.0-test6 or later and version 0.11.7 or later
    of the XFree86 driver. You need to have the "evdev" driver loaded
    or compiled into the kernel (CONFIG_INPUT_EVDEV). Set the
    "Protocol" parameter in the X configuration file to
    "auto-dev". Also, if you set the "Device" parameter to
    "/dev/psaux", the same X configuration file should work for a
    2.4.x kernel.

    When configuring the kernel, enable PS/2 mouse support
    (CONFIG_MOUSE_PS2) and synaptics touchpad support
    (CONFIG_MOUSE_PS2_SYNAPTICS).

* How can I configure tap-to-click behavior?

    If you set MaxTapTime=0 then the touchpad will not use tapping at
    all, i.e. touching/tapping will not be taken as a mouse click.

    If, instead, you set MaxTapMove=0, then the touchpad will not use
    tapping for a single finger tap (left mouse button click) but will
    for the two and three finger tap (middle and right button click).

* Why did tap-to-click stop working after I upgraded from an old version?

    Time is now measured in milliseconds instead of "number of
    packets". In practice, this means that if you are upgrading from
    an old version, you need to change MaxTapTime and
    EmulateMidButtonTime to make "tap to click" work. Good values are
    180 and 75 respectively.

* Gnome scrollbars scroll too much when using tap-to-click. Why?

    The MaxTapTime parameter is probably too big. Try setting it to
    180. Gnome scrollbars use auto repeat, ie if you press the left
    mouse button and keep it pressed, the scroll bar will move until
    you release the button. This will lead to problems if the tap time
    is longer than the delay before auto repeat starts.

* Can the driver be used together with gpm?

    No, not reliably, if you are using a 2.4.x kernel. The gpm driver
    and the X driver both try to read data from the touchpad, and if
    they try to read at the same time, both drivers see incomplete
    data and don't know how to interpret it.

    If you are running a 2.6.x kernel though, there should be no
    conflict, because the kernel driver will make sure both user space
    drivers receive all events from the touchpad.

* How do I compile the driver?

    Beginning with version 0.11.8, it should be possible to compile
    the driver by simply running "make". This will compile a driver
    for XFree86 4.2.x, which will also work for 4.3.x versions of
    XFree86.

    If you have an older version of XFree86, you will need an
    installed X source tree. On an RPM based distribution, you can
    build a suitable source tree by installing the XFree86 source RPM
    and compile it. For example, in RedHat 9, use the following
    commands:

      # rpm -vU XFree86-4.3.0-2.src.rpm
      # cd /usr/src/redhat/SPECS
      # rpmbuild -bb XFree86.spec

    Then change the TOP variable in the Makefile to match the version
    of XFree86 you are using. In the example above, set

      TOP = /usr/src/redhat/BUILD/XFree86-4.3.0/xc


Authors
-------

Many people have contributed to this driver. Look at the top of
synaptics.c and ps2comm.c for details.

The current maintainer is Peter Osterlund <petero2@telia.com>.