aboutsummaryrefslogtreecommitdiffstats
path: root/README.org
diff options
context:
space:
mode:
authorjustbur2015-11-15 21:39:33 -0500
committerjustbur2015-11-15 21:39:33 -0500
commitb0f9f580f3a04f4fe75754f1f2a32d2cf3532d9b (patch)
tree46d028079965a9b8e3e10776902acd1e25091195 /README.org
parentb2c7d25dde96ca13e4d0d1f92191ca5cf962c3f5 (diff)
downloademacs-b0f9f580f3a04f4fe75754f1f2a32d2cf3532d9b.tar.gz
emacs-b0f9f580f3a04f4fe75754f1f2a32d2cf3532d9b.zip
Mention show-top-level in the README
Diffstat (limited to 'README.org')
-rw-r--r--README.org21
1 files changed, 20 insertions, 1 deletions
diff --git a/README.org b/README.org
index 4a7a4e3daac..542a91218d5 100644
--- a/README.org
+++ b/README.org
@@ -1,5 +1,11 @@
1* which-key 1* which-key
2[[http://melpa.org/#/which-key][http://melpa.org/packages/which-key-badge.svg]] [[http://stable.melpa.org/#/which-key][file:http://stable.melpa.org/packages/which-key-badge.svg]] 2[[http://melpa.org/#/which-key][http://melpa.org/packages/which-key-badge.svg]] [[http://stable.melpa.org/#/which-key][file:http://stable.melpa.org/packages/which-key-badge.svg]]
3** What's New
4- The function =which-key-show-top-level= was implemented by @iqbalansari
5 (thanks!) to show top-level key bindings (those not behind a prefix). You can
6 use =M-x which-key-show-top-level= to try it and bind it to a key if you like.
7 It should function just like any other which-key popup once it's called.
8
3** Introduction 9** Introduction
4=which-key= is a minor mode for Emacs that displays the key bindings following your currently 10=which-key= is a minor mode for Emacs that displays the key bindings following your currently
5entered incomplete command (a prefix) in a popup. For example, after enabling the minor mode 11entered incomplete command (a prefix) in a popup. For example, after enabling the minor mode
@@ -25,6 +31,7 @@ Many of these have been implemented and are described below.
25 31
26** Table of Contents :TOC@4: 32** Table of Contents :TOC@4:
27 - [[#which-key-][which-key ]] 33 - [[#which-key-][which-key ]]
34 - [[#whats-new][What's New]]
28 - [[#introduction][Introduction]] 35 - [[#introduction][Introduction]]
29 - [[#install][Install]] 36 - [[#install][Install]]
30 - [[#melpa][MELPA]] 37 - [[#melpa][MELPA]]
@@ -35,6 +42,7 @@ Many of these have been implemented and are described below.
35 - [[#side-window-right-option][Side Window Right Option]] 42 - [[#side-window-right-option][Side Window Right Option]]
36 - [[#side-window-right-then-bottom][Side Window Right then Bottom]] 43 - [[#side-window-right-then-bottom][Side Window Right then Bottom]]
37 - [[#minibuffer-option][Minibuffer Option]] 44 - [[#minibuffer-option][Minibuffer Option]]
45 - [[#additional-commands][Additional Commands]]
38 - [[#special-features-and-configuration-options][Special Features and Configuration Options]] 46 - [[#special-features-and-configuration-options][Special Features and Configuration Options]]
39 - [[#popup-type-options][Popup Type Options]] 47 - [[#popup-type-options][Popup Type Options]]
40 - [[#minibuffer][minibuffer]] 48 - [[#minibuffer][minibuffer]]
@@ -144,6 +152,13 @@ Take over the minibuffer. For the recommended configuration use
144Note the maximum height of the minibuffer is controlled through the built-in 152Note the maximum height of the minibuffer is controlled through the built-in
145variable =max-mini-window-height=. 153variable =max-mini-window-height=.
146 154
155** Additional Commands
156- =which-key-show-top-level= will show most key bindings without a prefix. It is
157 most and not all, because many are probably not interesting to most users.
158- =which-key-show-next-page= is the command used for paging.
159- =which-key-undo= can be used to undo the last keypress when in the middle of a
160 key sequence.
161
147** Special Features and Configuration Options 162** Special Features and Configuration Options
148There are more options than the ones described here. All of the configurable 163There are more options than the ones described here. All of the configurable
149variables are available through =M-x customize-group which-key=. 164variables are available through =M-x customize-group which-key=.
@@ -454,4 +469,8 @@ It requires testing on different platforms with different configurations, which
454is beyond my capabilities. The default configuration has been reasonably stable 469is beyond my capabilities. The default configuration has been reasonably stable
455for me. 470for me.
456** Thanks 471** Thanks
457Thanks to @bmag for helping with the initial development and finding many bugs. 472Special thanks to
473- @bmag for helping with the initial development and finding many
474 bugs.
475- @iqbalansari who among other things adapted the code to make
476 =which-key-show-top-level= possible.