Skip to content

Latest commit

 

History

History
48 lines (37 loc) · 1.33 KB

README.md

File metadata and controls

48 lines (37 loc) · 1.33 KB
Raw

wshowkeys

Displays keypresses on screen on supported Wayland compositors (requires wlr_layer_shell_v1 support).

GIF Demo

Forked from https://git.sr.ht/~sircmpwn/wshowkeys as Drew has moved onto other things. And then forked from https://github.com/ammgws/wshowkeys/ to make cosmetic changes.

Installation

Dependencies:

  • cairo
  • libinput
  • pango
  • udev
  • wayland
  • xkbcommon
$ meson build
$ ninja -C build
# ninja -C build install
# chmod a+s /usr/bin/wshowkeys

wshowkeys must be configured as setuid during installation. It requires root permissions to read input events. These permissions are dropped after startup.

Usage

A Nerd Font is recommended for the best results.

wshowkeys [-b|-f|-s #RRGGBB[AA]] [-F font] [-t timeout]
    [-a top|left|right|bottom] [-m margin] [-o output]
  • -b #RRGGBB[AA]: set background color
  • -f #RRGGBB[AA]: set foreground color
  • -s #RRGGBB[AA]: set color for special keys
  • -F font: set font (Pango format, e.g. 'monospace 24')
  • -t timeout: set timeout before clearing old keystrokes
  • -a top|left|right|bottom: anchor the keystrokes to an edge. May be specified twice.
  • -m margin: set a margin (in pixels) from the nearest edge
  • -o output: request wshowkeys is shown on the specified output (unimplemented)