xkbcli.1 2.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192
  1. .Dd June 4, 2024
  2. .Dt XKBCLI 1
  3. .Os
  4. .
  5. .Sh NAME
  6. .Nm xkbcli
  7. .Nd tool to interact with X Keyboard keymaps
  8. .
  9. .Sh SYNOPSIS
  10. .Nm
  11. .Ar command Bo arguments Bc
  12. .
  13. .Nm
  14. .Op Fl \-help | Fl \-version
  15. .
  16. .Sh DESCRIPTION
  17. .Nm
  18. is a commandline tool to query, compile and test XKB keymaps, layouts and other elements.
  19. .
  20. .Bl -tag -width Ds
  21. .It Fl h, \-help
  22. Print help and exit
  23. .
  24. .It Fl V, \-version
  25. Print the version and exit
  26. .El
  27. .
  28. .Ss COMMANDS
  29. .Bl -tag -width Ds
  30. .It Ic info
  31. Print information about libxkbcommon configuration
  32. .It Ic compile\-keymap
  33. Compile an XKB keymap, see
  34. .Xr xkbcli\-compile\-keymap 1
  35. .
  36. .It Ic compile\-compose
  37. Compile a compose file, see
  38. .Xr xkbcli\-compile\-compose 1
  39. .
  40. .It Ic how\-to\-type
  41. Show how to type a given Unicode codepoint, see
  42. .Xr xkbcli\-how\-to\-type 1
  43. .
  44. .It Ic interactive
  45. Interactive debugger for XKB keymaps that automatically select from the
  46. following backends, if available: Wayland, X11 and evdev.
  47. See the corresponding entries hereinafter.
  48. .
  49. .It Ic interactive\-evdev
  50. Interactive debugger for XKB keymaps for evdev, see
  51. .Xr xkbcli\-interactive\-evdev 1
  52. .
  53. .It Ic interactive\-wayland
  54. Interactive debugger for XKB keymaps for Wayland, see
  55. .Xr xkbcli\-interactive\-wayland 1
  56. .
  57. .It Ic interactive\-x11
  58. Interactive debugger for XKB keymaps for X11, see
  59. .Xr xkbcli\-interactive\-x11 1
  60. .
  61. .It Ic dump\-keymap
  62. Dump an XKB keymap from a Wayland or X11 compositor, see the corresponding
  63. entries hereinafter.
  64. .
  65. .It Ic dump\-keymap\-wayland
  66. Dump an XKB keymap from a Wayland compositor, see
  67. .Xr xkbcli\-dump\-keymap\-wayland 1
  68. .
  69. .It Ic dump\-keymap\-x11
  70. Dump an XKB keymap from an X server, see
  71. .Xr xkbcli\-dump\-keymap\-x11 1
  72. .
  73. .It Ic list
  74. List available layouts and more, see
  75. .Xr xkbcli\-list 1
  76. .El
  77. .
  78. .Pp
  79. Note that not all tools may be available on your system.
  80. .
  81. .Sh EXIT STATUS
  82. .Bl -tag -compact -width Ds
  83. .It 0
  84. exited successfully
  85. .It 1
  86. an error occured
  87. .It 2
  88. program was called with invalid arguments
  89. .El
  90. .
  91. .Sh SEE ALSO
  92. .Lk https://xkbcommon.org "The libxkbcommon online documentation"