Keyboard Layout Customization: Difference between revisions
imported>Timstott m Update xkeyboardconfig attribute name |
→Relevant other options: Update xkb options |
||
| (15 intermediate revisions by 14 users not shown) | |||
| Line 1: | Line 1: | ||
== Simple == | == 20.09 and later == | ||
In 20.09 there's [https://nixos.org/manual/nixos/stable/#custom-xkb-layouts services.xserver.extraLayouts] for this. | |||
== Using xkbcomp == | |||
=== Simple === | |||
The easiest way to customize your keyboard layout on NixOS is with these options: | The easiest way to customize your keyboard layout on NixOS is with these options: | ||
* <code>services.xserver.layout</code>: Keyboard layout, or multiple keyboard layouts separated by commas. | * <code>services.xserver.xkb.layout</code>: Keyboard layout, or multiple keyboard layouts separated by commas. | ||
* <code>services.xserver. | * <code>services.xserver.xkb.variant</code>: X keyboard variant or multiple variants separated by commas (a variant can be empty). | ||
* <code>services.xserver. | * <code>services.xserver.xkb.model</code>: Keyboard model. | ||
* <code>services.xserver. | * <code>services.xserver.xkb.options</code>: X keyboard options; layout switching goes here. | ||
=====Example:===== | |||
For desktop: | |||
<syntaxhighlight lang="nix"> | |||
services.xserver.xkb = { | |||
layout = "us,ru"; | |||
variant = "workman,"; | |||
options = "grp:win_space_toggle"; | |||
}; | |||
</syntaxhighlight> | |||
For console: | |||
<syntaxhighlight lang="nix"> | |||
console.keyMap = "us"; | |||
</syntaxhighlight> | |||
You can find valid values for these options in <code>$(nix-build --no-out-link '<nixpkgs>' -A xkeyboard_config)/etc/X11/xkb/rules/base.lst</code> | You can find valid values for these options in <code>$(nix-build --no-out-link '<nixpkgs>' -A xkeyboard_config)/etc/X11/xkb/rules/base.lst</code> | ||
== Advanced == | === Advanced === | ||
If the above options aren't enough, you can instead create your own keyboard layout by going through xkb. To get started, install <code>xorg.xkbcomp</code> and run <code>setxkbmap -print > layout.xkb</code> to get an initial file. This corresponds to your current layout. Use <code>xkbcomp layout.xkb $DISPLAY</code> to load the file as your new layout. Refer to https://wiki.archlinux.org/index.php/X_KeyBoard_extension on how to edit this file. | If the above options aren't enough, you can instead create your own keyboard layout by going through xkb. To get started, install <code>xorg.xkbcomp</code> and run <code>setxkbmap -print > layout.xkb</code> to get an initial file. This corresponds to your current layout. Use <code>xkbcomp layout.xkb $DISPLAY</code> to load the file as your new layout. Refer to https://wiki.archlinux.org/index.php/X_KeyBoard_extension on how to edit this file. | ||
| Line 18: | Line 40: | ||
To load this file at the start of the X session, add the following to your <code>configuration.nix</code>. The extra compilation step (<code>xkbcomp</code>) helps catching layout errors at build time. | To load this file at the start of the X session, add the following to your <code>configuration.nix</code>. The extra compilation step (<code>xkbcomp</code>) helps catching layout errors at build time. | ||
< | <syntaxhighlight lang="nix"> | ||
let | let | ||
compiledLayout = pkgs.runCommand "keyboard-layout" {} '' | compiledLayout = pkgs.runCommand "keyboard-layout" {} '' | ||
| Line 25: | Line 47: | ||
in | in | ||
services.xserver.displayManager.sessionCommands = "${pkgs.xorg.xkbcomp}/bin/xkbcomp ${compiledLayout} $DISPLAY"; | services.xserver.displayManager.sessionCommands = "${pkgs.xorg.xkbcomp}/bin/xkbcomp ${compiledLayout} $DISPLAY"; | ||
</ | </syntaxhighlight> | ||
== Relevant other options == | |||
If you are using home-manager, you also need to prevent home-manager from managing the keyboard by having <code>home.keyboard = null;</code> in your home-manager configuration. | |||
=== Relevant other options === | |||
* <code>services.xserver.exportConfiguration</code>: Makes it so the above mentioned xkb directory (and the <code>xorg.conf</code> file) gets exported to <code>/etc/X11/xkb</code>, which is useful if you have to often look stuff up in it. | * <code>services.xserver.exportConfiguration</code>: Makes it so the above mentioned xkb directory (and the <code>xorg.conf</code> file) gets exported to <code>/etc/X11/xkb</code>, which is useful if you have to often look stuff up in it. | ||
* <code>services.xserver. | * <code>services.xserver.xkb.dir</code>: Allows you to set a different xkb directory altogether. All the above mentioned things will use this instead of the default one in regards to xkb stuff. | ||
* <code> | * <code>console.useXkbConfig</code>: Makes it so the tty console has about the same layout as the one configured in the <code>services.xserver</code> options. | ||
=== Configs === | |||
* https://github.com/infinisil/system/blob/94852ed690fccfdda27c2e3985be84c51f1eac8e/new-modules/keylayout.nix | |||
=== Advanced configuration with xmodmap === | |||
Some users have found xmodmap to be a helpful tool although reports of successful implementation are varied. | |||
<syntaxhighlight lang="nix"> | |||
cat /etc/nixos/configuration.nix | |||
services.xserver.displayManager.sessionCommands = | |||
${pkgs.xorg.xmodmap}/bin/xmodmap "${pkgs.writeText "xkb-layout" '' | |||
! Map umlauts to RIGHT ALT + <key> | |||
keycode 108 = Mode_switch | |||
keysym e = e E EuroSign | |||
keysym c = c C cent | |||
keysym a = a A adiaeresis Adiaeresis | |||
keysym o = o O odiaeresis Odiaeresis | |||
keysym u = u U udiaeresis Udiaeresis | |||
keysym s = s S ssharp | |||
! disable capslock | |||
! remove Lock = Caps_Lock | |||
''}" | |||
</syntaxhighlight> | |||
Works after boot and after suspend/resume. | |||
You may need to add some delay to make xmodmap command work. | |||
== | <syntaxhighlight lang="nix"> | ||
services.xserver.displayManager.sessionCommands = "sleep 5 && ${pkgs.xorg.xmodmap}/bin/xmodmap -e 'keycode 43 = h H Left H' &"; | |||
</syntaxhighlight> | |||
[[Category:Desktop]] | |||
[[Category:Hardware]] | |||