Function: describe-map-tree

describe-map-tree is a function alias for help--describe-map-tree, defined in help.el.gz.

This function is obsolete since 30.1; use help--describe-map-tree instead.

Signature

(describe-map-tree STARTMAP &optional PARTIAL SHADOW PREFIX TITLE NO-MENU TRANSL ALWAYS-TITLE MENTION-SHADOW BUFFER)

Documentation

Insert a description of the key bindings in STARTMAP.

This is followed by the key bindings of all maps reachable through STARTMAP.

If PARTIAL is non-nil, omit certain uninteresting commands
(such as undefined).

If SHADOW is non-nil, it is a list of maps; don't mention keys which would be shadowed by any of them.

If PREFIX is non-nil, mention only keys that start with PREFIX.

If TITLE is non-nil, is a string to insert at the beginning. TITLE should not end with a colon or a newline; we supply that.

If NO-MENU is non-nil, then omit menu-bar commands.

If TRANSL is non-nil, the definitions are actually key translations so print strings and vectors differently.

If ALWAYS-TITLE is non-nil, print the title even if there are no maps to look through.

If MENTION-SHADOW is non-nil, then when something is shadowed by SHADOW, don't omit it; instead, mention it but say it is shadowed.

If BUFFER, lookup keys while in that buffer. This only affects things like :filters for menu bindings.

Aliases

describe-map-tree (obsolete since 30.1)