fdo-mirrors/libinput
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/libinput/libinput.git synced 2025-12-20 05:40:04 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
libinput/tools/libinput-debug-gui.man

49 lines
1.4 KiB
Groff
Raw Normal View History

tools: add the libinput version to the man pages Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net> Reviewed-by: Eric Engestrom <eric.engestrom@imgtec.com>
2017-06-29 08:40:28 +10:00
.TH libinput-debug-gui "1" "" "libinput @LIBINPUT_VERSION@" "libinput Manual"
Fold the event-gui into the libinput tool It's common enough for users to want to debug libinput behavior without interference by the compositor or the X server. Being able to run a GUI without having to compile from git is helpful. Note that this changes --enable-event-gui autotools option to --enable-debug-gui and the event-gui mesonconf option to debug-gui. This also drops the standalone event-gui binary in both autotools and meson. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-05-24 10:36:44 +10:00
.SH NAME
tools: escape all dashes in man pages (for commands and options) Apparently the rule is that if a dash may end up being copy/pasted, it needs to be escaped. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-06-02 12:15:50 +10:00
libinput\-debug\-gui \- visual debug helper for libinput
Fold the event-gui into the libinput tool It's common enough for users to want to debug libinput behavior without interference by the compositor or the X server. Being able to run a GUI without having to compile from git is helpful. Note that this changes --enable-event-gui autotools option to --enable-debug-gui and the event-gui mesonconf option to debug-gui. This also drops the standalone event-gui binary in both autotools and meson. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-05-24 10:36:44 +10:00
.SH SYNOPSIS
tools: split the configuration option parsing out We had one shared parsing function for all config options so tools parse options that don't actually make sense (e.g. --quiet or --show-keycodes for libinput-list-devices). This patch splits the actual libinput device configuration out and reshuffles everything to make use of that. One large patch, because splitting this up is more confusing than dumping it all. This means the actual option parsing is partially duplicated between debug-gui and debug-events but hey, not everything in life is perfect. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-06-19 18:38:33 +10:00
.B libinput debug\-gui [\-\-help] [\-\-udev <seat>|\-\-device /dev/input/event0] [configuration options]
Fold the event-gui into the libinput tool It's common enough for users to want to debug libinput behavior without interference by the compositor or the X server. Being able to run a GUI without having to compile from git is helpful. Note that this changes --enable-event-gui autotools option to --enable-debug-gui and the event-gui mesonconf option to debug-gui. This also drops the standalone event-gui binary in both autotools and meson. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-05-24 10:36:44 +10:00
.SH DESCRIPTION
.PP
The
tools: escape all dashes in man pages (for commands and options) Apparently the rule is that if a dash may end up being copy/pasted, it needs to be escaped. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-06-02 12:15:50 +10:00
.B "libinput debug\-gui"
Fold the event-gui into the libinput tool It's common enough for users to want to debug libinput behavior without interference by the compositor or the X server. Being able to run a GUI without having to compile from git is helpful. Note that this changes --enable-event-gui autotools option to --enable-debug-gui and the event-gui mesonconf option to debug-gui. This also drops the standalone event-gui binary in both autotools and meson. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-05-24 10:36:44 +10:00
tool creates a libinput context and a full-screen GTK window to visualize
tools: grab the pointer in the debug gui Because it's too annoying to trigger the hot corner every few seconds while pointer debugging. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-06-13 15:18:56 +10:00
events processed by libinput. This tool exclusively grabs pointing devices
and stops them from interacting with the rest of the GUI.
tools: shorten the --help output for the commands The full information is now in the man page, the usage() now just tells you how to use it. This way there's only one place to maintain it. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-06-19 17:13:38 +10:00
.PP
tools: grab the pointer in the debug gui Because it's too annoying to trigger the hot corner every few seconds while pointer debugging. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-06-13 15:18:56 +10:00
.B Hit Esc to exit this tool.
Fold the event-gui into the libinput tool It's common enough for users to want to debug libinput behavior without interference by the compositor or the X server. Being able to run a GUI without having to compile from git is helpful. Note that this changes --enable-event-gui autotools option to --enable-debug-gui and the event-gui mesonconf option to debug-gui. This also drops the standalone event-gui binary in both autotools and meson. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-05-24 10:36:44 +10:00
.PP
This is a debugging tool only, its output or behavior may change at any
time. Do not rely on the output or the behavior.
.PP
This tool usually needs to be run as root to have access to the
/dev/input/eventX nodes.
.SH OPTIONS
.TP 8
tools: shorten the --help output for the commands The full information is now in the man page, the usage() now just tells you how to use it. This way there's only one place to maintain it. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-06-19 17:13:38 +10:00
.B \-\-device /dev/input/event0
Use the given device with the path backend.
.TP 8
.B \-\-grab
Exclusively grab all opened devices. This will prevent events from being
delivered to the host system.
.TP 8
tools: escape all dashes in man pages (for commands and options) Apparently the rule is that if a dash may end up being copy/pasted, it needs to be escaped. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-06-02 12:15:50 +10:00
.B \-\-help
Fold the event-gui into the libinput tool It's common enough for users to want to debug libinput behavior without interference by the compositor or the X server. Being able to run a GUI without having to compile from git is helpful. Note that this changes --enable-event-gui autotools option to --enable-debug-gui and the event-gui mesonconf option to debug-gui. This also drops the standalone event-gui binary in both autotools and meson. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-05-24 10:36:44 +10:00
Print help
tools: shorten the --help output for the commands The full information is now in the man page, the usage() now just tells you how to use it. This way there's only one place to maintain it. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-06-19 17:13:38 +10:00
.TP 8
tools: split the configuration option parsing out We had one shared parsing function for all config options so tools parse options that don't actually make sense (e.g. --quiet or --show-keycodes for libinput-list-devices). This patch splits the actual libinput device configuration out and reshuffles everything to make use of that. One large patch, because splitting this up is more confusing than dumping it all. This means the actual option parsing is partially duplicated between debug-gui and debug-events but hey, not everything in life is perfect. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-06-19 18:38:33 +10:00
.B \-\-udev <seat>
Use the udev backend to listen for device notifications on the given seat.
The default behavior is equivalent to \-\-udev "seat0".
tools: shorten the --help output for the commands The full information is now in the man page, the usage() now just tells you how to use it. This way there's only one place to maintain it. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-06-19 17:13:38 +10:00
.TP 8
.B \-\-verbose
Use verbose output
Fold the event-gui into the libinput tool It's common enough for users to want to debug libinput behavior without interference by the compositor or the X server. Being able to run a GUI without having to compile from git is helpful. Note that this changes --enable-event-gui autotools option to --enable-debug-gui and the event-gui mesonconf option to debug-gui. This also drops the standalone event-gui binary in both autotools and meson. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-05-24 10:36:44 +10:00
.PP
tools: shorten the --help output for the commands The full information is now in the man page, the usage() now just tells you how to use it. This way there's only one place to maintain it. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-06-19 17:13:38 +10:00
For libinput configuration options, see libinput-debug-events(1)
Fold the event-gui into the libinput tool It's common enough for users to want to debug libinput behavior without interference by the compositor or the X server. Being able to run a GUI without having to compile from git is helpful. Note that this changes --enable-event-gui autotools option to --enable-debug-gui and the event-gui mesonconf option to debug-gui. This also drops the standalone event-gui binary in both autotools and meson. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-05-24 10:36:44 +10:00
.SH NOTES
.PP
Events shown by this tool may not correspond to the events seen by a
different user of libinput. This tool initializes a separate context.
.SH LIBINPUT
Part of the
.B libinput(1)
suite
Reference in a new issue Copy permalink