[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/corfu bc4a9a6 2/5: README: Document keybindings
From: |
Protesilaos Stavrou |
Subject: |
[elpa] externals/corfu bc4a9a6 2/5: README: Document keybindings |
Date: |
Sun, 18 Apr 2021 10:40:15 -0400 (EDT) |
branch: externals/corfu
commit bc4a9a67d44637fa3c6ba1e090fa4c53470f95ba
Author: Daniel Mendler <mail@daniel-mendler.de>
Commit: Daniel Mendler <mail@daniel-mendler.de>
README: Document keybindings
---
README.org | 17 +++++++++++++++++
1 file changed, 17 insertions(+)
diff --git a/README.org b/README.org
index 75dc709..04fb511 100644
--- a/README.org
+++ b/README.org
@@ -94,6 +94,23 @@ Here is an example configuration:
(setq tab-always-indent 'complete))
#+end_src
+* Key bindings
+
+Corfu uses a transient keymap ~corfu-map~ which is active while the popup is
shown.
+The keymap defines the following remappings and bindings:
+
+- ~beginning-of-buffer~ -> ~corfu-first~
+- ~end-of-buffer~ -> ~corfu-last~
+- ~scroll-down-command~ -> ~corfu-scroll-down~
+- ~scroll-up-command~ -> ~corfu-scroll-up~
+- ~next-line~, =down=, =M-n= -> ~corfu-next~
+- ~previous-line~, =up=, =M-p= -> ~corfu-previous~
+- ~completion-at-point~, =TAB= -> ~corfu-complete~
+- =RET= -> ~corfu-insert~
+- =M-g= -> ~corfu-show-location~
+- =M-h= -> ~corfu-show-documentation~
+- =C-g=, =ESC ESC ESC= -> ~corfu-abort~
+
* Complementary packages
Corfu works well together with all packages providing code completion via the