doc/user: add a mini-blurb for the new libinput analyze tool
authorPeter Hutterer <peter.hutterer@who-t.net>
Mon, 23 Mar 2020 06:48:31 +0000 (16:48 +1000)
committerPeter Hutterer <peter.hutterer@who-t.net>
Wed, 25 Mar 2020 05:52:56 +0000 (05:52 +0000)
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
doc/user/tools.rst

index d470085295b3dc1ca4b2cbd1f444ba60bff6136f..602319a01392fe1757b940021904231f953915ac 100644 (file)
@@ -21,6 +21,8 @@ The most common tools used are:
   see :ref:`here <libinput-record>`
 - ``libinput measure``: measure properties on a kernel device,
   see :ref:`here <libinput-measure>`
+- ``libinput analyze``: analyse event recordings from a kernel device,
+  see :ref:`here <libinput-analyze>`
 - ``libinput quirks``: show quirks assigned to a device, see
   :ref:`here <libinput-quirks>`
 
@@ -302,6 +304,19 @@ thing and one thing only and their usage is highly specific to the tool.
 Please see the **libinput-measure(1)** man page for information about what
 tools are available and the man page for each respective tool.
 
+.. _libinput-analyze:
+
+------------------------------------------------------------------------------
+Analyzing device events with libinput analyze
+------------------------------------------------------------------------------
+
+The ``libinput analyze`` tool is a multiplexer for various sub-tools that
+can analyze input events previously recorded from a device.
+
+Please see the **libinput-analyze(1)** man page for information about what
+tools are available and the man page for each respective too.
+
+
 .. _libinput-quirks:
 
 ------------------------------------------------------------------------------