[PATCH xinput] man: document an example for a set-prop call
Peter Hutterer
peter.hutterer at who-t.net
Tue Jul 25 04:34:21 UTC 2017
Because it's 99% of the use-cases people use libinput for these days.
Signed-off-by: Peter Hutterer <peter.hutterer at who-t.net>
---
man/xinput.man | 9 ++++++++-
1 file changed, 8 insertions(+), 1 deletion(-)
diff --git a/man/xinput.man b/man/xinput.man
index 87be8c7..b89fb01 100644
--- a/man/xinput.man
+++ b/man/xinput.man
@@ -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
-property type.
+property type. See Section \fICHANGING PROPERTIES\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
+.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
--
2.13.3
More information about the xorg-devel
mailing list