README.md
1# wshowkeys
2
3Displays keypresses on screen on supported Wayland compositors (requires
4`wlr_layer_shell_v1` support).
5
6
7
8## Installation
9
10Dependencies:
11
12- cairo
13- libinput
14- pango
15- udev
16- wayland
17- xkbcommon
18
19```
20$ meson build
21$ ninja -C build
22# ninja -C build install
23# chmod a+s /usr/bin/wshowkeys
24```
25
26wshowkeys must be configured as setuid during installation. It requires root
27permissions to read input events. These permissions are dropped after startup.
28
29## Usage
30
31```
32wshowkeys [-b|-f|-s #RRGGBB[AA]] [-F font] [-t timeout]
33 [-a top|left|right|bottom] [-m margin] [-o output]
34```
35
36- *-b #RRGGBB[AA]*: set background color
37- *-f #RRGGBB[AA]*: set foreground color
38- *-s #RRGGBB[AA]*: set color for special keys
39- *-F font*: set font (Pango format, e.g. 'monospace 24')
40- *-t timeout*: set timeout before clearing old keystrokes
41- *-a top|left|right|bottom*: anchor the keystrokes to an edge. May be specified
42 twice.
43- *-m margin*: set a margin (in pixels) from the nearest edge
44- *-o output*: request wshowkeys is shown on the specified output
45 (unimplemented)
46
){kind=link}