From 657c0872861c5f6a0c33c63eea74dd442403de0c Mon Sep 17 00:00:00 2001 From: Peter Hutterer Date: Fri, 5 Aug 2016 11:14:17 +1000 Subject: [PATCH] doc: add some info about configuring devices in wayland/xorg Signed-off-by: Peter Hutterer (cherry picked from commit ae30353a739cf059a987cdc5b41173212bd66500) --- doc/faqs.dox | 46 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) diff --git a/doc/faqs.dox b/doc/faqs.dox index c88f4529..973e5667 100644 --- a/doc/faqs.dox +++ b/doc/faqs.dox @@ -54,6 +54,52 @@ option is not exposed by the intermediary, it cannot be configured by the client. Also some configuration options that are provided by the intermediary may not be libinput-specific configuration options. +@section faq_configure_wayland How do I configure my device on Wayland? + +See @ref faq_config_options Use the configuration tool provided by your +desktop environment (e.g. gnome-control-center) or direct access to your +desktop environment's configuration storage (e.g. gsettings). + +@section faq_configure_xorg How do I configure my device on X? + +See @ref faq_config_options If your desktop environment does not provide a +graphical configuration tool you can use an +xorg.conf.d snippet. +Usually, such a snippet looks like this: +
+$> cat /etc/X11/xorg.conf.d/99-libinput-custom-config.conf
+Section "InputClass"
+  Identifier "something to identify this snippet"
+  MatchDriver "libinput"
+  MatchProduct "substring of the device name"
+  Option "some option name" "the option value"
+EndSection
+
+ +The identifier is merely a human-readable string that shows up in the log +file. The MatchProduct line should contain the device name or a substring of +the device name that the snippet should apply to. For a full list of option +names and permitted values, see the +libinput man page. +xorg.conf.d snippets like the above apply to hotplugged devices but can be +overwritten at runtime by desktop tools. Multiple snippets may be placed +into the same file. + +For run-time configuration and testing, the +xinput +debugging tool can modify a devices' properties. See the +libinput man page +for supported property names and values. Usually, an invocation looks like +this: +
+$> xinput set-prop "the device name" "the property name" value [value2] [value3]
+
+ +@note +Changes performed by xinput do not persist across device hotplugs. xinput is +considered a debugging and testing tool only and should not be used for +permanent configurations. + @section faq_hwdb_changes How to apply hwdb changes Sometimes users are asked to test updates to the