summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md5
-rw-r--r--doc/reporting-bugs.dox3
-rw-r--r--doc/tools.dox16
3 files changed, 15 insertions, 9 deletions
diff --git a/README.md b/README.md
index f95a5609..dd670ce6 100644
--- a/README.md
+++ b/README.md
@@ -53,9 +53,8 @@ Reporting Bugs
Bugs can be filed in the libinput component of Wayland:
https://bugs.freedesktop.org/enter_bug.cgi?product=Wayland&component=libinput
-Where possible, please provide an
-[evemu](http://www.freedesktop.org/wiki/Evemu/) recording of the input
-device and/or the event sequence in question.
+Where possible, please provide the `libinput record` output
+of the input device and/or the event sequence in question.
See @ref reporting_bugs for more info.
diff --git a/doc/reporting-bugs.dox b/doc/reporting-bugs.dox
index a476a722..14b6e89f 100644
--- a/doc/reporting-bugs.dox
+++ b/doc/reporting-bugs.dox
@@ -124,6 +124,9 @@ E: USEC_INITIALIZED=5463031
@section evemu Recording devices with evemu
+@note Where available, the @ref libinput-record tools should be used instead
+of evemu
+
<a href="http://www.freedesktop.org/wiki/Evemu/">evemu</a> records the
device capabilities together with the event stream from the kernel. On our
side, this allows us to recreate a virtual device identical to your device
diff --git a/doc/tools.dox b/doc/tools.dox
index eade88af..b6cbdc58 100644
--- a/doc/tools.dox
+++ b/doc/tools.dox
@@ -3,10 +3,13 @@
libinput provides a `libinput` tool to query state and events.
The two most common invocations are
-@ref libinput-list-devices and @ref libinput-debug-events. A full
-explanation of the various commands available in the libinput tool is
-available in the libinput(1) man page. Generally, the
-tool must be run as root to have access to the kernel's @c /dev/input/event*
+@ref libinput-list-devices and @ref libinput-debug-events. The @ref
+libinput-record tools are used to analyze and reproduce events sequences on
+developer machines, particularly useful when a user experiences a bug.
+
+A full explanation of the various commands available in the libinput tool is
+available in the libinput(1) man page. Generally, the tool must be run as
+root to have access to the kernel's @c /dev/input/event*
device files.
@section libinput-list-devices libinput list-devices
@@ -118,8 +121,9 @@ Select the device event number: 17
Without arguments, `libinput record` displays the available devices and lets
the user select one. Supply the number (17 in this case for
-`/dev/input/event17`) and the tool will record to the log file. More
-arguments are available, see the `libinput-record` man page.
+`/dev/input/event17`) and the tool will print the device information and
+events to the file it is redirected to. More arguments are available, see
+the `libinput-record` man page.
Reproduce the bug, ctrl+c and attach the output file to a bug report.
For data protection, `libinput record` obscures key codes by default, any