blob: 1f48713a68dddab5f6c0c0a3a6a4bd39b65eb0e3 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
|
{ config, lib, pkgs, ... }:
with lib;
let
layouts = config.services.xserver.extraLayouts;
layoutOpts = {
options = {
description = mkOption {
type = types.str;
description = lib.mdDoc "A short description of the layout.";
};
languages = mkOption {
type = types.listOf types.str;
description =
lib.mdDoc ''
A list of languages provided by the layout.
(Use ISO 639-2 codes, for example: "eng" for english)
'';
};
compatFile = mkOption {
type = types.nullOr types.path;
default = null;
description = lib.mdDoc ''
The path to the xkb compat file.
This file sets the compatibility state, used to preserve
compatibility with xkb-unaware programs.
It must contain a `xkb_compat "name" { ... }` block.
'';
};
geometryFile = mkOption {
type = types.nullOr types.path;
default = null;
description = lib.mdDoc ''
The path to the xkb geometry file.
This (completely optional) file describes the physical layout of
keyboard, which maybe be used by programs to depict it.
It must contain a `xkb_geometry "name" { ... }` block.
'';
};
keycodesFile = mkOption {
type = types.nullOr types.path;
default = null;
description = lib.mdDoc ''
The path to the xkb keycodes file.
This file specifies the range and the interpretation of the raw
keycodes sent by the keyboard.
It must contain a `xkb_keycodes "name" { ... }` block.
'';
};
symbolsFile = mkOption {
type = types.nullOr types.path;
default = null;
description = lib.mdDoc ''
The path to the xkb symbols file.
This is the most important file: it defines which symbol or action
maps to each key and must contain a
`xkb_symbols "name" { ... }` block.
'';
};
typesFile = mkOption {
type = types.nullOr types.path;
default = null;
description = lib.mdDoc ''
The path to the xkb types file.
This file specifies the key types that can be associated with
the various keyboard keys.
It must contain a `xkb_types "name" { ... }` block.
'';
};
};
};
xkb_patched = pkgs.xorg.xkeyboardconfig_custom {
layouts = config.services.xserver.extraLayouts;
};
in
{
###### interface
options.services.xserver = {
extraLayouts = mkOption {
type = types.attrsOf (types.submodule layoutOpts);
default = {};
example = literalExpression
''
{
mine = {
description = "My custom xkb layout.";
languages = [ "eng" ];
symbolsFile = /path/to/my/layout;
};
}
'';
description = lib.mdDoc ''
Extra custom layouts that will be included in the xkb configuration.
Information on how to create a new layout can be found here:
<https://www.x.org/releases/current/doc/xorg-docs/input/XKB-Enhancing.html#Defining_New_Layouts>.
For more examples see
<https://wiki.archlinux.org/index.php/X_KeyBoard_extension#Basic_examples>
'';
};
};
###### implementation
config = mkIf (layouts != { }) {
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;
};
services.xserver = {
xkbDir = "${xkb_patched}/etc/X11/xkb";
exportConfiguration = config.services.xserver.displayManager.startx.enable
|| config.services.xserver.displayManager.sx.enable;
};
};
}
|