summaryrefslogtreecommitdiff
path: root/qutebrowser/config/configdata.yml
diff options
context:
space:
mode:
Diffstat (limited to 'qutebrowser/config/configdata.yml')
-rw-r--r--qutebrowser/config/configdata.yml13
1 files changed, 10 insertions, 3 deletions
diff --git a/qutebrowser/config/configdata.yml b/qutebrowser/config/configdata.yml
index 22a4b2151..2e0f409ee 100644
--- a/qutebrowser/config/configdata.yml
+++ b/qutebrowser/config/configdata.yml
@@ -3232,13 +3232,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.