summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPeter Hutterer <peter.hutterer@who-t.net>2016-08-05 11:14:17 +1000
committerPeter Hutterer <peter.hutterer@who-t.net>2016-08-05 11:29:22 +1000
commit657c0872861c5f6a0c33c63eea74dd442403de0c (patch)
tree26495a216f290f22831ae1388353d229d7157a81
parent6614604e9abd1cf602669b35efb2aed107c7972c (diff)
doc: add some info about configuring devices in wayland/xorg
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net> (cherry picked from commit ae30353a739cf059a987cdc5b41173212bd66500)
-rw-r--r--doc/faqs.dox46
1 files changed, 46 insertions, 0 deletions
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
+<a href="https://www.x.org/archive/current/doc/man/man5/xorg.conf.5.xhtml">xorg.conf.d snippet</a>.
+Usually, such a snippet looks like this:
+<pre>
+$> 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
+</pre>
+
+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
+<a href="https://www.mankier.com/4/libinput">libinput man page</a>.
+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
+<a href="https://www.x.org/archive/X11R7.5/doc/man/man1/xinput.1.html">xinput</a>
+debugging tool can modify a devices' properties. See the
+<a href="https://www.mankier.com/4/libinput">libinput man page</a>
+for supported property names and values. Usually, an invocation looks like
+this:
+<pre>
+$> xinput set-prop "the device name" "the property name" value [value2] [value3]
+</pre>
+
+@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 <a