ac315fa7588098ae8e179a6bd702f709b07f68f5
[platform/upstream/libxkbcommon.git] / tools / xkbcli-interactive-evdev.1
1 .TH "XKBCLI\-INTERACTIVE\-EVDEV" "1" "" "" "libxkbcommon manual"
2 .
3 .SH "NAME"
4 \fBxkbcli\-interactive\-evdev\fR \- interactive debugger for XKB keymaps
5 .
6 .SH "SYNOPSIS"
7 \fBxkbcli\fR interactive\-evdev [\-\-help] [OPTIONS]
8 .
9 .SH "DESCRIPTION"
10 \fBxkbcli interactive\-evdev\fR is a commandline tool to interactively debug XKB keymaps by listening to \fB/dev/input/eventX\fR evdev devices (Linux).
11 .
12 .P
13 .B xkbcli interactive\-evdev
14 requires permission to open the evdev device nodes.
15 This usually requires being the \fBroot\fR user or belonging to the \fBinput\fR group.
16 .
17 .P
18 Press the Escape key to exit.
19 .
20 .P
21 This is a debugging tool, its behavior or output is not guaranteed to be stable.
22 .
23 .SH "OPTIONS"
24 .
25 .TP
26 .B \-\-help
27 Print help and exit
28 .
29 .TP
30 .B \-\-rules=<rules>
31 The XKB ruleset
32 .
33 .TP
34 .B \-\-model=<model>
35 The XKB model
36 .
37 .TP
38 .B \-\-layout=<layout>
39 The XKB layout
40 .
41 .TP
42 .B \-\-variant=<variant>
43 The XKB layout variant
44 .
45 .TP
46 .B \-\-options=<options>
47 The XKB options
48 .
49 .TP
50 .B \-\-keymap=PATH
51 Specify a keymap path.
52 This option is mutually exclusive with the RMLVO options.
53 .
54 .TP
55 .B \-\-report\-state\-changes
56 Report changes to the keyboard state
57 .
58 .TP
59 .B \-\-enable\-compose
60 Enable Compose functionality
61 .
62 .TP
63 .B \-\-consumed\-mode={xkb|gtk}
64 Set the consumed modifiers mode (default: xkb)
65 .
66 .TP
67 .B \-\-without\-x11\-offset
68 Don't add an offset of 8 when converting an evdev keycode to an XKB keycode.
69 You probably don't want this option.
70 .
71 .SH "SEE ALSO"
72 \fBxkbcli\fR(1), \fBxkbcli\-interactive\-wayland\fR(1), \fBxkbcli\-interactive\-x11\fR(1)
73 .
74 .P
75 The
76 .UR https://xkbcommon.org
77 libxkbcommon online documentation
78 .UE