xref: /aosp_15_r20/external/libxkbcommon/tools/xkbcli.1 (revision 2b949d0487e80d67f1fda82db69e101e761f8064)
1.Dd July 27, 2020
2.Dt XKBCLI 1
3.Os
4.
5.Sh NAME
6.Nm xkbcli
7.Nd tool to interact with XKB keymaps
8.
9.Sh SYNOPSIS
10.Nm
11.Ar command Bo arguments Bc
12.
13.Nm
14.Op Fl \-help | Fl \-version
15.
16.Sh DESCRIPTION
17.Nm
18is a commandline tool to query, compile and test XKB keymaps, layouts and other elements.
19.
20.Bl -tag -width Ds
21.It Fl \-help
22Print help and exit
23.
24.It Fl \-version
25Print the version and exit
26.El
27.
28.Ss COMMANDS
29.Bl -tag -width Ds
30.It Ic compile\-keymap
31Compile an XKB keymap, see
32.Xr xkbcli\-compile\-keymap 1
33
34.It Ic how\-to\-type
35Show how to type a given Unicode codepoint, see
36.Xr xkbcli\-how\-to\-type 1
37.
38.It Ic interactive\-x11
39Interactive debugger for XKB keymaps for X11, see
40.Xr xkbcli\-interactive\-x11 1
41.
42.It Ic interactive\-wayland
43Interactive debugger for XKB keymaps for Wayland, see
44.Xr xkbcli\-interactive\-wayland 1
45.
46.It Ic interactive\-evdev
47Interactive debugger for XKB keymaps for evdev, see
48.Xr xkbcli\-interactive\-evdev 1
49.
50.It Ic list
51List available layouts and more, see
52.Xr xkbcli\-list 1
53.El
54.
55.Pp
56Note that not all tools may be available on your system.
57.
58.Sh EXIT STATUS
59.Bl -tag -compact -width Ds
60.It 0
61exited successfully
62.It 1
63an error occured
64.It 2
65program was called with invalid arguments
66.El
67.
68.Sh SEE ALSO
69.Lk https://xkbcommon.org "The libxkbcommon online documentation"
70