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 \-include Ar PATH
  41 Add the given path to the include path list.
  42 This option is order\-dependent, include paths given first are searched first.
  43 If an include path is given, the default include path list is not used.
  44 Use
  45 .Fl -\-include\-defaults
  46 to add the default include paths.
  47 .
  48 .It Fl \-include\-defaults
  49 Add the default set of include directories.
  50 This option is order-dependent, include paths given first are searched first.
  51 .
  52 .It Fl \-rules Ar rules
  53 The XKB ruleset
  54 .
  55 .It Fl \-model Ar model
  56 The XKB model
  57 .
  58 .It Fl \-layout Ar layout
  59 The XKB layout
  60 .
  61 .It Fl \-variant Ar variant
  62 The XKB layout variant
  63 .
  64 .It Fl \-option Ar options
  65 The XKB options
  66 .
  67 .It Fl \-keymap Ar file
  68 Specify a keymap path.
  69 This option is mutually exclusive with the RMLVO options.
  70 .
  71 .It Fl \-report\-state\-changes
  72 Report changes to the keyboard state
  73 .
  74 .It Fl \-enable\-compose
  75 Enable Compose functionality
  76 .
  77 .It Fl \-consumed\-mode Brq xkb|gtk
  78 Set the consumed modifiers mode (default: xkb)
  79 .
  80 .It Fl \-without\-x11\-offset
  81 Don't add an offset of 8 when converting an evdev keycode to an XKB keycode.
  82 You probably don't want this option.
  83 .El
  84 .
  85 .Sh SEE ALSO
  86 .Xr xkbcli 1 ,
  87 .Xr xkbcli\-interactive\-wayland 1 ,
  88 .Xr xkbcli\-interactive\-x11 1 ,
  89 .Lk https://xkbcommon.org "The libxkbcommon online documentation"