summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorPeter Hutterer <peter.hutterer@who-t.net>2009-02-25 13:38:02 +1000
committerPeter Hutterer <peter.hutterer@who-t.net>2009-02-26 14:24:07 +1000
commit55509ef5ce671fb2233c06e3ea5f0cc677f9ab6e (patch)
tree4075e9e0e1e19d676169c97aee0a42acbc2a59fb /man
parent4e9689aa5fdae4b7bd81f416e475ebf92b7302e1 (diff)
synclient: add support for device properties.
By default, use the properties unless the -s flag is given. For -m and -h imply SHM though. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net> Signed-off-by: Christoph Brill <egore911@egore911.de>
Diffstat (limited to 'man')
-rw-r--r--man/synclient.man23
1 files changed, 14 insertions, 9 deletions
diff --git a/man/synclient.man b/man/synclient.man
index a18d169..9422e70 100644
--- a/man/synclient.man
+++ b/man/synclient.man
@@ -13,13 +13,14 @@ 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 if you enabled
-SHMConfig "on" in your XOrg/XFree86 configuration.
-.TP
-WARNING: This is not secure if you are in an untrusted multiuser
-environment.
-.
-All local users can change the parameters at any time.
+XOrg/XFree86 server parameters while X is running.
+
+This program provides two mechanism: via input device properties (default) and
+via a shared memory (SHM) area. SHM must be enabled through SHMConfig "on" in
+your XOrg/XFree86 configuration.
+
+WARNING: The SHM mechanism is not secure if you are in an untrusted multiuser
+environment. All local users can change the parameters at any time.
.SH "OPTIONS"
.LP
.TP
@@ -30,6 +31,7 @@ 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
@@ -98,7 +100,7 @@ positions, called gdx and gdy.
.RE
.TP
\fB\-h\fR
-Show detected hardware properties.
+Show detected hardware properties. Only available in SHM mode.
.TP
\fB\-l\fR
List current user settings.
@@ -109,6 +111,9 @@ Print version number and exit.
\fB\-?\fR
Show the help message.
.TP
+\fB\-s\fR
+Force SHM mode. Implicit if -m or -h is specified.
+.TP
\fBvar=value\fR
Set user parameter \fIvar\fR to \fIvalue\fR.
@@ -124,7 +129,7 @@ To disable EdgeMotionSpeed:
.LP
synclient EdgeMotionSpeed=0
.LP
-To monitor touchpad events:
+To monitor touchpad events (requires SHM):
.LP
synclient \-m 100
.SH "AUTHORS"