StreetLight
/
libxkbcommon
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
libxkbcommon/tools/xkbcli-interactive-evdev.1

90 lines
1.9 KiB
Groff
Raw Normal View History

tools: convert man pages from man format to mdoc format The mdoc is more semantic and consistent. Signed-off-by: Ran Benita <ran@unusedvar.com>
2020-07-27 02:24:06 -06:00
.Dd July 27, 2020
.Dt XKBCLI\-INTERACTIVE\-EVDEV 1
.Os
.
.Sh NAME
.Nm "xkbcli interactive\-evdev"
.Nd interactive debugger for XKB keymaps
.
.Sh SYNOPSIS
.Nm
.Op Ar options
.
.Sh DESCRIPTION
.Nm
is a commandline tool to interactively debug XKB keymaps by listening to
.Pa /dev/input/eventX
interactive-evdev: switch from epoll(2) to poll(2) Turns out FreeBSD supports evdev, so this toll can work on it; however it does not support epoll, so switch to poll, which is portable. Reported-by: Evgeniy Khramtsov <evgeniy@khramtsov.org> Signed-off-by: Ran Benita <ran@unusedvar.com>
2021-03-28 03:55:08 -06:00
evdev devices.
tools: convert man pages from man format to mdoc format The mdoc is more semantic and consistent. Signed-off-by: Ran Benita <ran@unusedvar.com>
2020-07-27 02:24:06 -06:00
.
.Pp
.Nm
tools: some minor changes to xkbcli Signed-off-by: Ran Benita <ran@unusedvar.com>
2020-07-25 02:17:11 -06:00
requires permission to open the evdev device nodes.
tools: convert man pages from man format to mdoc format The mdoc is more semantic and consistent. Signed-off-by: Ran Benita <ran@unusedvar.com>
2020-07-27 02:24:06 -06:00
This usually requires being the
.Dq root
user or belonging to the
.Dq input
group.
.
.Pp
Press the
.Aq Escape
key to exit.
.
.Pp
tools: some minor changes to xkbcli Signed-off-by: Ran Benita <ran@unusedvar.com>
2020-07-25 02:17:11 -06:00
This is a debugging tool, its behavior or output is not guaranteed to be stable.
Drop use of ronn, switch to raw roff instead Drop the ronn source files, check in the generated files instead. This gets rid of the ruby+gem+ronn toolchain requirement at the cost of having to edit raw man pages. ronn files are as-generated but with the preamble and generation date removed. The latter isn't important enough to keep, it'll just go stale for manually maintained files and it's not worth setting up a configure_file() just for that date. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2020-07-22 17:37:15 -06:00
.
tools: convert man pages from man format to mdoc format The mdoc is more semantic and consistent. Signed-off-by: Ran Benita <ran@unusedvar.com>
2020-07-27 02:24:06 -06:00
.Bl -tag -width Ds
.It Fl \-help
Drop use of ronn, switch to raw roff instead Drop the ronn source files, check in the generated files instead. This gets rid of the ruby+gem+ronn toolchain requirement at the cost of having to edit raw man pages. ronn files are as-generated but with the preamble and generation date removed. The latter isn't important enough to keep, it'll just go stale for manually maintained files and it's not worth setting up a configure_file() just for that date. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2020-07-22 17:37:15 -06:00
Print help and exit
.
interactive-evdev: includes options Currently there is no interactive tool allowing to set the include paths of the context, such as in "compile-keymap". Note that only "interactive-evdev" makes sense, because it does not rely on a compositor. Add --include and --include-defaults to "interactive-evdev" tool. The code is adapted from "compile-keymap".
2023-06-16 01:54:09 -06:00
.It Fl \-include Ar PATH
Add the given path to the include path list.
This option is order\-dependent, include paths given first are searched first.
If an include path is given, the default include path list is not used.
Use
.Fl -\-include\-defaults
to add the default include paths.
.
.It Fl \-include\-defaults
Add the default set of include directories.
This option is order-dependent, include paths given first are searched first.
.
tools: convert man pages from man format to mdoc format The mdoc is more semantic and consistent. Signed-off-by: Ran Benita <ran@unusedvar.com>
2020-07-27 02:24:06 -06:00
.It Fl \-rules Ar rules
Drop use of ronn, switch to raw roff instead Drop the ronn source files, check in the generated files instead. This gets rid of the ruby+gem+ronn toolchain requirement at the cost of having to edit raw man pages. ronn files are as-generated but with the preamble and generation date removed. The latter isn't important enough to keep, it'll just go stale for manually maintained files and it's not worth setting up a configure_file() just for that date. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2020-07-22 17:37:15 -06:00
The XKB ruleset
.
tools: convert man pages from man format to mdoc format The mdoc is more semantic and consistent. Signed-off-by: Ran Benita <ran@unusedvar.com>
2020-07-27 02:24:06 -06:00
.It Fl \-model Ar model
Drop use of ronn, switch to raw roff instead Drop the ronn source files, check in the generated files instead. This gets rid of the ruby+gem+ronn toolchain requirement at the cost of having to edit raw man pages. ronn files are as-generated but with the preamble and generation date removed. The latter isn't important enough to keep, it'll just go stale for manually maintained files and it's not worth setting up a configure_file() just for that date. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2020-07-22 17:37:15 -06:00
The XKB model
.
tools: convert man pages from man format to mdoc format The mdoc is more semantic and consistent. Signed-off-by: Ran Benita <ran@unusedvar.com>
2020-07-27 02:24:06 -06:00
.It Fl \-layout Ar layout
Drop use of ronn, switch to raw roff instead Drop the ronn source files, check in the generated files instead. This gets rid of the ruby+gem+ronn toolchain requirement at the cost of having to edit raw man pages. ronn files are as-generated but with the preamble and generation date removed. The latter isn't important enough to keep, it'll just go stale for manually maintained files and it's not worth setting up a configure_file() just for that date. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2020-07-22 17:37:15 -06:00
The XKB layout
.
tools: convert man pages from man format to mdoc format The mdoc is more semantic and consistent. Signed-off-by: Ran Benita <ran@unusedvar.com>
2020-07-27 02:24:06 -06:00
.It Fl \-variant Ar variant
Drop use of ronn, switch to raw roff instead Drop the ronn source files, check in the generated files instead. This gets rid of the ruby+gem+ronn toolchain requirement at the cost of having to edit raw man pages. ronn files are as-generated but with the preamble and generation date removed. The latter isn't important enough to keep, it'll just go stale for manually maintained files and it's not worth setting up a configure_file() just for that date. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2020-07-22 17:37:15 -06:00
The XKB layout variant
.
tools: convert man pages from man format to mdoc format The mdoc is more semantic and consistent. Signed-off-by: Ran Benita <ran@unusedvar.com>
2020-07-27 02:24:06 -06:00
.It Fl \-option Ar options
Drop use of ronn, switch to raw roff instead Drop the ronn source files, check in the generated files instead. This gets rid of the ruby+gem+ronn toolchain requirement at the cost of having to edit raw man pages. ronn files are as-generated but with the preamble and generation date removed. The latter isn't important enough to keep, it'll just go stale for manually maintained files and it's not worth setting up a configure_file() just for that date. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2020-07-22 17:37:15 -06:00
The XKB options
.
tools: convert man pages from man format to mdoc format The mdoc is more semantic and consistent. Signed-off-by: Ran Benita <ran@unusedvar.com>
2020-07-27 02:24:06 -06:00
.It Fl \-keymap Ar file
tools: some minor changes to xkbcli Signed-off-by: Ran Benita <ran@unusedvar.com>
2020-07-25 02:17:11 -06:00
Specify a keymap path.
This option is mutually exclusive with the RMLVO options.
Drop use of ronn, switch to raw roff instead Drop the ronn source files, check in the generated files instead. This gets rid of the ruby+gem+ronn toolchain requirement at the cost of having to edit raw man pages. ronn files are as-generated but with the preamble and generation date removed. The latter isn't important enough to keep, it'll just go stale for manually maintained files and it's not worth setting up a configure_file() just for that date. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2020-07-22 17:37:15 -06:00
.
tools: convert man pages from man format to mdoc format The mdoc is more semantic and consistent. Signed-off-by: Ran Benita <ran@unusedvar.com>
2020-07-27 02:24:06 -06:00
.It Fl \-report\-state\-changes
Drop use of ronn, switch to raw roff instead Drop the ronn source files, check in the generated files instead. This gets rid of the ruby+gem+ronn toolchain requirement at the cost of having to edit raw man pages. ronn files are as-generated but with the preamble and generation date removed. The latter isn't important enough to keep, it'll just go stale for manually maintained files and it's not worth setting up a configure_file() just for that date. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2020-07-22 17:37:15 -06:00
Report changes to the keyboard state
.
tools: convert man pages from man format to mdoc format The mdoc is more semantic and consistent. Signed-off-by: Ran Benita <ran@unusedvar.com>
2020-07-27 02:24:06 -06:00
.It Fl \-enable\-compose
tools: some minor changes to xkbcli Signed-off-by: Ran Benita <ran@unusedvar.com>
2020-07-25 02:17:11 -06:00
Enable Compose functionality
Drop use of ronn, switch to raw roff instead Drop the ronn source files, check in the generated files instead. This gets rid of the ruby+gem+ronn toolchain requirement at the cost of having to edit raw man pages. ronn files are as-generated but with the preamble and generation date removed. The latter isn't important enough to keep, it'll just go stale for manually maintained files and it's not worth setting up a configure_file() just for that date. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2020-07-22 17:37:15 -06:00
.
tools: convert man pages from man format to mdoc format The mdoc is more semantic and consistent. Signed-off-by: Ran Benita <ran@unusedvar.com>
2020-07-27 02:24:06 -06:00
.It Fl \-consumed\-mode Brq xkb|gtk
Drop use of ronn, switch to raw roff instead Drop the ronn source files, check in the generated files instead. This gets rid of the ruby+gem+ronn toolchain requirement at the cost of having to edit raw man pages. ronn files are as-generated but with the preamble and generation date removed. The latter isn't important enough to keep, it'll just go stale for manually maintained files and it's not worth setting up a configure_file() just for that date. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2020-07-22 17:37:15 -06:00
Set the consumed modifiers mode (default: xkb)
.
tools: convert man pages from man format to mdoc format The mdoc is more semantic and consistent. Signed-off-by: Ran Benita <ran@unusedvar.com>
2020-07-27 02:24:06 -06:00
.It Fl \-without\-x11\-offset
tools/interactive-evdev: change --evdev-offset to --without-x11-offset There is no reason to give full control rather than just enable/disable. Signed-off-by: Ran Benita <ran@unusedvar.com>
2020-07-27 02:51:53 -06:00
Don't add an offset of 8 when converting an evdev keycode to an XKB keycode.
You probably don't want this option.
tools: convert man pages from man format to mdoc format The mdoc is more semantic and consistent. Signed-off-by: Ran Benita <ran@unusedvar.com>
2020-07-27 02:24:06 -06:00
.El
tools/interactive-evdev: change --evdev-offset to --without-x11-offset There is no reason to give full control rather than just enable/disable. Signed-off-by: Ran Benita <ran@unusedvar.com>
2020-07-27 02:51:53 -06:00
.
tools: convert man pages from man format to mdoc format The mdoc is more semantic and consistent. Signed-off-by: Ran Benita <ran@unusedvar.com>
2020-07-27 02:24:06 -06:00
.Sh SEE ALSO
.Xr xkbcli 1 ,
.Xr xkbcli\-interactive\-wayland 1 ,
.Xr xkbcli\-interactive\-x11 1 ,
.Lk https://xkbcommon.org "The libxkbcommon online documentation"