summaryrefslogtreecommitdiff
path: root/man/synclient.man
blob: 610b1017d9352a34b16414e8712573c34c19bf30 (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
.\" shorthand for double quote that works everywhere.
.ds q \N'34'
.TH synclient __appmansuffix__ __vendorversion__
.SH NAME
.LP
synclient \- commandline utility to query and modify Synaptics driver
options.
.SH "SYNOPSIS"
.LP
synclient [\fI\-m interval\fP]
.br
synclient [\fI\-hlV?\fP] [var1=value1 [var2=value2] ...]
.SH "DESCRIPTION"
.LP
This program lets you change your Synaptics TouchPad driver for
XOrg/XFree86 server parameters while X is running. 

For the -m and -h options, SHM must be enabled by setting the option SHMConfig
"on" in your XOrg/XFree86 configuration.
.SH "OPTIONS"
.LP
.TP
\fB\-m interval\fR
monitor changes to the touchpad state.
.
Interval specifies how often (in ms) to poll the touchpad state.
.
Whenever a change in the touchpad state is detected, one line of
output is generated that describes the current state of the touchpad.
This option is only available in SHM mode.
.
The following data is included in the output.
.RS
.TP
\fBtime\fR
Time in seconds since the logging was started.
.TP
\fBx,y\fR
The x/y coordinates of the finger on the touchpad.
.
The origin is in the upper left corner.
.TP
\fBz\fR
The "pressure" value.
.
Pressing the finger harder on the touchpad typically produces a larger
value.
.
Note that most touchpads don't measure the real pressure though.
.
Instead, capacitance is usually measured, which is correlated to the
contact area between the finger and the touchpad.
.
Since more pressure usually means a larger contact area, the reported
pressure value is at least indirectly related to the real pressure.
.TP
\fBf\fR
The number of fingers currently touching the touchpad.
.
Note that only some touchpads can report more than one finger.
.
Generally, synaptics touchpads can, but ALPS touchpads can't.
.TP
\fBw\fR
The w value is a measurement of the finger width.
.
This is only supported by some synaptics touchpads.
.
Touchpads that can't measure the finger width typically report a faked
constant value when a finger is touching the touchpad.
.TP
\fBl,r,u,d,m,multi\fR
The state of the left, right, up, down, middle and multi buttons.
.
Zero means not pressed, one means pressed.
.
Not all touchpads have all these buttons.
.
If a button doesn't exist, the value is always reported as 0.
.TP
\fBgl,gm,gr\fR
Some touchpads have a "guest device".
.
This is typically a pointing stick located in the middle of the
keyboard.
.
Some guest devices have physical buttons, or can detect button presses
when tapping on the pointing stick.
.
Such button events are reported as "guest left", "guest middle" or
"guest right".
.TP
\fBgdx,gdy\fR
Pointer movements from the guest device are reported as relative x/y
positions, called gdx and gdy.
.RE
.TP
\fB\-l\fR
List current user settings.
.TP
\fB\-V\fR
Print version number and exit.
.TP
\fB\-?\fR
Show the help message.
.TP
\fBvar=value\fR
Set user parameter \fIvar\fR to \fIvalue\fR.


.SH "FILES"
.LP
\fI/etc/X11/xorg.conf\fP
.LP
\fI/etc/X11/XF86Config\-4\fP
.SH "EXAMPLES"
.LP
To disable EdgeMotionSpeed:
.LP
synclient EdgeMotionSpeed=0
.LP
To monitor touchpad events (requires SHM):
.LP
synclient \-m 100
.SH "AUTHORS"
.LP
Peter Osterlund <petero2@telia.com> and many others.
.TP
This man page was written by Mattia Dongili <malattia@debian.org>
.SH "SEE ALSO"
.LP
__xservername__(__appmansuffix__), syndaemon(__appmansuffix__), synaptics(__drivermansuffix__)