Keyd - Revision history

Langsjo: Remove outdated notice, fix typo

2026-03-23T23:12:35Z

Remove outdated notice, fix typo

← Older revision		Revision as of 23:12, 23 March 2026
Line 2:		Line 2:

	=== Activate Keyd in NixOs ===		=== Activate Keyd in NixOs ===
	~~Note that the keyd module is relatively experimental (as of 2024), and still subject to changes.~~ To ~~active~~ keyd in NixOs, you can simply add in the rest of your <code>/etc/nixos/configuration.nix</code>		To activate keyd in NixOs, you can simply add in the rest of your <code>/etc/nixos/configuration.nix</code>
	<syntaxhighlight lang="nix">		<syntaxhighlight lang="nix">
	services.keyd = {		services.keyd = {

Mse63: added Unicode Support section

2025-12-27T06:14:11Z

added Unicode Support section

← Older revision		Revision as of 06:14, 27 December 2025
Line 59:		Line 59:
	</syntaxhighlight>		</syntaxhighlight>

	Note that for now, ids MUST be present in the file, so it means that layouts cannot be defined this way as reported in https://github.com/NixOS/nixpkgs/issues/284797. Yet, you can still use `environment.etc` to create them as usual.		Note that for now, ids MUST be present in the file, so it means that layouts cannot be defined this way as reported in https://github.com/NixOS/nixpkgs/issues/284797. Yet, you can still use <code>environment.etc</code> to create them as usual.

	=== Disabling Copilot key ===		=== Disabling Copilot key ===
Line 96:		Line 96:
	</nowiki>}}		</nowiki>}}

	=== Dealing with ~~layouts~~ ===		=== Dealing with Layouts & Unicode Support ===

	If you want to define a layout (like you custom qwerty), you can also do it directly in keyd, but keep in mind that keyd can manipulate keycodes (basically the position of the key on the keyboard that is named based on a qwerty layout by convention), but not keysyms (what actual symbol you will type), since keyd they basically recreates a fake keyboard that will be, later in the chain, processed by X11/ibus/… So if you want to use a layout, you need to be sure that the layout used by the user is set to US (e.g. in X11 via <code>setxkbmap us</code>). If you want to produce symbols not accessible by the US keyboard map (e.g. emoji etc), then keyd will basically create for you a XCompose file that you need to include (you may also need to enable Ibus for this), that is located in <code>"${keyd}/share/keyd/keyd.compose"</code>. See keyd documentation for more details.		If you want to define a layout (like you custom qwerty), you can also do it directly in keyd, but keep in mind that keyd can manipulate keycodes (basically the position of the key on the keyboard that is named based on a qwerty layout by convention), but not keysyms (what actual symbol you will type), since keyd they basically recreates a fake keyboard that will be, later in the chain, processed by X11/ibus/… So if you want to use a layout, you need to be sure that the layout used by the user is set to US (e.g. in X11 via <code>setxkbmap us</code>). If you want to produce symbols not accessible by the US keyboard map (e.g. emoji etc), then keyd will basically create for you a XCompose file that you need to include (you may also need to enable Ibus for this), that is located in <code>"${keyd}/share/keyd/keyd.compose"</code>. See keyd documentation for more details.

			The compose file can be enabled on a per-user basis by setting <code>~/.XCompose</code> to be a copy of or a symlink to that compose file. In home-manager, this can be configured like so:
			{{file\|/home/<user>/.config/home-manager/home.nix\|nix\|<nowiki>
			home.file.".XCompose".source = "${pkgs.keyd}/share/keyd/keyd.compose"
			</nowiki>}}

			Alternatively, the compose file can be adjusted system-wide by setting the $XCOMPOSEFILE environment variable. This can be adjusted set in your configuration like so:
			{{file\|/etc/nixos/configuration.nix\|nix\|<nowiki>
			environment.sessionVariables."XCOMPOSEFILE" = "${pkgs.keyd}/share/keyd/keyd.compose"
			</nowiki>}}
			However, this approach is less reliable, and may not work with all applications, such as web browsers or electron apps.

Arnecc at 23:28, 13 December 2025

2025-12-13T23:28:25Z

← Older revision		Revision as of 23:28, 13 December 2025
Line 87:		Line 87:
	settings = {		settings = {
	main = {		main = {
	## taking the key combination from the monitor command and remapping it to ~~control~~ key		## taking the key combination from the monitor command and remapping it to meta / super key
	"leftshift+leftmeta+f23" = "layer(~~control~~)";		"leftshift+leftmeta+f23" = "layer(meta)";
	};		};
	};		};

Arnecc at 23:25, 13 December 2025

2025-12-13T23:25:01Z

@@ Line 60: / Line 60: @@
 Note that for now, ids MUST be present in the file, so it means that layouts cannot be defined this way as reported in https://github.com/NixOS/nixpkgs/issues/284797. Yet, you can still use `environment.etc` to create them as usual.
 === Dealing with layouts ===
 If you want to define a layout (like you custom qwerty), you can also do it directly in keyd, but keep in mind that keyd can manipulate keycodes (basically the position of the key on the keyboard that is named based on a qwerty layout by convention), but not keysyms (what actual symbol you will type), since keyd they basically recreates a fake keyboard that will be, later in the chain, processed by X11/ibus/… So if you want to use a layout, you need to be sure that the layout used by the user is set to US (e.g. in X11 via <code>setxkbmap us</code>). If you want to produce symbols not accessible by the US keyboard map (e.g. emoji etc), then keyd will basically create for you a XCompose file that you need to include (you may also need to enable Ibus for this), that is located in <code>"${keyd}/share/keyd/keyd.compose"</code>. See keyd documentation for more details.

Graic: Fix systemctl command

2025-01-12T19:40:43Z

Fix systemctl command

← Older revision		Revision as of 19:40, 12 January 2025
Line 30:		Line 30:
	and apply your change via		and apply your change via
	<syntaxhighlight lang="conf">		<syntaxhighlight lang="conf">
	$ systemctl keyd ~~restart~~		$ systemctl restart keyd
	</syntaxhighlight>		</syntaxhighlight>
	This is practical to quickly test the configuration but in not very "Nixy" as the configuration is not contained in your beloved <code>/etc/nixos/configuration.nix</code>… hence the second option:		This is practical to quickly test the configuration but in not very "Nixy" as the configuration is not contained in your beloved <code>/etc/nixos/configuration.nix</code>… hence the second option:

TobiasBora: Create page

2024-05-24T15:07:10Z

Create page

New page

[https://github.com/rvaiya/keyd Keyd] is a key remapping daemon, similar to kmonad.

=== Activate Keyd in NixOs ===
Note that the keyd module is relatively experimental (as of 2024), and still subject to changes. To active keyd in NixOs, you can simply add in the rest of your <code>/etc/nixos/configuration.nix</code>
<syntaxhighlight lang="nix">
services.keyd = {
enable = true;
};

# Optional, but makes sure that when you type the make palm rejection work with keyd
# https://github.com/rvaiya/keyd/issues/723
environment.etc."libinput/local-overrides.quirks".text = ''
[Serial Keyboards]
MatchUdevType=keyboard
MatchName=keyd virtual keyboard
AttrKeyboardIntegration=internal
'';
</syntaxhighlight>
After rebuilding your configuration, you should have keyd daemon running.

=== Configure Keyd: the quick and dirty way ===
In order to configure your system, you have two options: if you want to quickly test your configuration (avoids you to wait a full <code>nixos-rebuild switch</code> every time you change one option), you can simply write your configuration files in a file like <code>/etc/keyd/test.conf</code> containing something like:
<syntaxhighlight lang="conf">
[ids]
*

[main]
capslock = layer(control);
</syntaxhighlight>
and apply your change via
<syntaxhighlight lang="conf">
$ systemctl keyd restart
</syntaxhighlight>
This is practical to quickly test the configuration but in not very "Nixy" as the configuration is not contained in your beloved <code>/etc/nixos/configuration.nix</code>… hence the second option:

=== Configure Keyd in your configuration.nix ===
You can then move your configuration to <code>/etc/nixos/configuration.nix</code> by adding to your configuration something like:
<syntaxhighlight lang="nix">
services.keyd = {
enable = true;
keyboards = {
# The name is just the name of the configuration file, it does not really matter
default = {
ids = [ "*" ]; # what goes into the [id] section, here we select all keyboards
# Everything but the ID section:
settings = {
# The main layer, if you choose to declare it in Nix
main = {
capslock = "layer(control)"; # you might need to also enclose the key in quotes if it contains non-alphabetical symbols
};
otherlayer = {};
};
extraConfig = ''
# put here any extra-config, e.g. you can copy/paste here directly a configuration, just remove the ids part
'';
};
};
};
</syntaxhighlight>

Note that for now, ids MUST be present in the file, so it means that layouts cannot be defined this way as reported in https://github.com/NixOS/nixpkgs/issues/284797. Yet, you can still use `environment.etc` to create them as usual.

=== Dealing with layouts ===

If you want to define a layout (like you custom qwerty), you can also do it directly in keyd, but keep in mind that keyd can manipulate keycodes (basically the position of the key on the keyboard that is named based on a qwerty layout by convention), but not keysyms (what actual symbol you will type), since keyd they basically recreates a fake keyboard that will be, later in the chain, processed by X11/ibus/… So if you want to use a layout, you need to be sure that the layout used by the user is set to US (e.g. in X11 via <code>setxkbmap us</code>). If you want to produce symbols not accessible by the US keyboard map (e.g. emoji etc), then keyd will basically create for you a XCompose file that you need to include (you may also need to enable Ibus for this), that is located in <code>"${keyd}/share/keyd/keyd.compose"</code>. See keyd documentation for more details.