summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorPeter Hutterer <peter.hutterer@who-t.net>2020-07-10 08:50:02 +1000
committerRan Benita <ran@unusedvar.com>2020-08-30 21:49:41 +0300
commitd7b39f6ffbe9b46181c5597b0d0e7373eb2e9070 (patch)
tree9cc4b5e240b5532c822a5f9106a983a3a8d84425 /doc
parent05d6efc41723601d4d38e0c43129d2ab9d53fa48 (diff)
downloadlibxkbcommon-d7b39f6ffbe9b46181c5597b0d0e7373eb2e9070.tar.gz
libxkbcommon-d7b39f6ffbe9b46181c5597b0d0e7373eb2e9070.tar.bz2
libxkbcommon-d7b39f6ffbe9b46181c5597b0d0e7373eb2e9070.zip
Add /etc/xkb as extra lookup path for system data files
This completes the usual triplet of configuration locations available for most processes: - vendor-provided data files in /usr/share/X11/xkb - system-specific data files in /etc/xkb - user-specific data files in $XDG_CONFIG_HOME/xkb The default lookup order user, system, vendor, just like everything else that uses these conventions. For include directives in rules files, the '%E' resolves to that path. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Diffstat (limited to 'doc')
-rw-r--r--doc/rules-format.md3
-rw-r--r--doc/user-configuration.md2
2 files changed, 5 insertions, 0 deletions
diff --git a/doc/rules-format.md b/doc/rules-format.md
index 96acbbf..f9fe0d9 100644
--- a/doc/rules-format.md
+++ b/doc/rules-format.md
@@ -73,6 +73,9 @@ Notes:
%H:
The value of the HOME environment variable.
+ %E:
+ The extra lookup path for system-wide XKB data (usually /etc/xkb/rules).
+
%S:
The system-installed rules directory (usually /usr/share/X11/xkb/rules).
```
diff --git a/doc/user-configuration.md b/doc/user-configuration.md
index 17e7179..b8c4d30 100644
--- a/doc/user-configuration.md
+++ b/doc/user-configuration.md
@@ -11,6 +11,8 @@ libxkbcommon searches the following paths for XKB configuration files:
- `$XDG_CONFIG_HOME/xkb/`, or `$HOME/.config/xkb/` if the `$XDG_CONFIG_HOME`
environment variable is not defined
- `$HOME/.xkb/`
+- `$XKB_CONFIG_EXTRA_PATH` if set, otherswise `<sysconfdir>/xkb` (on most
+ distributions this is `/etc/xkb`)
- `$XKB_CONFIG_ROOT` if set, otherwise `<datadir>/X11/xkb/` (path defined by the
`xkeyboard-config` package, on most distributions this is
`/usr/share/X11/xkb`)