62502914a2a5390d016790ae883f3d1359978328
[platform/upstream/libxkbcommon.git] / tools / xkbcli.1
1 .TH "XKBCLI" "1" "" "" "libxkbcommon manual"
2 .
3 .SH "NAME"
4 \fBxkbcli\fR \- tool to interact with XKB keymaps
5 .
6 .SH "SYNOPSIS"
7 \fBxkbcli\fR [\-\-help|\-\-version] <command> [\fIargs\fR]
8 .
9 .SH "DESCRIPTION"
10 \fBxkbcli\fR is a commandline tool to query, compile and test XKB keymaps, layouts and other elements.
11 .
12 .SH "OPTIONS"
13 .
14 .TP
15 .B \-\-help
16 Print help and exit
17 .
18 .TP
19 .B \-\-version
20 Print the version and exit
21 .
22 .SH "COMMANDS"
23 .
24 .TP
25 .B how\-to\-type
26 Show how to type a given Unicode codepoint, see \fBxkbcli\-how\-to\-type\fR(1)
27 .
28 .TP
29 .B interactive\-x11
30 Interactive debugger for XKB keymaps for X11, see \fBxbkcli\-interactive\-x11\fR(1)
31 .
32 .TP
33 .B interactive\-wayland
34 Interactive debugger for XKB keymaps for Wayland, see \fBxkbcli\-interactive\-wayland\fR(1)
35 .
36 .TP
37 .B interactive\-evdev
38 Interactive debugger for XKB keymaps for evdev (Linux), see \fBxkbcli\-interactive\-evdev\fR
39 .
40 .TP
41 .B list
42 List available layouts and more, see \fBxkbcli\-list\fR(1)
43 .
44 .P
45 Note that not all tools may be available on your system.
46 .
47 .SH "EXIT STATUS"
48 .
49 .TP
50 0
51 exited successfully
52 .
53 .TP
54 1
55 an error occured
56 .
57 .TP
58 2
59 program was called with invalid arguments
60 .
61 .SH "SEE ALSO"
62 The
63 .UR https://xkbcommon.org
64 libxkbcommon online documentation
65 .UE