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

72 lines
1.8 KiB
Groff
Raw Permalink 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 "1" "" "libinput @LIBINPUT_VERSION@" "libinput Manual"
tools: add a 'libinput' tool This tool will eventually replace the different libinput tools we ship atm with the various functionalities being commands to the single tool, rather than multiple tools. Right now, we still build both tools separately. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-05-11 13:11:23 +10:00
.SH NAME
libinput \- tool to interface with libinput
.SH SYNOPSIS
tools: tidy up the libinput man pages again Make the libinput page more generic but suitable for short attention spans and most importantly, point to the xf86-input-libinput man page in a more obvious manner since we're now shadowing that. The rest of the man pages have punctuation and formatting cleanups only. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-07-03 13:33:20 +10:00
.B libinput [\-\-help|\-\-version] \fI<command>\fR \fI[<args>]\fR
tools: add a 'libinput' tool This tool will eventually replace the different libinput tools we ship atm with the various functionalities being commands to the single tool, rather than multiple tools. Right now, we still build both tools separately. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-05-11 13:11:23 +10:00
.SH DESCRIPTION
.PP
tools: tidy up the libinput man pages again Make the libinput page more generic but suitable for short attention spans and most importantly, point to the xf86-input-libinput man page in a more obvious manner since we're now shadowing that. The rest of the man pages have punctuation and formatting cleanups only. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-07-03 13:33:20 +10:00
libinput is a library to handle input devices and provides device
detection and input device event processing for most Wayland
compositors and the X.Org xf86-input-libinput driver.
.PP
tools: add a 'libinput' tool This tool will eventually replace the different libinput tools we ship atm with the various functionalities being commands to the single tool, rather than multiple tools. Right now, we still build both tools separately. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-05-11 13:11:23 +10:00
The
tools: switch the libinput tool to be an exec-ing tool Chaining args together inside a single binary would be nice, but it gets nasty quickly (as I found out adding 3, 4 extra commands). Switch over to using a git-style exec-ing command where libinput merely changes argv[0] and then executes whatever it assembled. And those binaries can hide in libexec so they don't clutter up the global namespace. This also makes it a lot easier to write man pages, adopt the same style as git uses. Compatibilty wrapper scripts are provided for libinput-list-devices and libinput-debug events. These warn the user about the changed command, then exec the new one. Expect these wrappers to be removed at some point in the future. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-05-25 10:12:26 +10:00
.B "libinput"
tools: tidy up the libinput man pages again Make the libinput page more generic but suitable for short attention spans and most importantly, point to the xf86-input-libinput man page in a more obvious manner since we're now shadowing that. The rest of the man pages have punctuation and formatting cleanups only. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-07-03 13:33:20 +10:00
tools are a set of tools to debug, interface with and analyze data for
libinput. These tools create libinput contexts separate from that of
the compositor/X server and cannot change settings in a running session.
See section
.B COMMANDS
for a list of available commands.
tools: add a 'libinput' tool This tool will eventually replace the different libinput tools we ship atm with the various functionalities being commands to the single tool, rather than multiple tools. Right now, we still build both tools separately. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-05-11 13:11:23 +10:00
.PP
tools: tidy up the libinput man pages again Make the libinput page more generic but suitable for short attention spans and most importantly, point to the xf86-input-libinput man page in a more obvious manner since we're now shadowing that. The rest of the man pages have punctuation and formatting cleanups only. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-07-03 13:33:20 +10:00
libinput's API documentation and details on features and various high-level
concepts are available online at
.I https://wayland.freedesktop.org/libinput/doc/latest/
tools: switch the libinput tool to be an exec-ing tool Chaining args together inside a single binary would be nice, but it gets nasty quickly (as I found out adding 3, 4 extra commands). Switch over to using a git-style exec-ing command where libinput merely changes argv[0] and then executes whatever it assembled. And those binaries can hide in libexec so they don't clutter up the global namespace. This also makes it a lot easier to write man pages, adopt the same style as git uses. Compatibilty wrapper scripts are provided for libinput-list-devices and libinput-debug events. These warn the user about the changed command, then exec the new one. Expect these wrappers to be removed at some point in the future. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-05-25 10:12:26 +10:00
.PP
tools: tidy up the libinput man pages again Make the libinput page more generic but suitable for short attention spans and most importantly, point to the xf86-input-libinput man page in a more obvious manner since we're now shadowing that. The rest of the man pages have punctuation and formatting cleanups only. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-07-03 13:33:20 +10:00
The man page for the X.Org xf86-input-libinput driver is
.B libinput(4).
tools: switch the libinput tool to be an exec-ing tool Chaining args together inside a single binary would be nice, but it gets nasty quickly (as I found out adding 3, 4 extra commands). Switch over to using a git-style exec-ing command where libinput merely changes argv[0] and then executes whatever it assembled. And those binaries can hide in libexec so they don't clutter up the global namespace. This also makes it a lot easier to write man pages, adopt the same style as git uses. Compatibilty wrapper scripts are provided for libinput-list-devices and libinput-debug events. These warn the user about the changed command, then exec the new one. Expect these wrappers to be removed at some point in the future. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-05-25 10:12:26 +10:00
.SH OPTIONS
tools: add a 'libinput' tool This tool will eventually replace the different libinput tools we ship atm with the various functionalities being commands to the single tool, rather than multiple tools. Right now, we still build both tools separately. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-05-11 13:11:23 +10:00
.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
tools: add a 'libinput' tool This tool will eventually replace the different libinput tools we ship atm with the various functionalities being commands to the single tool, rather than multiple tools. Right now, we still build both tools separately. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-05-11 13:11:23 +10:00
Print help and exit
.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 \-\-version
tools: add a 'libinput' tool This tool will eventually replace the different libinput tools we ship atm with the various functionalities being commands to the single tool, rather than multiple tools. Right now, we still build both tools separately. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-05-11 13:11:23 +10:00
Print the version and exit
.SH COMMANDS
tools: hook libinput-debug-events into the libinput tool Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-05-11 13:44:36 +10:00
.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 libinput\-debug\-events(1)
tools: tidy up the libinput man pages again Make the libinput page more generic but suitable for short attention spans and most importantly, point to the xf86-input-libinput man page in a more obvious manner since we're now shadowing that. The rest of the man pages have punctuation and formatting cleanups only. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-07-03 13:33:20 +10:00
Print all events as seen by libinput
tools: add a 'libinput' tool This tool will eventually replace the different libinput tools we ship atm with the various functionalities being commands to the single tool, rather than multiple tools. Right now, we still build both tools separately. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-05-11 13:11:23 +10:00
.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 libinput\-debug\-gui(1)
tools: tidy up the libinput man pages again Make the libinput page more generic but suitable for short attention spans and most importantly, point to the xf86-input-libinput man page in a more obvious manner since we're now shadowing that. The rest of the man pages have punctuation and formatting cleanups only. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-07-03 13:33:20 +10:00
Show a GUI to visualize libinput's events
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
.TP 8
tools: add a tablet debugging tool Nothing sophisticated but easier to debug certain tablet oddities. It shows a bar for each axis on the tablet (and the evdev axis) and prints that relative to the axis range. This makes it easy to check if we do hit the full range (especially for distance/pressure/tilt) and whether that matches with what the device gives us. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2019-11-05 16:17:01 +10:00
.B libinput\-debug\-tablet(1)
A commandline tool to debug tablet axis values
.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 libinput\-list\-devices(1)
tools: tidy up the libinput man pages again Make the libinput page more generic but suitable for short attention spans and most importantly, point to the xf86-input-libinput man page in a more obvious manner since we're now shadowing that. The rest of the man pages have punctuation and formatting cleanups only. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-07-03 13:33:20 +10:00
List all devices recognized by libinput
tools: add "libinput measure touchpad-tap" This is the first tool of many more to come to enable users to gather information aobut their devices and/or usage of these devices. Previously, these required the users to record events, submit them to a bugzilla, have me run various scripts over it and then decree that the scripts have spoken. Push some of this into the hands of the users so they can query the numbers locally and start investigating (or at least get an idea of what's happening). This tool measures the time deltas between touch up and touch down and prints a basic summary, together with the ability to print a dat file with the data for visualization by e.g. gnuplot. Eventually, more of the current analysis scripts will be moved into this or other helpers. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-05-23 15:07:31 +10:00
.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 libinput\-measure(1)
tools: tidy up the libinput man pages again Make the libinput page more generic but suitable for short attention spans and most importantly, point to the xf86-input-libinput man page in a more obvious manner since we're now shadowing that. The rest of the man pages have punctuation and formatting cleanups only. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-07-03 13:33:20 +10:00
Measure various properties of devices
tools: add "libinput measure touchpad-tap" This is the first tool of many more to come to enable users to gather information aobut their devices and/or usage of these devices. Previously, these required the users to record events, submit them to a bugzilla, have me run various scripts over it and then decree that the scripts have spoken. Push some of this into the hands of the users so they can query the numbers locally and start investigating (or at least get an idea of what's happening). This tool measures the time deltas between touch up and touch down and prints a basic summary, together with the ability to print a dat file with the data for visualization by e.g. gnuplot. Eventually, more of the current analysis scripts will be moved into this or other helpers. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-05-23 15:07:31 +10:00
.TP 8
tools: add a libinput-record tool This is a tool that does effectively the same job as evemu-record. evemu has two disadvantages: its API is clunky and hard to extend even for simple features. And it has a custom file format that requires special processing but is difficult to extend and hard to write manually. e.g. the bitmasks require keeping a line number state to know which bit an entry refers to. libinput-record records the same data but the output is YAML. That can be processed easier and extended in the future without breaking the parsing. We can (in the future) also interleave the evemu output with libinput's debug output, thus having a single file where the events can be compared and analysed without the need for replaying. Likewise, we can easily annotate the file with parsable bits of information without having to shove all that into a comment (like version numbers of libinput, kernel, etc). User-visible differences to evemu-record: * the output file requires an explicit -o or --output-file argument * no evemu-describe equivalent, if you just want the description simply cancel before any events are sent * to see key codes, a --show-keycodes flag must be supplied, otherwise all 'normal' keys end up as KEY_A. This protects against inadvertent information leakage * supports a --multiple option to record multiple devices simultaneously. All recordings have the same time offset, it is thus possible to reproduce bugs that depend on the interaction of more than one device. And to answer the question of: why a printf-approach to writing out yaml instead of a library, it's simply that we want to be able to have real-time output of the recording. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-11-23 11:01:45 +10:00
.B libinput\-record(1)
Record the events from a device
.TP 8
.B libinput\-replay(1)
Replay the events from a device
man: install the analyze per-slot-delta man page And add libinput analyze to the main libinput man page Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2020-03-20 16:09:28 +10:00
.TP 8
.B libinput\-analyze(1)
Analyze events from a device
tools: add a libinput test tool as entry point for our test suites We already install libinput-test-suite if the meson option install-tests is set, see commit be7045cdc70d8c026d981997852cc706dab3d5b8 test: make the test suite runner available as installed binary To make other tests easily available and more discoverable, add a new tool "libinput test" with the matching man page. This will also help us to enforce some of the namespacing a bit better. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2022-05-06 10:51:33 +10:00
.TP 8
.B libinput\-test(1)
Test libinput itself.
tools: switch the libinput tool to be an exec-ing tool Chaining args together inside a single binary would be nice, but it gets nasty quickly (as I found out adding 3, 4 extra commands). Switch over to using a git-style exec-ing command where libinput merely changes argv[0] and then executes whatever it assembled. And those binaries can hide in libexec so they don't clutter up the global namespace. This also makes it a lot easier to write man pages, adopt the same style as git uses. Compatibilty wrapper scripts are provided for libinput-list-devices and libinput-debug events. These warn the user about the changed command, then exec the new one. Expect these wrappers to be removed at some point in the future. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-05-25 10:12:26 +10:00
.SH LIBINPUT
Part of the
.B libinput(1)
suite
tools: add a 'libinput' tool This tool will eventually replace the different libinput tools we ship atm with the various functionalities being commands to the single tool, rather than multiple tools. Right now, we still build both tools separately. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-05-11 13:11:23 +10:00
.PP
.SH SEE ALSO
libinput(4)
tools: link to the online documentation from the libinput(1) man page Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-05-25 17:46:07 +10:00
.PP
libinput's online documentation
.I https://wayland.freedesktop.org/libinput/doc/latest/
Reference in a new issue Copy permalink