From cb2cd615e013d2a4ec750a8b5171f71e89cc85d0 Mon Sep 17 00:00:00 2001 From: Florian Bruhin Date: Thu, 18 Jan 2018 07:57:31 +0100 Subject: [PATCH] Update docs --- doc/changelog.asciidoc | 5 +++++ doc/help/commands.asciidoc | 9 +++++---- qutebrowser/config/configcommands.py | 9 +++++++-- 3 files changed, 17 insertions(+), 6 deletions(-) diff --git a/doc/changelog.asciidoc b/doc/changelog.asciidoc index 08dc2fbce..9a312dc0c 100644 --- a/doc/changelog.asciidoc +++ b/doc/changelog.asciidoc @@ -18,6 +18,11 @@ breaking changes (such as renamed commands) can happen in minor releases. v1.2.0 (unreleased) ------------------- +Added +~~~~~ + +- A new `qute://bindings` page, opened by `:bind`, shows all keybindings. + Changed ~~~~~~~ diff --git a/doc/help/commands.asciidoc b/doc/help/commands.asciidoc index 098ada8af..be7f4d557 100644 --- a/doc/help/commands.asciidoc +++ b/doc/help/commands.asciidoc @@ -145,14 +145,15 @@ How many pages to go back. [[bind]] === bind -Syntax: +:bind [*--mode* 'mode'] [*--default*] 'key' ['command']+ +Syntax: +:bind [*--mode* 'mode'] [*--default*] ['key'] ['command']+ 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. + ==== positional arguments * +'key'+: The keychain or special key (inside `<...>`) to bind. -* +'command'+: The command to execute, with optional args, or not given to print the current binding. - +* +'command'+: The command to execute, with optional args. ==== optional arguments * +*-m*+, +*--mode*+: A comma-separated list of modes to bind the key in (default: `normal`). See `:help bindings.commands` for the @@ -1104,7 +1105,7 @@ Syntax: +:set [*--temp*] [*--print*] ['option'] ['value']+ Set an option. -If the option name ends with '?', the value of the option is shown instead. +If the option name ends with '?', the value of the option is shown instead. Using :set without any arguments opens a page where settings can be changed interactively. ==== positional arguments * +'option'+: The name of the option. diff --git a/qutebrowser/config/configcommands.py b/qutebrowser/config/configcommands.py index cc3eae514..93a1f7ce0 100644 --- a/qutebrowser/config/configcommands.py +++ b/qutebrowser/config/configcommands.py @@ -63,6 +63,9 @@ class ConfigCommands: If the option name ends with '?', the value of the option is shown instead. + Using :set without any arguments opens a page where settings can be + changed interactively. + Args: option: The name of the option. value: The value to set. @@ -101,10 +104,12 @@ class ConfigCommands: default=False): """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. + Args: key: The keychain or special key (inside `<...>`) to bind. - command: The command to execute, with optional args, or None to - print the current binding. + command: The command to execute, with optional args. mode: A comma-separated list of modes to bind the key in (default: `normal`). See `:help bindings.commands` for the available modes.