Elisp: Documentation Lookup

By Xah Lee. Date: . Last updated: .

Look Up Function Doc String

The following function you will use often when you code elisp.

Alt+x describe-functionCtrl+h f】, then type the function name. (if the function name is under cursor, you don't need to type the name, just hit Enter.)

emacs describe function 2017 06 21
emacs describe-function output

In the help buffer, press Tab to move cursor to the link then press Enter to open it. Or use mouse to click on links.

Look Up Variable Doc String

Alt+x describe-variable for doc string of variables.

Some words (symbols) in elisp source code are variables, not function.

For example, sentence-end-double-space is a variable.

Practical Emacs Lisp


Basic Functions

Writing Command

Writing Script