summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJuri Linkov <juri@linkov.net>2022-07-06 20:39:41 +0300
committerJuri Linkov <juri@linkov.net>2022-07-06 20:39:41 +0300
commit0e99046d62e71fb874cb9010e60ecfee289f84e9 (patch)
treef949517518d9ebef48923c6ecc409f43c2db9fa5 /doc
parent6a7bb1ddbc9837b2d2af60236be58723114855ac (diff)
downloademacs-0e99046d62e71fb874cb9010e60ecfee289f84e9.tar.gz
Add new args MESSAGE and TIMEOUT to set-transient-map (bug#21634)
* lisp/subr.el (set-transient-map): Add new args MESSAGE and TIMEOUT. (set-transient-map-timeout, set-transient-map-timer): New variables. * lisp/international/emoji.el (emoji-zoom-increase): * lisp/indent.el (indent-rigidly): * lisp/face-remap.el (text-scale-adjust, global-text-scale-adjust): Use the arg MESSAGE of set-transient-map. * doc/lispref/keymaps.texi (Controlling Active Maps): Mention new args MESSAGE and TIMEOUT of set-transient-map.
Diffstat (limited to 'doc')
-rw-r--r--doc/lispref/keymaps.texi10
1 files changed, 10 insertions, 0 deletions
diff --git a/doc/lispref/keymaps.texi b/doc/lispref/keymaps.texi
index 9488c4d7b35..8df4b6f2b47 100644
--- a/doc/lispref/keymaps.texi
+++ b/doc/lispref/keymaps.texi
@@ -1063,6 +1063,16 @@ The optional argument @var{on-exit}, if non-@code{nil}, specifies a
function that is called, with no arguments, after @var{keymap} is
deactivated.
+The optional argument @var{message}, if a string, specifies the format
+string for the message to display after activating the transient map.
+When the string contains the specifier @samp{%k}, it's replaced with
+the list of keys from the transient map.
+
+The optional argument @var{timeout}, if a number, specifies the number
+of seconds of idle time after which @var{keymap} is deactivated. The
+value of the argument @var{timeout} can be overridden by the variable
+@code{set-transient-map-timeout}.
+
This function works by adding and removing @var{keymap} from the
variable @code{overriding-terminal-local-map}, which takes precedence
over all other active keymaps (@pxref{Searching Keymaps}).