tools: switch interactive-evdev to getopt_long
[platform/upstream/libxkbcommon.git] / tools / xkbcli.1.ronn
1 # xkbcli(1) - tool to interact with XKB keymaps
2
3 ## SYNOPSIS
4
5 **xkbcli** [--help|--version] &lt;command&gt; [<args>]
6
7 ## DESCRIPTION
8
9 **xkbcli** is a commandline tool to query, compile and test XKB keymaps,
10 layouts and other elements.
11
12 ## OPTIONS
13
14   * `--help`:
15       Print help and exit
16
17   * `--version`:
18       Print the version and exit
19
20 ## COMMANDS
21
22   * `how-to-type`:
23       Show how to type a given unicode codepoint, see
24       `xkbcli-how-to-type`(1)
25
26   * `interactive-x11`:
27       Interactive debugger for XKB maps for X11, see `xbkcli-interactive-x11`(1)
28
29   * `interactive-wayland`:
30       Interactive debugger for XKB maps for Wayland, see
31       `xkbcli-interactive-wayland`(1)
32
33   * `interactive-evdev`:
34       Interactive debugger for XKB maps for evdev, see
35       `xkbcli-interactive-evdev`
36
37   * `list`:
38       List available layouts and more, see `xkbcli-list`(1)
39
40 Note that not all tools may be available on your system.
41
42 ## EXIT STATUS
43
44   * 0:
45     exited successfully
46   * 1:
47     an error occured
48   * 2:
49     program was called with invalid arguments
50
51 ## SEE ALSO
52
53 The libxkbcommon online documentation at <https://xkbcommon.org>