aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/README.md b/README.md
index f0a8e5e..4bbedad 100644
--- a/README.md
+++ b/README.md
@@ -61,6 +61,22 @@ the contrib directory.
Some configuration options are still hardcoded in [Config.zig](river/Config.zig).
Eventually all configuration will be moved to the `riverctl` binary.
+Keyboard configuration is not yet implemented in river, but since river uses
+libxkbcommon you may use the following environment variables to set defaults:
+
+- `XKB_DEFAULT_RULES`
+- `XKB_DEFAULT_MODEL`
+- `XKB_DEFAULT_LAYOUT`
+- `XKB_DEFAULT_VARIANT`
+- `XKB_DEFAULT_OPTIONS`
+
+Possible values for these variables can be found in the `xkeyboard-config(7)`
+man page. For example, to use a dvorak layout one could start river with
+
+```
+XKB_DEFAULT_LAYOUT="us(dvorak)" river
+```
+
## Development
Check out the [roadmap](https://github.com/ifreund/river/issues/1)