emacs-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Doc of keyboard macros


From: Stefan Monnier
Subject: Doc of keyboard macros
Date: Mon, 24 Sep 2018 10:47:55 -0400
User-agent: Gnus/5.13 (Gnus v5.13) Emacs/27.0.50 (gnu/linux)

https://emacs.stackexchange.com/questions/44918 points out that `C-x (`
and `C-x e` are not very visible in the doc, while F3 and F4 may be
difficult to reach on Apple's machines (and I just saw that they are
also difficult to reach on my Debian machine for some reason).
So I suggest making the "old" keyboard macro bindings a bit more
prominent in the doc (I also happen to prefer them over F3 and F4,
because of their mnemonic value).

Any objection to the patch below for emacs-26?


        Stefan


diff --git a/doc/emacs/kmacro.texi b/doc/emacs/kmacro.texi
index dac41fdb87..e71f23632d 100644
--- a/doc/emacs/kmacro.texi
+++ b/doc/emacs/kmacro.texi
@@ -47,19 +47,27 @@ Keyboard Macros
 @node Basic Keyboard Macro
 @section Basic Use
 
address@hidden @kbd
address@hidden @key{F3}
address@hidden @asis
address@hidden @kbd{C-x (} or @key{F3}
 Start defining a keyboard macro
 (@code{kmacro-start-macro-or-insert-counter}).
address@hidden @key{F4}
-If a keyboard macro is being defined, end the definition; otherwise,
-execute the most recent keyboard macro
-(@code{kmacro-end-or-call-macro}).
address@hidden C-u @key{F3}
-Re-execute last keyboard macro, then append keys to its definition.
address@hidden C-u C-u @key{F3}
-Append keys to the last keyboard macro without re-executing it.
address@hidden C-x C-k r
+
+When invoked with a @kbd{C-u} prefix, it first re-executes the last
+keyboard macro and then appends keys to its definition.
+
+When invoked with a double @kbd{C-u C-u}
+it append keys to the last keyboard macro without re-executing it.
+
address@hidden @kbd{C-x e} or @key{F4}
+Execute the most recent keyboard macro.  If a keyboard macro is being
+defined, end the definition.
+
+For historical reasons, the two bindings are subtly different: if
+invoked while a macro is being defined, @key{F4} only ends the current
+definition, while @kbd{C-x e} additionally immediately executes the
+just defined macro.
+
address@hidden @kbd{C-x C-k r}
 Run the last keyboard macro on each line that begins in the region
 (@code{apply-macro-to-region-lines}).
 @end table



reply via email to

[Prev in Thread] Current Thread [Next in Thread]