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

63 lines
1.6 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 "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: 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: 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\-touchpad\-tap(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 tap-to-click time
tools: add a tool to measure touch pressure And update the documentation for how to use the new tool. It's much more interactive than evemu and easier to grasp, so let's advertise that. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-06-27 14:16:57 +10:00
.TP 8
.B libinput\-measure\-touchpad\-pressure(1)
Measure touch pressure.
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