Emacs: How to Define Keys
In emacs, you can create any keyboard shortcut to any command. This page shows you how.
For example, if you want F9 for
whitespace-mode, place this code
(global-set-key (kbd "<f9>") 'whitespace-mode)
in your emacs init file and restart emacs.
If you are experimenting, and don't want to restart emacs every time you try to define a new key, you can place cursor at the end of parenthesis and Alt+x
eval-last-sexp 【Ctrl+x Ctrl+e】. The new key will be active right away.
[see Evaluate Emacs Lisp Code]
If you made some mistake and need to start emacs without loading your init file, you can start emacs from terminal like this:
Emacs Keybinding Syntax
What is Meta key?
The Meta key is a key on Lisp Machine keyboards in the 1970s and 1980s.
GNU Emacs for Microsoft and Linux by default make the Alt key do Meta.
On the Mac, Meta is mapped to either ⌥ option or ⌘ command, depending on which emacs distribution you are using. There's usually a menu that lets you chose.
In emacs documenation, the Meta key's notation is
M-. For example,
M-x means Meta+x.
Remove a Keybinding
To unset a keybinding, set it to
;; unset a key (global-set-key (kbd "C-b") nil)
;; unset a key (global-unset-key (kbd "C-b"))
Find the Command of a Given Key
describe-key, then type the key combination.
List Current Major Mode's Keys
List ALL Keybinding
Each major mode or minor mode usually add or change some keys. So, key list generated is specific to current buffer.
Swap CapsLock and Control Key
You cannot do it within emacs, because CapsLock is intercepted at the Operating System level, emacs does not see it. See:
- Linux: Swap Control Alt Keys
- Windows: Swap CapsLock Alt Ctrl Keys
- Mac: Swap CapsLock Control Option Command Keys
- Emacs: Why You Should Not Swap CapsLock and Control
Keys to Avoid
Emacs has its quirks. It's best not to define the following keys, unless you know what you are doing.
- Ctrl+?. (due to emacs technical implementation quirk. (info "(elisp) Ctl-Char Syntax"))
- F1 or Ctrl+h. (This key is used for emacs help system and have a special status in emacs's key system. For example, type Ctrl+x, then type Ctrl+h, it'll list what valid keys can follow and the associated command.) (info "(elisp) Help Functions")
- The Escape key or Ctrl+[. (The Escape key is tied to Ctrl+[ and Meta. Escape by itself has complicated meanings depending when it is pressed and how many times it is pressed.)
- Ctrl+Shift+letter. In text terminals, it cannot distinguish shifted and unshifted versions of such combination. Works fine if you always use emacs in a GUI environment. (info "(elisp) Other Char Bits")
- Ctrl+m or Enter. These are the same by default. Normally they are bind to a command that sends ASCII 10 LINE FEED character.
- Ctrl+i or Tab. These are the same by default. Normally they are bind to a command that sends ASCII 9 horizontal tab character.
Good Key Choices
Emacs has some 7 thousand commands. By default, 800 of them have key shortcuts. [see A Curious Look at Emacs One Thousand Keybindings] All the common key spots are used. If you define your own keys without care, you may find that many major mode or minor mode override your keys, because they have priority.
By official emacs documentation (info "(elisp) Key Binding Conventions"), the key space reserved for users are the function keys F5 to F9, and Ctrl+c letter. This is very restrictive.
The following keys are good spots for your own definitions, and does not cause any problems in practice.
- F5, F6, F7, F8, F9, F11, F12
- Not defined by emacs. Combination with Alt or Ctrl or Shift is also good. Make sure they are not used by the OS. Best is to create key sequence with them. [see Emacs: Define Key Sequence]
- F1, F2, F3, F4, F10, F11
- Their default commands are not frequently used, or, better with other keys. [see Emacs Key Layout Diagram]
- Ctrl+0 to Ctrl+9, Alt+0 to Alt+9
- By default they are
digit-argument. Such is not very frequently used. If you need them, use the more general
- Number Pad Keys
- Very useful, but depending on which emacs distro/OS you are using, or if you use emacs in terminal or GUI, binding these keys may not work. [see Emacs: Bind Number Pad Keys]
Emacs Custom Keybinding to Enhance Productivity.
System Wide Keybinding Setup
Get Programable Keyboard
These days, best option is to get a programable keyboard. This way, you don't have to worry about Operating System keyboard config. Just plug it in in any computer and the keys do what you want.
see Programable Keyboards with Onboard Memory
Put $5 at https://www.patreon.com/xahlee , or goto paypal.com and pay to Xah@XahLee.org . Message me on XahLee discord, say so, ask me questions.
Or Buy Xah Emacs Tutorial