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

• Show log

  Commit

• Hash : 5cfd36ab
  Author :
  Date : 2025-02-14T10:35:49
  

  tools: Do not load names from the environment by default
  
  Our tools are debugging tools and as such we need to have complete
  control to be able to reproduce setups. This is not currently the case,
  as we do not use `XKB_CONTEXT_NO_ENVIRONMENT_NAMES` by default nor can
  we set it.
  
  So it is very easy to forget about the various `XKB_DEFAULT_*`
  environement variables for the default RMLVO values, then to get puzzled
  by unexpected results.
  
  Added to that, these environment variables do not work correctly in
  `xkbcli-compile-xeymap`: calling the tool without RMLVO values will
  use these variables only if the RMLVO values are set explicitly empty or
  if the various *constants* `DEFAULT_XKB_*` are empty. This is unexpected,
  as the environment variables should *always* be used unless:
  
  - `XKB_CONTEXT_NO_ENVIRONMENT_NAMES` is used (not the case here);
  - the variable is empty; in this case the constants `DEFAULT_XKB_*` are
    used.
  
  Fixed by the following *breaking change*: make the tools use
  `XKB_CONTEXT_NO_ENVIRONMENT_NAMES` *by default*, unless the new
  `--enable-environment-names` option is used.
  
  We also make `rmlvo` incompatible with `--enable-environment-names` for
  now in the public tool, as else it requires a private API.
  

Download

• 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
  .Op Ar KEYMAP_PATH
  .
  .Sh DESCRIPTION
  .Nm
  compiles and prints a keymap based on the given options.
  .
  .Bl -tag -width Ds
  .It Ar KEYMAP_PATH
  Path to a keymap file, or
  .Dq \-
  to read the standard input
  .
  .It Fl \-help
  Print help and exit
  .
  .It Fl \-verbose
  Enable verbose debugging output
  .
  .It Fl \-test
  Test compilation but do not print the keymap
  .
  .It Fl \-rmlvo
  Print the full RMLVO with the defaults filled in for missing elements
  .
  .It Fl \-keymap Oo Ar PATH Oc , Fl \-from\-xkb Oo Ar PATH Oc
  Load the XKB file from a file, ignore RMLVO options. If
  .Ar PATH
  is empty or
  .Dq \- ,
  read the stdin.
  .
  .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
  .
  .It Fl \-enable\-environment\-names
  Allow to set the default RMLVO values via the following environment variables:
  .Bl -dash -compact -hang
  .It
  .Ev XKB_DEFAULT_RULES
  .It
  .Ev XKB_DEFAULT_MODEL
  .It
  .Ev XKB_DEFAULT_LAYOUT
  .It
  .Ev XKB_DEFAULT_VARIANT
  .It
  .Ev XKB_DEFAULT_OPTIONS
  .El
  Note that this option may affect the default values of the previous options.
  .
  .El
  .
  .Sh SEE ALSO
  .Xr xkbcli 1 ,
  .Lk https://xkbcommon.org "The libxkbcommon online documentation"
  

Download