Files
2026-08-03 18:42:47 +08:00

93 lines
1.9 KiB
Groff

.Dd June 4, 2024
.Dt XKBCLI 1
.Os
.
.Sh NAME
.Nm xkbcli
.Nd tool to interact with X Keyboard keymaps
.
.Sh SYNOPSIS
.Nm
.Ar command Bo arguments Bc
.
.Nm
.Op Fl \-help | Fl \-version
.
.Sh DESCRIPTION
.Nm
is a commandline tool to query, compile and test XKB keymaps, layouts and other elements.
.
.Bl -tag -width Ds
.It Fl \-help
Print help and exit
.
.It Fl \-version
Print the version and exit
.El
.
.Ss COMMANDS
.Bl -tag -width Ds
.It Ic info
Print information about libxkbcommon configuration
.It Ic compile\-keymap
Compile an XKB keymap, see
.Xr xkbcli\-compile\-keymap 1
.
.It Ic compile\-compose
Compile a compose file, see
.Xr xkbcli\-compile\-compose 1
.
.It Ic how\-to\-type
Show how to type a given Unicode codepoint, see
.Xr xkbcli\-how\-to\-type 1
.
.It Ic interactive
Interactive debugger for XKB keymaps that automatically select from the
following backends, if available: Wayland, X11 and evdev.
See the corresponding entries hereinafter.
.
.It Ic interactive\-evdev
Interactive debugger for XKB keymaps for evdev, see
.Xr xkbcli\-interactive\-evdev 1
.
.It Ic interactive\-wayland
Interactive debugger for XKB keymaps for Wayland, see
.Xr xkbcli\-interactive\-wayland 1
.
.It Ic interactive\-x11
Interactive debugger for XKB keymaps for X11, see
.Xr xkbcli\-interactive\-x11 1
.
.It Ic dump\-keymap
Dump an XKB keymap from a Wayland or X11 compositor, see the corresponding
entries hereinafter.
.
.It Ic dump\-keymap\-wayland
Dump an XKB keymap from a Wayland compositor, see
.Xr xkbcli\-dump\-keymap\-wayland 1
.
.It Ic dump\-keymap\-x11
Dump an XKB keymap from an X server, see
.Xr xkbcli\-dump\-keymap\-x11 1
.
.It Ic list
List available layouts and more, see
.Xr xkbcli\-list 1
.El
.
.Pp
Note that not all tools may be available on your system.
.
.Sh EXIT STATUS
.Bl -tag -compact -width Ds
.It 0
exited successfully
.It 1
an error occured
.It 2
program was called with invalid arguments
.El
.
.Sh SEE ALSO
.Lk https://xkbcommon.org "The libxkbcommon online documentation"