diff options
| author | Florian Bruhin <me@the-compiler.org> | 2021-03-20 11:16:25 +0100 |
|---|---|---|
| committer | Florian Bruhin <me@the-compiler.org> | 2021-03-20 11:16:25 +0100 |
| commit | 3dc5584cac2a588828dbd50ba441c04ad27e6d17 (patch) | |
| tree | 6d62929db123a599ad05972304b563c557d3aae8 | |
| parent | 5b6d2c60b46e233d4788a9b34d15fdb7d8d1c114 (diff) | |
| download | qutebrowser-3dc5584cac2a588828dbd50ba441c04ad27e6d17.tar.gz qutebrowser-3dc5584cac2a588828dbd50ba441c04ad27e6d17.zip | |
Improve bindings.key_mappings description
| -rw-r--r-- | doc/help/settings.asciidoc | 7 | ||||
| -rw-r--r-- | qutebrowser/config/configdata.yml | 13 |
2 files changed, 14 insertions, 6 deletions
diff --git a/doc/help/settings.asciidoc b/doc/help/settings.asciidoc index 3741589e7..9f10f588d 100644 --- a/doc/help/settings.asciidoc +++ b/doc/help/settings.asciidoc @@ -16,7 +16,7 @@ |<<backend,backend>>|Backend to use to display websites. |<<bindings.commands,bindings.commands>>|Keybindings mapping keys to commands in different modes. |<<bindings.default,bindings.default>>|Default keybindings. If you want to add bindings, modify `bindings.commands` instead. -|<<bindings.key_mappings,bindings.key_mappings>>|This setting can be used to map keys to other keys. +|<<bindings.key_mappings,bindings.key_mappings>>|Map keys to other keys, so that they are equivalent in all modes. |<<changelog_after_upgrade,changelog_after_upgrade>>|When to show a changelog after qutebrowser was upgraded. |<<colors.completion.category.bg,colors.completion.category.bg>>|Background color of the completion widget category headers. |<<colors.completion.category.border.bottom,colors.completion.category.border.bottom>>|Bottom border color of the completion widget category headers. @@ -775,9 +775,10 @@ Default: [[bindings.key_mappings]] === bindings.key_mappings -This setting can be used to map keys to other keys. +Map keys to other keys, so that they are equivalent in all modes. When the key used as dictionary-key is pressed, the binding for the key used as dictionary-value is invoked instead. -This is useful for global remappings of keys, for example to map Ctrl-[ to Escape. +This is useful for global remappings of keys, for example to map <Ctrl-[> to <Escape>. +NOTE: This should only be used if two keys should always be equivalent, i.e. for things like <Enter> (keypad) and <Return> (non-keypad). For normal command bindings, qutebrowser works differently to vim: You always bind keys to commands, usually via `:bind` or `config.bind()`. Instead of using this setting, consider finding the command a key is bound to (e.g. via `:bind gg`) and then binding the same command to the desired key. Note that when a key is bound (via `bindings.default` or `bindings.commands`), the mapping is ignored. Type: <<types,Dict>> diff --git a/qutebrowser/config/configdata.yml b/qutebrowser/config/configdata.yml index 762f42415..f27bde775 100644 --- a/qutebrowser/config/configdata.yml +++ b/qutebrowser/config/configdata.yml @@ -3255,13 +3255,20 @@ bindings.key_mappings: keytype: Key valtype: Key desc: >- - This setting can be used to map keys to other keys. + Map keys to other keys, so that they are equivalent in all modes. When the key used as dictionary-key is pressed, the binding for the key used as dictionary-value is invoked instead. - This is useful for global remappings of keys, for example to map Ctrl-[ to - Escape. + This is useful for global remappings of keys, for example to map <Ctrl-[> to + <Escape>. + + NOTE: This should only be used if two keys should always be equivalent, i.e. for + things like <Enter> (keypad) and <Return> (non-keypad). For normal command bindings, + qutebrowser works differently to vim: You always bind keys to commands, usually via + `:bind` or `config.bind()`. Instead of using this setting, consider finding the + command a key is bound to (e.g. via `:bind gg`) and then binding the same command to + the desired key. Note that when a key is bound (via `bindings.default` or `bindings.commands`), the mapping is ignored. |