summaryrefslogtreecommitdiff
path: root/manpages/synaptics.5
blob: 42610fcd7aa5396f275f7302dd7a79b12f078327 (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
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
MaxDoubleTapTime	Int	max. time (in milliseconds) for detecting a double tap
ClickTime		Int	the duration of the mouse click generated by tapping
FastTaps		Bool	Makes the driver react faster to a single tap, but
				also makes double clicks caused by double tapping slower.
VertScrollDelta		Int	move distance of the finger for a scroll event
HorizScrollDelta	Int	move distance of the finger for a scroll event
EdgeMotionMinZ		Int	finger pressure at which minimum edge motion speed is set
EdgeMotionMaxZ		Int	finger pressure at which maximum edge motion speed is set
EdgeMotionMinSpeed	Int	slowest setting for edge motion speed
EdgeMotionMaxSpeed	Int	fastest setting for edge motion speed
EdgeMotionUseAlways	Bool	If on, edge motion is also used for normal movements,
				if off, egde motion is used only 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		Int	Switch off the touchpad. Valid values are:
				0 : Touchpad is enabled
				1 : Touchpad is switched off
				2 : Only tapping is switched off
GuestMouseOff		Bool	switch on/off guest mouse (often a stick)
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
CircularScrolling	Bool	If on, circular scrolling is used (see below)
CircScrollDelta		Float	Move angle (radians) of finger to generate a scroll event
CircScrollTrigger	Int	Trigger region on the touchpad to start circular scrolling
				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
CircularPad	        Bool	Instead of being a rectangle, the edge is the ellipse
				enclosed by the Left/Right/Top/BottomEdge parameters.
				For circular touchpads.
PalmDetect		Bool	If palm detection should be enabled
PalmMinWidth		Int	Minimum width at which touch is considered a palm
PalmMinZ		Int	Minimum finger pressure at which touch is considered a palm
CoastingSpeed		Float	Coasting threshold scrolling speed. 0 disables coasting.

The LeftEdge, RightEdge, TopEdge and BottomEdge parameters are used to
define the edge and corner areas of the touchpad. The parameters split
the touchpad area in 9 pieces, like this:

        LeftEdge  RightEdge
            v         v
            |         |       Physical top edge
          1 |    2    | 3
        -------------------   TopEdge
            |         |
         4  |    5    | 6
            |         |
        -------------------   BottomEdge
         7  |    8    | 9
            |         |       Physical bottom edge
        ^                 ^
     Physical          Physical
     left edge        right edge

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
(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.

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 MaxDoubleTapTime parameter has the same function as the MaxTapTime
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.

The ClickTime parameter controls the delay between the button down and
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.

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. To disable
vertical or horizontal scrolling, set VertScrollDelta or
HorizScrollDelta to zero.

When hitting an egde, movement can be automatically continued.
If EdgeMotionUseAlways is false, edge motion is only used when
dragging. With EdgeMotionUseAlways set to true, it is also used for
normal cursor movements.

Edge motion speed is calculated by taking into account the amount of
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.

Since most synaptics touchpad models 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.

Circular scrolling acts like a scrolling wheel on the trackpad.
Scrolling is engaged when a drag starts in the given CircScrollTrigger
region, which can be all edges, a particular side, or a particular
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
scrolling.

Coasting is enabled by setting the CoastingSpeed parameter to a
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.