nixos/x11: refactor XKB options into a single attrset

[Motivation](https://github.com/NixOS/nixpkgs/issues/257817#issuecomment-1741705042):

- Having all the XKB options in the same attribute set clarifies their
relation better than using a common option name prefix ("xkb").
- `services.xserver.layout` is an XKB option, but this is not obvious
from its name. Putting it with the other XKB options clarifies this.

Co-authored-by: Michele Guerini Rocco <rnhmjoj@users.noreply.github.com>

Changed files
+114 -81
nixos
doc
manual
configuration
release-notes
modules
config
installer
tools
services
x11
tests
pkgs
tools
X11
xkbvalidate
+3 -3
nixos/doc/manual/configuration/x-windows.chapter.md
···
You can set the keyboard layout (and optionally the layout variant):
```nix
-
services.xserver.layout = "de";
-
services.xserver.xkbVariant = "neo";
+
services.xserver.xkb.layout = "de";
+
services.xserver.xkb.variant = "neo";
```
The X server is started automatically at boot time. If you don't want
···
layout should be ready to use. You can try it by e.g. running
`setxkbmap us-greek` and then type `<alt>+a` (it may not get applied in
your terminal straight away). To change the default, the usual
-
`services.xserver.layout` option can still be used.
+
`services.xserver.xkb.layout` option can still be used.
A layout can have several other components besides `xkb_symbols`, for
example we will define new keycodes for some multimedia key and bind
+2 -1
nixos/doc/manual/release-notes/rl-2311.section.md
···
order, or relying on `mkBefore` and `mkAfter`, but may impact users calling
`mkOrder n` with n ≤ 400.
+
- X keyboard extension (XKB) options have been reorganized into a single attribute set, `services.xserver.xkb`. Specifically, `services.xserver.layout` is now `services.xserver.xkb.layout`, `services.xserver.xkbModel` is now `services.xserver.xkb.model`, `services.xserver.xkbOptions` is now `services.xserver.xkb.options`, `services.xserver.xkbVariant` is now `services.xserver.xkb.variant`, and `services.xserver.xkbDir` is now `services.xserver.xkb.dir`.
+
- `networking.networkmanager.firewallBackend` was removed as NixOS is now using iptables-nftables-compat even when using iptables, therefore Networkmanager now uses the nftables backend unconditionally.
- [`lib.lists.foldl'`](https://nixos.org/manual/nixpkgs/stable#function-library-lib.lists.foldl-prime) now always evaluates the initial accumulator argument first.
···
- The `electron` packages now places its application files in `$out/libexec/electron` instead of `$out/lib/electron`. Packages using electron-builder will fail to build and need to be adjusted by changing `lib` to `libexec`.
- `teleport` has been upgraded from major version 12 to major version 14. Please see upstream [upgrade instructions](https://goteleport.com/docs/management/operations/upgrading/) and release notes for versions [13](https://goteleport.com/docs/changelog/#1300-050823) and [14](https://goteleport.com/docs/changelog/#1400-092023). Note that Teleport does not officially support upgrades across more than one major version at a time. If you're running Teleport server components, it is recommended to first upgrade to an intermediate 13.x version by setting `services.teleport.package = pkgs.teleport_13`. Afterwards, this option can be removed to upgrade to the default version (14).
-
+2 -2
nixos/modules/config/console.nix
···
${optionalString (config.environment.sessionVariables ? XKB_CONFIG_ROOT)
"-I${config.environment.sessionVariables.XKB_CONFIG_ROOT}"
} \
-
-model '${xkbModel}' -layout '${layout}' \
-
-option '${xkbOptions}' -variant '${xkbVariant}' > "$out"
+
-model '${xkb.model}' -layout '${xkb.layout}' \
+
-option '${xkb.options}' -variant '${xkb.variant}' > "$out"
'');
}
+3 -3
nixos/modules/installer/tools/tools.nix
···
# console = {
# font = "Lat2-Terminus16";
# keyMap = "us";
-
# useXkbConfig = true; # use xkbOptions in tty.
+
# useXkbConfig = true; # use xkb.options in tty.
# };
$xserverConfig
$desktopConfiguration
# Configure keymap in X11
-
# services.xserver.layout = "us";
-
# services.xserver.xkbOptions = "eurosign:e,caps:escape";
+
# services.xserver.xkb.layout = "us";
+
# services.xserver.xkb.options = "eurosign:e,caps:escape";
# Enable CUPS to print documents.
# services.printing.enable = true;
+1 -1
nixos/modules/services/x11/desktop-managers/enlightenment.nix
···
};
};
-
environment.etc."X11/xkb".source = xcfg.xkbDir;
+
environment.etc."X11/xkb".source = xcfg.xkb.dir;
fonts.packages = [ pkgs.dejavu_fonts pkgs.ubuntu_font_family ];
+1 -1
nixos/modules/services/x11/desktop-managers/plasma5.nix
···
"/share"
];
-
environment.etc."X11/xkb".source = xcfg.xkbDir;
+
environment.etc."X11/xkb".source = xcfg.xkb.dir;
environment.sessionVariables = {
PLASMA_USE_QT_SCALING = mkIf cfg.useQtScaling "1";
+4 -4
nixos/modules/services/x11/display-managers/sddm.nix
···
left-handed = xcfg.libinput.mouse.leftHanded;
};
keyboard = {
-
keymap_model = xcfg.xkbModel;
-
keymap_layout = xcfg.layout;
-
keymap_variant = xcfg.xkbVariant;
-
keymap_options = xcfg.xkbOptions;
+
keymap_model = xcfg.xkb.model;
+
keymap_layout = xcfg.xkb.layout;
+
keymap_variant = xcfg.xkb.variant;
+
keymap_options = xcfg.xkb.options;
};
}; in "${pkgs.weston}/bin/weston --shell=fullscreen-shell.so -c ${westonIni}";
description = lib.mdDoc "Command used to start the selected compositor";
+2 -2
nixos/modules/services/x11/extra-layouts.nix
···
environment.sessionVariables = {
# runtime override supported by multiple libraries e. g. libxkbcommon
# https://xkbcommon.org/doc/current/group__include-path.html
-
XKB_CONFIG_ROOT = config.services.xserver.xkbDir;
+
XKB_CONFIG_ROOT = config.services.xserver.xkb.dir;
};
services.xserver = {
-
xkbDir = "${xkb_patched}/etc/X11/xkb";
+
xkb.dir = "${xkb_patched}/etc/X11/xkb";
exportConfiguration = config.services.xserver.displayManager.startx.enable
|| config.services.xserver.displayManager.sx.enable;
};
+78 -46
nixos/modules/services/x11/xserver.nix
···
"Use services.xserver.fontPath instead of useXFS")
(mkRemovedOptionModule [ "services" "xserver" "useGlamor" ]
"Option services.xserver.useGlamor was removed because it is unnecessary. Drivers that uses Glamor will use it automatically.")
+
(lib.mkRenamedOptionModuleWith {
+
sinceRelease = 2311;
+
from = [ "services" "xserver" "layout" ];
+
to = [ "services" "xserver" "xkb" "layout" ];
+
})
+
(lib.mkRenamedOptionModuleWith {
+
sinceRelease = 2311;
+
from = [ "services" "xserver" "xkbModel" ];
+
to = [ "services" "xserver" "xkb" "model" ];
+
})
+
(lib.mkRenamedOptionModuleWith {
+
sinceRelease = 2311;
+
from = [ "services" "xserver" "xkbOptions" ];
+
to = [ "services" "xserver" "xkb" "options" ];
+
})
+
(lib.mkRenamedOptionModuleWith {
+
sinceRelease = 2311;
+
from = [ "services" "xserver" "xkbVariant" ];
+
to = [ "services" "xserver" "xkb" "variant" ];
+
})
+
(lib.mkRenamedOptionModuleWith {
+
sinceRelease = 2311;
+
from = [ "services" "xserver" "xkbDir" ];
+
to = [ "services" "xserver" "xkb" "dir" ];
+
})
];
···
'';
};
-
layout = mkOption {
-
type = types.str;
-
default = "us";
-
description = lib.mdDoc ''
-
Keyboard layout, or multiple keyboard layouts separated by commas.
-
'';
-
};
+
xkb = mkOption {
+
description = "X keyboard extension (XKB) configuration";
+
type = types.submodule {
+
options = {
+
layout = mkOption {
+
type = types.str;
+
default = "us";
+
description = lib.mdDoc ''
+
Keyboard layout, or multiple keyboard layouts separated by commas.
+
'';
+
};
-
xkbModel = mkOption {
-
type = types.str;
-
default = "pc104";
-
example = "presario";
-
description = lib.mdDoc ''
-
Keyboard model.
-
'';
-
};
+
model = mkOption {
+
type = types.str;
+
default = "pc104";
+
example = "presario";
+
description = lib.mdDoc ''
+
Keyboard model.
+
'';
+
};
-
xkbOptions = mkOption {
-
type = types.commas;
-
default = "terminate:ctrl_alt_bksp";
-
example = "grp:caps_toggle,grp_led:scroll";
-
description = lib.mdDoc ''
-
X keyboard options; layout switching goes here.
-
'';
-
};
+
options = mkOption {
+
type = types.commas;
+
default = "terminate:ctrl_alt_bksp";
+
example = "grp:caps_toggle,grp_led:scroll";
+
description = lib.mdDoc ''
+
X keyboard options; layout switching goes here.
+
'';
+
};
-
xkbVariant = mkOption {
-
type = types.str;
-
default = "";
-
example = "colemak";
-
description = lib.mdDoc ''
-
X keyboard variant.
-
'';
-
};
+
variant = mkOption {
+
type = types.str;
+
default = "";
+
example = "colemak";
+
description = lib.mdDoc ''
+
X keyboard variant.
+
'';
+
};
-
xkbDir = mkOption {
-
type = types.path;
-
default = "${pkgs.xkeyboard_config}/etc/X11/xkb";
-
defaultText = literalExpression ''"''${pkgs.xkeyboard_config}/etc/X11/xkb"'';
-
description = lib.mdDoc ''
-
Path used for -xkbdir xserver parameter.
-
'';
+
dir = mkOption {
+
type = types.path;
+
default = "${pkgs.xkeyboard_config}/etc/X11/xkb";
+
defaultText = literalExpression ''"''${pkgs.xkeyboard_config}/etc/X11/xkb"'';
+
description = lib.mdDoc ''
+
Path used for -xkbdir xserver parameter.
+
'';
+
};
+
};
+
};
};
config = mkOption {
···
{
"X11/xorg.conf".source = "${configFile}";
# -xkbdir command line option does not seems to be passed to xkbcomp.
-
"X11/xkb".source = "${cfg.xkbDir}";
+
"X11/xkb".source = "${cfg.xkb.dir}";
})
# localectl looks into 00-keyboard.conf
//{
···
Section "InputClass"
Identifier "Keyboard catchall"
MatchIsKeyboard "on"
-
Option "XkbModel" "${cfg.xkbModel}"
-
Option "XkbLayout" "${cfg.layout}"
-
Option "XkbOptions" "${cfg.xkbOptions}"
-
Option "XkbVariant" "${cfg.xkbVariant}"
+
Option "XkbModel" "${cfg.xkb.model}"
+
Option "XkbLayout" "${cfg.xkb.layout}"
+
Option "XkbOptions" "${cfg.xkb.options}"
+
Option "XkbVariant" "${cfg.xkb.variant}"
EndSection
'';
}
···
services.xserver.displayManager.xserverArgs =
[ "-config ${configFile}"
-
"-xkbdir" "${cfg.xkbDir}"
+
"-xkbdir" "${cfg.xkb.dir}"
] ++ optional (cfg.display != null) ":${toString cfg.display}"
++ optional (cfg.tty != null) "vt${toString cfg.tty}"
++ optional (cfg.dpi != null) "-dpi ${toString cfg.dpi}"
···
];
system.checks = singleton (pkgs.runCommand "xkb-validated" {
-
inherit (cfg) xkbModel layout xkbVariant xkbOptions;
+
inherit (cfg.xkb) model layout variant options;
nativeBuildInputs = with pkgs.buildPackages; [ xkbvalidate ];
preferLocalBuild = true;
} ''
${optionalString (config.environment.sessionVariables ? XKB_CONFIG_ROOT)
"export XKB_CONFIG_ROOT=${config.environment.sessionVariables.XKB_CONFIG_ROOT}"
}
-
xkbvalidate "$xkbModel" "$layout" "$xkbVariant" "$xkbOptions"
+
xkbvalidate "$model" "$layout" "$variant" "$options"
touch "$out"
'');
+14 -14
nixos/tests/keymap.nix
···
nodes.machine.console.keyMap = mkOverride 900 layout;
nodes.machine.services.xserver.desktopManager.xterm.enable = false;
-
nodes.machine.services.xserver.layout = mkOverride 900 layout;
+
nodes.machine.services.xserver.xkb.layout = mkOverride 900 layout;
nodes.machine.imports = [ ./common/x11.nix extraConfig ];
testScript = ''
···
};
extraConfig.console.keyMap = "fr";
-
extraConfig.services.xserver.layout = "fr";
+
extraConfig.services.xserver.xkb.layout = "fr";
};
bone = {
···
};
extraConfig.console.keyMap = "bone";
-
extraConfig.services.xserver.layout = "de";
-
extraConfig.services.xserver.xkbVariant = "bone";
+
extraConfig.services.xserver.xkb.layout = "de";
+
extraConfig.services.xserver.xkb.variant = "bone";
};
colemak = {
···
};
extraConfig.console.keyMap = "colemak";
-
extraConfig.services.xserver.layout = "us";
-
extraConfig.services.xserver.xkbVariant = "colemak";
+
extraConfig.services.xserver.xkb.layout = "us";
+
extraConfig.services.xserver.xkb.variant = "colemak";
};
dvorak = {
···
};
extraConfig.console.keyMap = "dvorak";
-
extraConfig.services.xserver.layout = "us";
-
extraConfig.services.xserver.xkbVariant = "dvorak";
+
extraConfig.services.xserver.xkb.layout = "us";
+
extraConfig.services.xserver.xkb.variant = "dvorak";
};
dvorak-programmer = {
···
};
extraConfig.console.keyMap = "dvorak-programmer";
-
extraConfig.services.xserver.layout = "us";
-
extraConfig.services.xserver.xkbVariant = "dvp";
+
extraConfig.services.xserver.xkb.layout = "us";
+
extraConfig.services.xserver.xkb.variant = "dvp";
};
neo = {
···
};
extraConfig.console.keyMap = "neo";
-
extraConfig.services.xserver.layout = "de";
-
extraConfig.services.xserver.xkbVariant = "neo";
+
extraConfig.services.xserver.xkb.layout = "de";
+
extraConfig.services.xserver.xkb.variant = "neo";
};
qwertz = {
···
};
extraConfig.console.keyMap = "de";
-
extraConfig.services.xserver.layout = "de";
+
extraConfig.services.xserver.xkb.layout = "de";
};
custom = {
···
};
extraConfig.console.useXkbConfig = true;
-
extraConfig.services.xserver.layout = "us-greek";
+
extraConfig.services.xserver.xkb.layout = "us-greek";
extraConfig.services.xserver.extraLayouts.us-greek =
{ description = "US layout with alt-gr greek";
languages = [ "eng" ];
+4 -4
pkgs/tools/X11/xkbvalidate/xkbvalidate.c
···
rdef = malloc(sizeof(struct xkb_rule_names));
-
TRY_KEYMAP(model, argv[1], "xkbModel");
-
TRY_KEYMAP(layout, argv[2], "layout");
-
TRY_KEYMAP(variant, argv[3], "xkbVariant");
-
TRY_KEYMAP(options, argv[4], "xkbOptions");
+
TRY_KEYMAP(model, argv[1], "xkb.model");
+
TRY_KEYMAP(layout, argv[2], "xkb.layout");
+
TRY_KEYMAP(variant, argv[3], "xkb.variant");
+
TRY_KEYMAP(options, argv[4], "xkb.options");
free_logs();
rdef->model = argv[1];