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.1

55 lines
1.3 KiB
Groff
Raw Normal View History

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
.TH LIBINPUT "1"
.SH NAME
libinput \- tool to interface with libinput
.SH SYNOPSIS
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 [--help] [--version] <command> [<args>]
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
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: 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
tool creates a libinput context on the default seat "seat0" and interacts
with that libinput context.
.PP
This tool usually needs to be run as root to have access to the
/dev/input/eventX nodes.
.PP
The context created by this tool is a new libinput context and independent
of that created by the X.Org libinput driver, the Wayland compositor or any
other process that utilizes libinput (henceforth called "the caller").
Configuration options set in this context do not affect any other libinput
contexts.
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
Note that a device may be recognized by this tool but not handled by the
X.Org libinput driver or the Wayland compositor.
.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
.B --help
Print help and exit
.TP 8
.B --version
Print the version and exit
.SH COMMANDS
All commands support a
.B --help
argument that prints command-specific usage
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
information, e.g.
.B "libinput debug-events --help".
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: 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-debug-events(1)
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
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
.B libinput-debug-gui(1)
Show a GUI to visualize libinput's events.
.TP 8
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-list-devices(1)
List all devices recognized by libinput.
.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
.PP
libinput(4)
Reference in a new issue Copy permalink