tools/xkbcli-interactive-evdev.1

   1 .Dd July 27, 2020
   2 .Dt XKBCLI\-INTERACTIVE\-EVDEV 1
   3 .Os
   4 .
   5 .Sh NAME
   6 .Nm "xkbcli interactive\-evdev"
   7 .Nd interactive debugger for XKB keymaps
   8 .
   9 .Sh SYNOPSIS
  10 .Nm
  11 .Op Ar options
  12 .
  13 .Sh DESCRIPTION
  14 .Nm
  15 is a commandline tool to interactively debug XKB keymaps by listening to
  16 .Pa /dev/input/eventX
  17 evdev devices.
  18 .
  19 .Pp
  20 .Nm
  21 requires permission to open the evdev device nodes.
  22 This usually requires being the
  23 .Dq root
  24 user or belonging to the
  25 .Dq input
  26 group.
  27 .
  28 .Pp
  29 Press the
  30 .Aq Escape
  31 key to exit.
  32 .
  33 .Pp
  34 This is a debugging tool, its behavior or output is not guaranteed to be stable.
  35 .
  36 .Bl -tag -width Ds
  37 .It Fl \-help
  38 Print help and exit
  39 .
  40 .It Fl \-rules Ar rules
  41 The XKB ruleset
  42 .
  43 .It Fl \-model Ar model
  44 The XKB model
  45 .
  46 .It Fl \-layout Ar layout
  47 The XKB layout
  48 .
  49 .It Fl \-variant Ar variant
  50 The XKB layout variant
  51 .
  52 .It Fl \-option Ar options
  53 The XKB options
  54 .
  55 .It Fl \-keymap Ar file
  56 Specify a keymap path.
  57 This option is mutually exclusive with the RMLVO options.
  58 .
  59 .It Fl \-report\-state\-changes
  60 Report changes to the keyboard state
  61 .
  62 .It Fl \-enable\-compose
  63 Enable Compose functionality
  64 .
  65 .It Fl \-consumed\-mode Brq xkb|gtk
  66 Set the consumed modifiers mode (default: xkb)
  67 .
  68 .It Fl \-without\-x11\-offset
  69 Don't add an offset of 8 when converting an evdev keycode to an XKB keycode.
  70 You probably don't want this option.
  71 .El
  72 .
  73 .Sh SEE ALSO
  74 .Xr xkbcli 1 ,
  75 .Xr xkbcli\-interactive\-wayland 1 ,
  76 .Xr xkbcli\-interactive\-x11 1 ,
  77 .Lk https://xkbcommon.org "The libxkbcommon online documentation"