Edit

kc3-lang/libxkbcommon/tools/xkbcli-compile-keymap.1

Branch :

  • 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-compile-keymap.1
  • .Dd June 4, 2024
    .Dt XKBCLI\-COMPILE\-KEYMAP 1
    .Os
    .
    .Sh NAME
    .Nm "xkbcli\-compile\-keymap"
    .Nd compile an X Keyboard keymap
    .
    .Sh SYNOPSIS
    .Nm
    .Op Ar options
    .
    .Sh DESCRIPTION
    .Nm
    compiles and prints a keymap based on the given options.
    .
    .Bl -tag -width Ds
    .It Fl \-help
    Print help and exit
    .
    .It Fl \-verbose
    Enable verbose debugging output
    .
    .It Fl \-rmlvo
    Print the full RMLVO with the defaults filled in for missing elements
    .
    .It Fl \-from\-xkb
    Load the XKB file from stdin, ignore RMLVO options.
    This option must not be used with
    .Fl \-kccgst .
    .
    .It Fl \-include Ar PATH
    Add the given path to the include path list.
    This option is order\-dependent, include paths given first are searched first.
    If an include path is given, the default include path list is not used.
    Use
    .Fl -\-include\-defaults
    to add the default include paths.
    .
    .It Fl \-include\-defaults
    Add the default set of include directories.
    This option is order-dependent, include paths given first are searched first.
    .
    .It Fl \-rules Ar rules
    The XKB ruleset
    .
    .It Fl \-model Ar model
    The XKB model
    .
    .It Fl \-layout Ar layout
    The XKB layout
    .
    .It Fl \-variant Ar variant
    The XKB layout variant
    .
    .It Fl \-options Ar options
    The XKB options
    .El
    .
    .Sh SEE ALSO
    .Xr xkbcli 1 ,
    .Lk https://xkbcommon.org "The libxkbcommon online documentation"