]> diplodocus.org Git - xorg-xinput/commitdiff
man: document an example for a set-prop call
authorPeter Hutterer <peter.hutterer@who-t.net>
Tue, 25 Jul 2017 04:32:56 +0000 (14:32 +1000)
committerPeter Hutterer <peter.hutterer@who-t.net>
Mon, 22 Jan 2018 00:24:49 +0000 (10:24 +1000)
Because it's 99% of the use-cases people use libinput for these days.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
man/xinput.man

index 87be8c7..b89fb01 100644 (file)
@@ -87,7 +87,7 @@ instead.
 .B --set\-prop [\-\-type=\fIatom|float|int\fP] [\-\-format=\fI8|16|32\fP] \fIdevice\fP \fIproperty\fP \fIvalue\fP [...]
 Set the property to the given value(s).  If not specified, the format and type
 of the property are left as-is.  The arguments are interpreted according to the
 .B --set\-prop [\-\-type=\fIatom|float|int\fP] [\-\-format=\fI8|16|32\fP] \fIdevice\fP \fIproperty\fP \fIvalue\fP [...]
 Set the property to the given value(s).  If not specified, the format and type
 of the property are left as-is.  The arguments are interpreted according to the
-property type.
+property type. See Section \fICHANGING PROPERTIES\fP.
 .PP
 .TP 8
 .B --watch-props \fIdevice\fP
 .PP
 .TP 8
 .B --watch-props \fIdevice\fP
@@ -171,6 +171,13 @@ device.
 .PP
 \fIproperty\fP can be the property as a string or the Atom value.
 .PP
 .PP
 \fIproperty\fP can be the property as a string or the Atom value.
 .PP
+.SH "CHANGING PROPERTIES"
+When xinput should modify an existing driver property value, it is
+sufficient to provide the device name and property name as string, followed
+by the new value(s) of the property. For example:
+.IP
+\fBxinput set-prop "my device" "my prop" 1 2 3\fB
+
 .SH "SEE ALSO"
 X(__miscmansuffix__), xset(__appmansuffix__), xrandr(__appmansuffix__)
 .SH COPYRIGHT
 .SH "SEE ALSO"
 X(__miscmansuffix__), xset(__appmansuffix__), xrandr(__appmansuffix__)
 .SH COPYRIGHT