kossLAN/wry
1
0
Fork 0
forked from wry/wry
Code Pull requests Activity

toml-config: allow specifying keymaps via RMLVO

Browse source
This commit is contained in:
Julian Orth 2026-03-14 21:21:42 +01:00
parent 6e400655c6
commit d911de6007
4 changed files with 272 additions and 31 deletions
Download patch file Download diff file Expand all files Collapse all files

73
toml-spec/spec/spec.yaml
View file

@ -7,7 +7,7 @@ Keymap:
description: |
Defines a keymap by its XKB representation.
- Example:
- Example 1:
```toml
keymap = """
@ -19,6 +19,16 @@ Keymap:
};
"""
```
- Example 2:
```toml
keymap.rmlvo = {
layout = "us,de",
variants = "dvorak",
options = "grp:ctrl_space_toggle",
}
```
- kind: table
description: |
Defines or references a keymap.
@ -50,8 +60,8 @@ Keymap:
description: |
Defines a keymap by its XKB representation.
For each keymap defined in the top-level `keymaps` array, exactly one of `map`
and `path` has to be defined.
For each keymap defined in the top-level `keymaps` array, exactly one of
`map`, `path`, and `rmlvo` has to be defined.
path:
kind: string
required: false
@ -61,8 +71,59 @@ Keymap:
If the path is relative, it will be interpreted relative to the Jay config
directory.
For each keymap defined in the top-level `keymaps` array, exactly one of `map`
and `path` has to be defined.
For each keymap defined in the top-level `keymaps` array, exactly one of
`map`, `path`, and `rmlvo` has to be defined.
rmlvo:
ref: Rmlvo
required: false
description: |
Creates a keymap from RMLVO names.
For each keymap defined in the top-level `keymaps` array, exactly one of
`map`, `path`, and `rmlvo` has to be defined.
Rmlvo:
description: |
An RMLVO keymap definition.
If a parameter is not given, a value from the environment or a default is used:
| name | default |
| ---------------------- | ---------------------- |
| `XKB_DEFAULT_RULES` | `evdev` |
| `XKB_DEFAULT_MODEL` | `pc105` |
| `XKB_DEFAULT_LAYOUT` | `us` |
| `XKB_DEFAULT_VARIANTS` | |
| `XKB_DEFAULT_OPTIONS` | |
- Example:
```toml
keymap.rmlvo = { layout = "us,de", variants = "dvorak" }
```
kind: table
fields:
rules:
kind: string
required: false
description: The name of the rules file.
model:
kind: string
required: false
description: The name of the device model.
layout:
kind: string
required: false
description: A comma-separated list of layouts.
variants:
kind: string
required: false
description: A comma-separated list of variants.
options:
kind: string
required: false
description: A comma-separated list of options.
Action:
@ -2998,7 +3059,7 @@ Config:
required: false
description: |
Sets the fallback output mode.
The default is `cursor`.
- Example: