rnhmjoj/qutebrowser
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update docs

Browse Source
This commit is contained in:
Florian Bruhin 2018-03-04 20:28:46 +01:00
parent d8bfe23c0d
commit c9c0bc0bbd
5 changed files with 10 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/help/commands.asciidoc
View File

@ -153,7 +153,8 @@ Bind a key to a command.
If no command is given, show the current binding for the given key. Using :bind without any arguments opens a page showing all keybindings. If no command is given, show the current binding for the given key. Using :bind without any arguments opens a page showing all keybindings.
==== positional arguments ==== positional arguments
* +'key'+: The keychain or special key (inside `<...>`) to bind. * +'key'+: The keychain to bind. Examples of valid keychains are `gC`, `<Ctrl-X>` or `<Ctrl-C>a`.
* +'command'+: The command to execute, with optional args. * +'command'+: The command to execute, with optional args.
==== optional arguments ==== optional arguments
@ -1316,7 +1317,8 @@ Syntax: +:unbind [*--mode* 'mode'] 'key'+
Unbind a keychain. Unbind a keychain.
==== positional arguments ==== positional arguments
* +'key'+: The keychain or special key (inside <...>) to unbind. * +'key'+: The keychain to unbind. See the help for `:bind` for the correct syntax for keychains.
==== optional arguments ==== optional arguments
* +*-m*+, +*--mode*+: A mode to unbind the key in (default: `normal`). See `:help bindings.commands` for the available modes. * +*-m*+, +*--mode*+: A mode to unbind the key in (default: `normal`). See `:help bindings.commands` for the available modes.

2
doc/help/settings.asciidoc
View File

@ -322,7 +322,7 @@ While it's possible to add bindings with this setting, it's recommended to use `
This setting is a dictionary containing mode names and dictionaries mapping keys to commands: This setting is a dictionary containing mode names and dictionaries mapping keys to commands:
`{mode: {key: command}}` `{mode: {key: command}}`
If you want to map a key to another key, check the `bindings.key_mappings` setting instead. If you want to map a key to another key, check the `bindings.key_mappings` setting instead.
For special keys (can't be part of a keychain), enclose them in `<`...`>`. For modifiers, you can use either `-` or `+` as delimiters, and these names: For modifiers, you can use either `-` or `+` as delimiters, and these names:
* Control: `Control`, `Ctrl` * Control: `Control`, `Ctrl`

6
qutebrowser/config/configcommands.py
View File

@ -137,7 +137,8 @@ class ConfigCommands:
Using :bind without any arguments opens a page showing all keybindings. Using :bind without any arguments opens a page showing all keybindings.
Args: Args:
key: The keychain or special key (inside `<...>`) to bind. key: The keychain to bind. Examples of valid keychains are `gC`,
`<Ctrl-X>` or `<Ctrl-C>a`.
command: The command to execute, with optional args. command: The command to execute, with optional args.
mode: A comma-separated list of modes to bind the key in mode: A comma-separated list of modes to bind the key in
(default: `normal`). See `:help bindings.commands` for the (default: `normal`). See `:help bindings.commands` for the
@ -178,7 +179,8 @@ class ConfigCommands:
"""Unbind a keychain. """Unbind a keychain.
Args: Args:
key: The keychain or special key (inside <...>) to unbind. key: The keychain to unbind. See the help for `:bind` for the
correct syntax for keychains.
mode: A mode to unbind the key in (default: `normal`). mode: A mode to unbind the key in (default: `normal`).
See `:help bindings.commands` for the available modes. See `:help bindings.commands` for the available modes.
""" """

1
qutebrowser/config/configdata.yml
View File

@ -2490,7 +2490,6 @@ bindings.commands:
If you want to map a key to another key, check the `bindings.key_mappings` If you want to map a key to another key, check the `bindings.key_mappings`
setting instead. setting instead.
For special keys (can't be part of a keychain), enclose them in `<`...`>`.
For modifiers, you can use either `-` or `+` as delimiters, and these For modifiers, you can use either `-` or `+` as delimiters, and these
names: names:

2
qutebrowser/keyinput/modeparsers.py
View File

@ -164,7 +164,7 @@ class HintKeyParser(keyparser.CommandKeyParser):
Return: Return:
A QKeySequence match. A QKeySequence match.
""" """
log.keyboard.debug("Got special key 0x{:x} text {}".format( log.keyboard.debug("Got filter key 0x{:x} text {}".format(
e.key(), e.text())) e.key(), e.text()))
hintmanager = objreg.get('hintmanager', scope='tab', hintmanager = objreg.get('hintmanager', scope='tab',
window=self._win_id, tab='current') window=self._win_id, tab='current')