tools: convert man pages from man format to mdoc format
[platform/upstream/libxkbcommon.git] / tools / xkbcli.1
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
18 is a commandline tool to query, compile and test XKB keymaps, layouts and other elements.
19 .
20 .Bl -tag -width Ds
21 .It Fl \-help
22 Print help and exit
23 .
24 .It Fl \-version
25 Print the version and exit
26 .El
27 .
28 .Ss COMMANDS
29 .Bl -tag -width Ds
30 .It Ic how\-to\-type
31 Show how to type a given Unicode codepoint, see
32 .Xr xkbcli\-how\-to\-type 1
33 .
34 .It Ic interactive\-x11
35 Interactive debugger for XKB keymaps for X11, see
36 .Xr xkbcli\-interactive\-x11 1
37 .
38 .It Ic interactive\-wayland
39 Interactive debugger for XKB keymaps for Wayland, see
40 .Xr xkbcli\-interactive\-wayland 1
41 .
42 .It Ic interactive\-evdev
43 Interactive debugger for XKB keymaps for evdev (Linux), see
44 .Xr xkbcli\-interactive\-evdev 1
45 .
46 .It Ic list
47 List available layouts and more, see
48 .Xr xkbcli\-list 1
49 .El
50 .
51 .Pp
52 Note that not all tools may be available on your system.
53 .
54 .Sh EXIT STATUS
55 .Bl -tag -compact -width Ds
56 .It 0
57 exited successfully
58 .It 1
59 an error occured
60 .It 2
61 program was called with invalid arguments
62 .El
63 .
64 .Sh SEE ALSO
65 .Lk https://xkbcommon.org "The libxkbcommon online documentation"