kc3-lang/libxkbcommon/tools/xkbcli-interactive-wayland.1

• Show log

  Commit

• Hash : 09e93fa0
  Author :
  Date : 2025-08-06T10:12:39
  

  tools: Enable custom keymap with interactive-{x11,wayland}
  
  Added the `--keymap` option to enable providing the keymap to use
  instead of the one from the display server. Implies `--local-state`.
  
  Note that the other RMLVO options do not need to be implemented, since
  one can simply pipe a keymap from `xkbcli compile-keymap`.
  
  The `--keymap` option is also useful for users that do not have the
  input permissions to access evdev API.
  

Download

• tools/xkbcli-interactive-wayland.1

• .Dd June 4, 2024
  .Dt XKBCLI\-INTERACTIVE\-WAYLAND 1
  .Os
  .
  .Sh NAME
  .Nm "xkbcli\-interactive\-wayland"
  .Nd interactive debugger for Wayland keyboard keymaps
  .
  .Sh SYNOPSIS
  .Nm
  .Op Ar options
  .
  .Sh DESCRIPTION
  .Nm
  is a commandline tool to interactively debug XKB keymaps by listening to Wayland events.
  .
  .Pp
  This requires a Wayland compositor to be running.
  .
  .Pp
  Press the
  .Aq Escape
  key to exit.
  .
  .Pp
  This is a debugging tool, its behavior or output is not guaranteed to be stable.
  .
  .Bl -tag -width Ds
  .It Fl \-help
  Print help and exit
  .
  .It Fl \-format Ar keymap_format
  Specify the keymap format (numeric or label, e.g.\&
  .Dq v1 )
  .
  .It Fl \-local\-state
  Enable local state handling and ignore modifiers/layouts state updates
  from the compositor
  .
  .It Fl \-keymap Oo Ar PATH Oc
  Load the XKB keymap from a file instead of the keymap from the compositor.
  It implies
  .Fl \-local\-state
  \&. If
  .Ar PATH
  is empty or
  .Dq \- ,
  read the stdin.
  .
  .It Fl \-enable\-compose
  Enable Compose functionality
  .
  .It Fl \-verbose
  Enable verbose debugging output
  .
  .It Fl 1, \-uniline
  Enable uniline event output
  .
  .It Fl \-multiline
  Enable multiline event output
  .El
  .
  .Sh SEE ALSO
  .Xr xkbcli 1 ,
  .Xr xkbcli\-interactive\-evdev 1 ,
  .Xr xkbcli\-interactive\-x11 1 ,
  .Lk https://xkbcommon.org "The libxkbcommon online documentation"
  

Download