synaptics.5 14.3 KB
Newer Older
Peter Osterlund's avatar
Peter Osterlund committed
1
.TH "synaptics" "5" "0.14.6" "" ""
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
.SH "NAME"
.LP
synaptics - Synaptics touchpad driver for XOrg/XFree86.
.SH "INTRODUCTION"
.LP
This is a driver for the Synaptics TouchPad for XOrg/XFree86 4.x.
.
A Synaptics touchpad by default operates in compatibility mode by
emulating a standard mouse.
.
However, by using a dedicated driver, more advanced features of the
touchpad becomes available, such as:
.IP \(bu 4
Movement with adjustable, non-linear acceleration and speed.
.IP \(bu 4
Button events through short touching of the touchpad.
.IP \(bu 4
Double-Button events through double short touching of the touchpad.
.IP \(bu 4
Dragging through short touching and holding down the finger on the
touchpad.
.IP \(bu 4
Middle and right button events on the upper and lower corner of the
touchpad.
.IP \(bu 4
Vertical scrolling (button four and five events) through moving the
finger on the right side of the touchpad.
.IP \(bu 4
The up/down button sends button four/five events.
.IP \(bu 4
Horizontal scrolling (button six and seven events) through moving the
finger on the lower side of the touchpad.
.IP \(bu 4
Peter Osterlund's avatar
Peter Osterlund committed
35
36
The multi-buttons send button four/five events for vertical scrolling
and button six/seven events for horizontal scrolling.
37
38
39
40
41
42
43
44
45
46
.IP \(bu 4
Adjustable finger detection.
.IP \(bu 4
Multifinger taps: two finger for middle button and three finger for
right button events.
.
(Needs hardware support.
.
Not all models implement this feature.)
.IP \(bu 4
47
48
Pressure dependent motion speed.
.IP \(bu 4
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
Run-time configuration using shared memory. This means you can change
parameter settings without restarting the X server.
.LP
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.)
.SH "DESCRIPTION"
.LP
The driver behavior can be configured with parameters.
.
These parameters are options in the InputDevice section in the
XOrg/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(1) program.
.
The following parameters are available:
.TP
\fBDevice\fR (String)
Synaptics device.
.TP
\fBProtocol\fR (String)
.TS
l l.
auto-dev	automatic, default
psaux	raw
event	linux 2.6 kernel events
psm	FreeBSD psm driver
.TE
.TP
\fBSHMConfig\fR (Bool)
Switch on/off shared memory for configuration.
.TP
\fBLeftEdge\fR (Integer)
X coordinate for left edge.
.TP
\fBRightEdge\fR (Integer)
X coordinate for right edge.
.TP
\fBTopEdge\fR (Integer)
Y coordinate for top edge.
.TP
\fBBottomEdge\fR (Integer)
Y coordinate for bottom edge.
.TP
\fBFingerLow\fR (Integer)
When finger pressure drops below this value, the driver counts it as a
release.
.TP
\fBFingerHigh\fR (Integer)
When finger pressure goes above this value, the driver counts it as a
touch.
.TP
\fBMaxTapTime\fR (Integer)
Maximum time (in milliseconds) for detecting a tap.
.TP
\fBMaxTapMove\fR (Integer)
Maximum movement of the finger for detecting a tap.
.TP
\fBMaxDoubleTapTime\fR (Integer)
Maximum time (in milliseconds) for detecting a double tap.
.TP
\fBClickTime\fR (Integer)
The duration of the mouse click generated by tapping.
.TP
\fBFastTaps\fR (Bool)
Makes the driver react faster to a single tap, but also makes double
clicks caused by double tapping slower.
.TP
122
123
124
125
126
127
128
129
130
131
132
133
134
135
\fBVertEdgeScroll\fR (Bool)
Enable vertical scrolling when dragging along the right edge.
.TP
\fBHorizEdgeScroll\fR (Bool)
Enable horizontal scrolling when dragging along the bottom edge.
.TP
\fBVertTwoFingerScroll\fR (Bool)
Enable vertical scrolling when dragging with two fingers anywhere on
the touchpad.
.TP
\fBHorizTwoFingerScroll\fR (Bool)
Enable horizontal scrolling when dragging with two fingers anywhere on
the touchpad.
.TP
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
\fBVertScrollDelta\fR (Integer)
Move distance of the finger for a scroll event.
.TP
\fBHorizScrollDelta\fR (Integer)
Move distance of the finger for a scroll event.
.TP
\fBEdgeMotionMinZ\fR (Integer)
Finger pressure at which minimum edge motion speed is set.
.TP
\fBEdgeMotionMaxZ\fR (Integer)
Finger pressure at which maximum edge motion speed is set.
.TP
\fBEdgeMotionMinSpeed\fR (Integer)
Slowest setting for edge motion speed.
.TP
\fBEdgeMotionMaxSpeed\fR (Integer)
Fastest setting for edge motion speed.
.TP
\fBEdgeMotionUseAlways\fR (Bool)
If on, edge motion is also used for normal movements.
.
If off, egde motion is used only when dragging.
.TP
\fBRepeater\fR (String)
Repeater device.
.TP
\fBMinSpeed\fR (Float)
Minimum speed factor.
.TP
\fBMaxSpeed\fR (Float)
Maximum speed factor.
.TP
\fBAccelFactor\fR (Float)
Acceleration factor.
.TP
171
172
173
174
175
176
177
178
179
180
181
182
\fBPressureMotionMinZ\fR (Integer)
Finger pressure at which minimum pressure motion factor is applied.
.TP
\fBPressureMotionMaxZ\fR (Integer)
Finger pressure at which maximum pressure motion factor is applied.
.TP
\fBPressureMotionMinFactor\fR (Integer)
Lowest setting for pressure motion factor.
.TP
\fBPressureMotionMaxFactor\fR (Integer)
Greatest setting for pressure motion factor.
.TP
183
184
185
186
187
188
\fBUpDownScrolling\fR (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.
.TP
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
\fBLeftRightScrolling\fR (Bool)
If on, the left/right buttons generate button 6/7 events.
.
If off, the left/right buttons both generate button 2 events.
.TP
\fBUpDownRepeat\fR (Bool)
If on, and the up/down buttons are used for scrolling
(\fBUpDownScrolling\fR), these buttons will send auto-repeating 4/5 events,
with the delay between repeats determined by \fBScrollButtonRepeat\fR.
.TP
\fBLeftRightRepeat\fR (Bool)
If on, and the left/right buttons are used for scrolling
(\fBLeftRightScrolling\fR), these buttons will send auto-repeating 6/7 events,
with the delay between repeats determined by \fBScrollButtonRepeat\fR.
.TP
\fBScrollButtonRepeat\fR (Integer)
The number of milliseconds between repeats of button events 4-7 from the
up/down/left/right scroll buttons.
.TP
208
209
210
\fBEmulateMidButtonTime\fR (Integer)
Maximum time (in milliseconds) for middle button emulation.
.TP
211
212
213
214
\fBEmulateTwoFingerMinZ\fR (Integer)
For touchpads not capable of detecting multiple fingers (Alps), this sets the
Z pressure threshold to emulate a two finger press.
.TP
215
216
217
218
219
220
221
222
\fBTouchpadOff\fR (Integer)
Switch off the touchpad.
.
Valid values are:
.TS
l l.
0	Touchpad is enabled
1	Touchpad is switched off
223
2	Only tapping and scrolling is switched off
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
.TE
.TP
\fBGuestMouseOff\fR (Bool)
Switch on/off guest mouse (often a stick).
.TP
\fBLockedDrags\fR (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.
.TP
\fBRTCornerButton\fR (Integer)
.
Which mouse button is reported on a right top corner tap.
.
Set to 0 to disable.
.TP
\fBRBCornerButton\fR (Integer)
Which mouse button is reported on a right bottom corner tap.
.
Set to 0 to disable.
.TP
\fBLTCornerButton\fR (Integer)
Which mouse button is reported on a left top corner tap.
.
Set to 0 to disable.
.TP
\fBLBCornerButton\fR (Integer)
Which mouse button is reported on a left bottom corner tap.
.
Set to 0 to disable.
.TP
\fBTapButton1\fR (Integer)
Which mouse button is reported on a non-corner one-finger tap.
.
Set to 0 to disable.
.TP
\fBTapButton2\fR (Integer)
Which mouse button is reported on a non-corner two-finger tap.
.
Set to 0 to disable.
.TP
\fBTapButton3\fR (Integer)
Which mouse button is reported on a non-corner three-finger tap.
.
Set to 0 to disable.
.TP
\fBCircularScrolling\fR (Bool)
If on, circular scrolling is used.
.TP
\fBCircScrollDelta\fR (Float)
Move angle (radians) of finger to generate a scroll event.
.TP
\fBCircScrollTrigger\fR (Integer)
Trigger region on the touchpad to start circular scrolling
.TS
l l.
0	All Edges
1	Top Edge
2	Top Right Corner
3	Right Edge
4	Bottom Right Corner
5	Bottom Edge
6	Bottom Left Corner
7	Left Edge
8	Top Left Corner
.TE
.TP
\fBCircularPad\fR (Bool)
.
Instead of being a rectangle, the edge is the ellipse enclosed by the
Left/Right/Top/BottomEdge parameters.
.
For circular touchpads.
.TP
\fBPalmDetect\fR (Bool)
If palm detection should be enabled.
.
Note that this also requires hardware/firmware support from the
touchpad.
.TP
\fBPalmMinWidth\fR (Integer)
Minimum finger width at which touch is considered a palm.
.TP
\fBPalmMinZ\fR (Integer)
Minimum finger pressure at which touch is considered a palm.
.TP
\fBCoastingSpeed\fR (Float)
Coasting threshold scrolling speed.
.
0 disables coasting.
314
315
316
.TP
\fBSingleTapTimeout\fR (Integer)
Timeout after a tap to recognize it as a single tap.
317
318
319
.
.
.LP
320
The LeftEdge, RightEdge, TopEdge and BottomEdge parameters are used to
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
define the edge and corner areas of the touchpad.
.
The parameters split the touchpad area in 9 pieces, like this:
.LP
.TS
l|l|lsls
---
|c|cw(5P)|c|l
---
|c|c|c|l
|c|c|c|l
|c|c|c|l
---
|c|c|c|l
---
|lsl|ll.
	LeftEdge	RightEdge
			Physical top edge
1	2	3
			TopEdge
341

342
4	5	6
343

344
345
346
347
348
349
			BottomEdge
7	8	9
			Physical bottom edge
Physical left edge		Physical right edge
.TE
.LP
350
351
Coordinates to the left of LeftEdge are part of the left edge (areas
1, 4 and 7), coordinates to the left of LeftEdge and above TopEdge
352
353
354
355
356
357
358
(area 1) are part of the upper left corner, etc.
.
A good way to find appropriate edge parameters is to enable the
SHMConfig option and run "synclient -m 1" to see the x/y coordinates
corresponding to different positions on the touchpad.
.
.LP
359
360
A tap event happens when the finger is touched and released in a time
interval shorter than MaxTapTime, and the touch and release
361
362
363
364
365
366
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.
.
.LP
367
The MaxDoubleTapTime parameter has the same function as the MaxTapTime
368
369
370
371
372
373
374
375
376
parameter, but for the second, third, etc tap in a tap sequence.
.
If you can't perform double clicks fast enough (for example, xmms
depends on fast double clicks), try reducing this parameter.
.
If you can't get word selection to work in xterm (ie button down,
button up, button down, move mouse), try increasing this parameter.
.
.LP
377
The ClickTime parameter controls the delay between the button down and
378
379
380
381
382
383
button up X events generated in response to a tap event.
.
A too long value can cause undesirable autorepeat in scroll bars and a
too small value means that visual feedback from the gui application
you are interacting with is harder to see.
.
384
385
For this parameter to have any effect, "FastTaps" has to be disabled.
.
386
.LP
387
The MinSpeed, MaxSpeed and AccelFactor parameters control the pointer
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
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.
.
.LP
403
The MinSpeed, MaxSpeed and AccelFactor parameters don't have any
404
405
406
407
408
409
effect on scrolling speed.
.
Scrolling speed is determined solely from the VertScrollDelta and
HorizScrollDelta parameters.
.
To disable vertical or horizontal scrolling, set VertScrollDelta or
410
HorizScrollDelta to zero.
411
412
.
.LP
413
When hitting an egde, movement can be automatically continued.
414
.
415
If EdgeMotionUseAlways is false, edge motion is only used when
416
417
418
419
420
421
dragging.
.
With EdgeMotionUseAlways set to true, it is also used for normal
cursor movements.
.
.LP
422
Edge motion speed is calculated by taking into account the amount of
423
424
425
426
427
428
429
430
431
432
433
434
pressure applied to the touchpad.
.
The sensitivity can be adjusted using the EdgeMotion parameters.
.
If the pressure is below EdgeMotionMinZ, EdgeMotionMinSpeed is used,
and if the pressure is greater than EdgeMotionMaxZ, EdgeMotionMaxSpeed
is used.
.
For a pressure value between EdgeMotionMinZ and EdgeMotionMaxZ, the
speed is increased linearly.
.
.LP
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
When pressure motion is activated, the cursor motion speed depends
on the pressure exerted on the touchpad (the more pressure exerted on
the touchpad, the faster the pointer).
.
More precisely the speed is first calculated according to MinSpeed,
MaxSpeed and AccelFactor, and then is multiplied by a sensitivity
factor.
.
The sensitivity factor can be adjusted using the PressureMotion
parameters.
.
If the pressure is below PressureMotionMinZ, PressureMotionMinFactor
is used, and if the pressure is greater than PressureMotionMaxZ,
PressureMotionMaxFactor is used.
.
By default, PressureMotionMinZ and PressureMotionMaxZ are equal to
EdgeMotionMinZ and EdgeMotionMaxZ.
.
For a pressure value between PressureMotionMinZ and
PressureMotionMaxZ, the factor is increased linearly.
.
.LP
457
458
Since most synaptics touchpad models don't have a button that
corresponds to the middle button on a mouse, the driver can emulate
459
460
461
462
463
464
465
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.
.
.LP
466
Circular scrolling acts like a scrolling wheel on the trackpad.
467
.
468
469
Scrolling is engaged when a drag starts in the given CircScrollTrigger
region, which can be all edges, a particular side, or a particular
470
471
472
473
474
475
476
477
478
479
480
481
482
corner.
.
Once scrolling is engaged, moving your finger in clockwise circles
around the trackpad will generate scroll down events and counter
clockwise scroll up events.
.
Lifting your finger will disengage circular scrolling.
.
Use tight circles near the center of the pad for fast scrolling and
large circles for better control.
.
When used together with vertical scrolling, hitting the upper or lower
right corner will seamlessly switch over from vertical to circular
483
scrolling.
484
485
.
.LP
486
Coasting is enabled by setting the CoastingSpeed parameter to a
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
non-zero value.
.
When coasting is enabled, horizontal/vertical scrolling can continue
after the finger is released from the lower/right edge of the
touchpad.
.
The driver computes the scrolling speed corresponding to the finger
speed immediately before the finger leaves the touchpad.
.
If this scrolling speed is larger than the CoastingSpeed parameter
(measured in scroll events per second), the scrolling will continue
with the same speed in the same direction until the finger touches the
touchpad again.
.SH "AUTHORS"
.LP
Peter Osterlund <petero2@telia.com> and many others.
.SH "SEE ALSO"
.LP
synclient(1), syndaemon(1)