NixOS Wiki

Keyboard Layout Customization: Difference between revisions

← Older edit
VisualWikitext
imported>MasseGuillaume
m inline writeText to avoid having to create a let block
Rhendric (talk | contribs)
20 edits
→Relevant other options: Update xkb options
 
(7 intermediate revisions by 6 users not shown)
Line 9: Line 9:
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.xkbVariant</code>: X keyboard variant or multiple variants separated by commas (a variant can be empty).  
* <code>services.xserver.xkb.variant</code>: X keyboard variant or multiple variants separated by commas (a variant can be empty).  
* <code>services.xserver.xkbModel</code>: Keyboard model.
* <code>services.xserver.xkb.model</code>: Keyboard model.
* <code>services.xserver.xkbOptions</code>: X keyboard options; layout switching goes here.
* <code>services.xserver.xkb.options</code>: X keyboard options; layout switching goes here.


Example:
=====Example:=====


<source lang="nix">
For desktop:
services.xserver = {
<syntaxhighlight lang="nix">
services.xserver.xkb = {
   layout = "us,ru";
   layout = "us,ru";
   xkbVariant = "workman,";
   variant = "workman,";
   xkbOptions = "grp:win_space_toggle";
   options = "grp:win_space_toggle";
};
};
</source>
</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 '&lt;nixpkgs&gt;' -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 '&lt;nixpkgs&gt;' -A xkeyboard_config)/etc/X11/xkb/rules/base.lst</code>
Line 35: 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.


<source lang="nix">
<syntaxhighlight lang="nix">
let
let
   compiledLayout = pkgs.runCommand "keyboard-layout" {} ''
   compiledLayout = pkgs.runCommand "keyboard-layout" {} ''
Line 42: 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";
</source>
</syntaxhighlight>


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.
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.
Line 49: Line 54:


* <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.xkbDir</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>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>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.
* <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 ===
=== Configs ===


* https://github.com/Infinisil/system/blob/master/config/new-modules/keylayout.nix
* https://github.com/infinisil/system/blob/94852ed690fccfdda27c2e3985be84c51f1eac8e/new-modules/keylayout.nix


== Using xmodmap ==
=== Advanced configuration with xmodmap ===


Since it is much simpler to use xmodmap and also because I couldn't get the xkbcomp way to work on my NixOS machine I decided to keep using xmodmap:
Some users have found xmodmap to be a helpful tool although reports of successful implementation are varied.


<source lang="nix">
<syntaxhighlight lang="nix">


cat /etc/nixos/configuration.nix
cat /etc/nixos/configuration.nix
Line 79: Line 84:
   ''}"
   ''}"


</source>
</syntaxhighlight>


Works after boot and after suspend/resume.
Works after boot and after suspend/resume.


You may need to add some delay to make xmodmap command works.
You may need to add some delay to make xmodmap command work.


<source lang="nix">
<syntaxhighlight lang="nix">
   services.xserver.displayManager.sessionCommands = "sleep 5 && ${pkgs.xorg.xmodmap}/bin/xmodmap -e 'keycode 43 = h H Left H' &";
   services.xserver.displayManager.sessionCommands = "sleep 5 && ${pkgs.xorg.xmodmap}/bin/xmodmap -e 'keycode 43 = h H Left H' &";
</source>
</syntaxhighlight>
 
[[Category:Desktop]]
[[Category:Hardware]]
Retrieved from "https://wiki.nixos.org/wiki/Keyboard_Layout_Customization"