fdo-mirrors/libinput
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/libinput/libinput.git synced 2026-01-06 22:20:17 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: update for the new libinput tool

Browse source 
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
This commit is contained in:
Peter Hutterer 2017-05-24 11:12:28 +10:00
parent 2d42e87deb
commit 319db5b7df
3 changed files with 35 additions and 60 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
doc/building.dox
View file

@ -162,25 +162,23 @@ environment where tablet support is not required. libinput provides tablet
support even without libwacom, but some features may be missing or working
differently.
@subsection buildling_event-gui Building without the graphical helper tool
@subsection buildling_debug-gui Building without the graphical helper tool
Only the commandline @ref tools are installed by distributions. The
@ref event-gui graphical helper tools is only available in the source
repository.
The graphical helper tool is enabled by default but requires extra libraries
to build. If these libraries are not available, the build will fail.
If the tool is not required, use the ``--disable-event-gui`` argument
when @ref building.
The @ref tools provide commandline features as well as graphical debugging
features. To keep dependencies in check on some builds, the graphical
features of the @ref tools can be disabled. By default, the `debug-gui`
feature of the `libinput` tool is enabled and if the required libraries are
not available, the build will fail. If the feature is not required, use the
``--disable-debug-gui`` argument when @ref building.
@code
$> meson --prefix=/usr -Devent-gui=false builddir
$> meson --prefix=/usr -Ddebug-gui=false builddir
@endcode
or when building with autotools:
@code
$> ./autogen.sh --disable-event-gui --prefix=/usr --libdir=/usr/lib64
$> ./autogen.sh --disable-debug-gui --prefix=/usr --libdir=/usr/lib64
@endcode
@section building_against Building against libinput

73
doc/tools.dox
View file

@ -1,25 +1,23 @@
/**
@page tools Helper tools
libinput provides a couple of tools to query state and events. Two of these
tools are usually installed, others are @ref developer_tools only.
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*
device files.
@section user_tools User tools
@section libinput-list-devices libinput list-devices
libinput ships with two tools to gather information about devices:
@ref libinput-list-devices and @ref libinput-debug-events. Both tools must
be run as root to have access to the kernel's @c /dev/input/event* device
files.
@subsection libinput-list-devices
The libinput-list-devices tool shows information about devices recognized by
libinput and can help identifying why a device behaves different than
expected. For example, if a device does not show up in the output, it is not
a supported input device.
The `libinput list-devices` command shows information about devices
recognized by libinput and can help identifying why a device behaves
different than expected. For example, if a device does not show up in the
output, it is not a supported input device.
@verbatim
$ sudo libinput-list-devices
$ sudo libinput list-devices
[...]
Device: SynPS/2 Synaptics TouchPad
Kernel: /dev/input/event4
@ -39,8 +37,8 @@ Click methods: *button-areas clickfinger
@endverbatim
The above listing shows example output for a touchpad. The
libinput-list-devices tool lists general information about the device (the
kernel event node) but also the configuration options. If an option is
`libinput list-devices` command lists general information about the device
(the kernel event node) but also the configuration options. If an option is
"n/a" it does not exist on this device. Otherwise, the tool will show the
default configuration for this device, for options that have more than a
binary state all available options are listed, with the default one prefixed
@ -53,37 +51,18 @@ applied by the desktop environment.
@note This tool is intended to be human-readable and may change its output
at any time.
@subsection libinput-debug-events
This is an installed version of the @ref event-debug developer tool. It
prints events from devices and can help to identify why a device behaves
different than expected.
@section libinput-debug-events libinput debug-events
The `libinput debug-events` command prints events from devices and can help
to identify why a device behaves different than expected.
@verbatim
$ sudo libinput-debug-events --enable-tapping --set-click-method=clickfinger
$ sudo libinput debug-events --enable-tapping --set-click-method=clickfinger
@endverbatim
See the man page or the @c --help output for information about the available
options.
See the libinput(1) man page or the @c --help output for information about
the available options.
@section developer_tools Developer tools
The two most common tools used by developers are @ref event-debug and @ref
event-gui.
@subsection event-debug
This is the in-tree version of the @ref libinput-debug-events tool and is
linked to allow for easy debugging (i.e. it avoids libtool shenanigans). The
code is the same. For debugging, run it against a single device only and
enable the --verbose flag. This will print the various state machine
transitions in addition to the events.
@verbatim
$ sudo ./tools/event-debug --verbose --device /dev/input/event3
@endverbatim
See the @c --help output for information about the available options.
@subsection event-gui
@section libinput-debug-gui libinput debug-gui
A simple GTK-based graphical tool that shows the behavior and location of
touch events, pointer motion, scroll axes and gestures. Since this tool
@ -91,12 +70,10 @@ gathers data directly from libinput, it is thus suitable for
pointer-acceleration testing.
@verbatim
$ sudo ./tools/event-gui
$ sudo libinput debug-gui
@endverbatim
See the @c --help output for information about the available options.
@note The @c --grab flag puts an exclusive @c EVIOCGRAB on the device to
avoid interference with the desktop while testing.
See the libinput(1) man page or the @c --help output for information about
the available options.
*/

2
doc/touchpad-pressure.dox
View file

@ -128,7 +128,7 @@ device's event node (see @ref faq_hwdb_changes):
If the pressure range property shows up correctly, restart X or the
Wayland compositor and libinput should now use the correct pressure
thresholds. The @ref developer_tools can be used to verify the correct
thresholds. The @ref tools can be used to verify the correct
functionality first without the need for a restart.
Once the pressure ranges are deemed correct,