/discover-my-major

Discover key bindings and their meaning for the current Emacs major mode
  1. Emacs Lisp 88.0%
  2. Makefile 12.0%
Emacs Lisp Makefile
Clone or download

Clone with HTTPS

Use Git or checkout with SVN using the web URL.

Open in Desktop Download ZIP
Find file
Switch branches/tags
Nothing to show
Latest commit ac83b24 Jan 14, 2017 @steckerhalter steckerhalter Merge pull request #10 from xiongtx/remove-prefix-keys 
Exclude prefix keys.
Permalink
Failed to load latest commit information.
.gitignore Ignore *.elc Oct 6, 2015
LICENSE initial Jan 3, 2014
Makefile add image and tweak makefile Jan 3, 2014
README.md Update README.md for `discover-my-mode`. Oct 6, 2015
discover-my-major.el Exclude prefix keys. Jan 14, 2017
git-commit-mode.png added docstrings and prefix allowing to force regeneration of the makey Jan 3, 2014
package-menu-mode.png added docstrings and prefix allowing to force regeneration of the makey Jan 3, 2014

README.md

discover-my-major

Discover key bindings and descriptions for commands defined by a buffer's major and minor modes.

The command is inspired by discover.el and also uses the makey library. I thought, "Hey! Why not parse the information about the major mode bindings somehow and display that like discover.el does..."

The output is pretty bare bones and not optimized but it seems to work already quite well for most modes:

package-menu-mode screenshot

git-commit-mode screenshot

Installation

quelpa

quelpa is at https://github.com/quelpa/quelpa

(quelpa '(discover-my-major :fetcher github :repo "steckerhalter/discover-my-major"))

MELPA

Packages are available in MELPA.

el-get

(:name discover-my-major
       :type git
       :url "https://github.com/steckerhalter/discover-my-major")

Usage

In any mode you should be able to summon the popup to discover the commands defined by the current buffer's major-mode, by invoking M-x discover-my-major; and for any of the buffer's active minor modes, by invoking M-x discover-my-mode. Each of these commands which will show you a list of key bindings defined by that mode in the current buffer along with their descriptions.

The recommended key binding is C-h C-m, but be aware that by default C-h C-m is bound to view-order-manuals. If the help+ package is installed, this key is bound to help-on-click/key by default.

(global-set-key (kbd "C-h C-m") 'discover-my-major)
(global-set-key (kbd "C-h M-m") 'discover-my-mode)

Or alternatively, to avoid overriding C-h C-m:

(global-set-key (kbd "C-h M-m") 'discover-my-major)
(global-set-key (kbd "C-h M-S-M") 'discover-my-mode)