docs: mention xkb environment variables in readme

This commit is contained in:
Isaac Freund 2020-06-13 21:28:36 +02:00
parent e1a1459177
commit 4b674730da
No known key found for this signature in database
GPG Key ID: 86DED400DDFD7A11

View File

@ -61,6 +61,22 @@ the contrib directory.
Some configuration options are still hardcoded in [Config.zig](river/Config.zig). Some configuration options are still hardcoded in [Config.zig](river/Config.zig).
Eventually all configuration will be moved to the `riverctl` binary. 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 ## Development
Check out the [roadmap](https://github.com/ifreund/river/issues/1) Check out the [roadmap](https://github.com/ifreund/river/issues/1)