diff options
| author | Isaac Freund <ifreund@ifreund.xyz> | 2020-06-13 21:28:36 +0200 |
|---|---|---|
| committer | Isaac Freund <ifreund@ifreund.xyz> | 2020-06-13 23:39:22 +0200 |
| commit | 4b674730da0cb64d5b0eb16f30b53fa921737f60 (patch) | |
| tree | fc010a98f6a75623dab11b3774998f7cef51e22b | |
| parent | e1a14591773861c2ccbfdca0ae0e820d5b8410d4 (diff) | |
| download | river-4b674730da0cb64d5b0eb16f30b53fa921737f60.tar.gz river-4b674730da0cb64d5b0eb16f30b53fa921737f60.tar.xz | |
docs: mention xkb environment variables in readme
| -rw-r--r-- | README.md | 16 |
1 files changed, 16 insertions, 0 deletions
@@ -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) |