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

66 lines
1.2 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 1
.Os
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
.Sh NAME
.Nm xkbcli
.Nd tool to interact with XKB keymaps
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
.Sh SYNOPSIS
.Nm
.Ar command Bo arguments Bc
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
.Nm
.Op Fl \-help | Fl \-version
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
.Sh DESCRIPTION
.Nm
is a commandline tool to query, compile and test XKB keymaps, layouts and other elements.
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
.
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 \-version
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 the version and exit
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
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
.Ss COMMANDS
.Bl -tag -width Ds
.It Ic how\-to\-type
Show how to type a given Unicode codepoint, see
.Xr xkbcli\-how\-to\-type 1
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 Ic interactive\-x11
Interactive debugger for XKB keymaps for X11, see
.Xr xkbcli\-interactive\-x11 1
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 Ic interactive\-wayland
Interactive debugger for XKB keymaps for Wayland, see
.Xr xkbcli\-interactive\-wayland 1
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 Ic interactive\-evdev
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
Interactive debugger for XKB keymaps for evdev, see
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
.Xr xkbcli\-interactive\-evdev 1
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 Ic list
List available layouts and more, see
.Xr xkbcli\-list 1
.El
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
.Pp
tools: some minor changes to xkbcli Signed-off-by: Ran Benita <ran@unusedvar.com>
2020-07-25 02:17:11 -06:00
Note that not all tools may be available on your system.
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
.Sh EXIT STATUS
.Bl -tag -compact -width Ds
.It 0
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
exited successfully
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 1
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
an error occured
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 2
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
program was called with invalid arguments
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
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
.Sh SEE ALSO
.Lk https://xkbcommon.org "The libxkbcommon online documentation"