kc3-lang/libxkbcommon/tools/xkbcli.1

Branch : - branch - android master - tag -

• Show log

  Commit

• Author : Alexander Ziaee
  Date : 2024-06-04 07:03:10
  Hash : a4f62fcd
  Message : doc (manuals): clean and expand apropos results Previously on FreeBSD/mandoc (probably affecting others), everything except xkbcli was being listed twice and wrapping on standard console in apropos because mdoc(7) names should not have spaces or be different than the title. Further, xkb is already parsed in search results by being in the name, so expand xkb to "X keyboard" so that they match for apropos keyboard. We did this already in xkbutils, which matches setxkbmap. These don't need to be quoted literals, and - doesn't need to be escaped, but I left them because there may be environments which are not to spec, but I'm happy to ammend this commit if that cleanup seems desirable. Co-authored-by: Ran Benita <ran@unusedvar.com>

• tools/xkbcli.1

• .Dd June 4, 2024
  .Dt XKBCLI 1
  .Os
  .
  .Sh NAME
  .Nm xkbcli
  .Nd tool to interact with X Keyboard keymaps
  .
  .Sh SYNOPSIS
  .Nm
  .Ar command Bo arguments Bc
  .
  .Nm
  .Op Fl \-help | Fl \-version
  .
  .Sh DESCRIPTION
  .Nm
  is a commandline tool to query, compile and test XKB keymaps, layouts and other elements.
  .
  .Bl -tag -width Ds
  .It Fl \-help
  Print help and exit
  .
  .It Fl \-version
  Print the version and exit
  .El
  .
  .Ss COMMANDS
  .Bl -tag -width Ds
  .It Ic compile\-keymap
  Compile an XKB keymap, see
  .Xr xkbcli\-compile\-keymap 1
  .
  .It Ic compile\-compose
  Compile a compose file, see
  .Xr xkbcli\-compile\-compose 1
  .
  .It Ic how\-to\-type
  Show how to type a given Unicode codepoint, see
  .Xr xkbcli\-how\-to\-type 1
  .
  .It Ic interactive\-x11
  Interactive debugger for XKB keymaps for X11, see
  .Xr xkbcli\-interactive\-x11 1
  .
  .It Ic interactive\-wayland
  Interactive debugger for XKB keymaps for Wayland, see
  .Xr xkbcli\-interactive\-wayland 1
  .
  .It Ic interactive\-evdev
  Interactive debugger for XKB keymaps for evdev, see
  .Xr xkbcli\-interactive\-evdev 1
  .
  .It Ic list
  List available layouts and more, see
  .Xr xkbcli\-list 1
  .El
  .
  .Pp
  Note that not all tools may be available on your system.
  .
  .Sh EXIT STATUS
  .Bl -tag -compact -width Ds
  .It 0
  exited successfully
  .It 1
  an error occured
  .It 2
  program was called with invalid arguments
  .El
  .
  .Sh SEE ALSO
  .Lk https://xkbcommon.org "The libxkbcommon online documentation"