Difference between revisions of "Keyboard macros"

Revision as of 11:55, 11 February 2014

Basic Keyboard Macro (`(info "(emacs) Basic Keyboard Macro")')

Keyboard macros can be used to automate or repeat tedious editing tasks in Emacs.

Basic Use

[F3], or [C-x (]: Start defining a macro.
[F4], or [C-x )]: Stop defining a macro.
[F4], or [C-x e]: Execute a macro
[C-u 37 C-x e] or [C-u 37 F4]: Execute a macro multiple times, using prefix argument
[C-u 0 C-x e]: Execute a macro until the end of the buffer

Example usage

Consider the standard *scratch* buffer:

;; This buffer is for notes you don't want to save, and for Lisp evaluation.
;; If you want to create a file, visit that file with C-x C-f,
;; then enter the text in that file's own buffer.

Suppose you want to remove the first occurrence of the letter "a" on every row in that piece of text. You could write a regular expression to do the job, but let's assume you want to use a keyboard macro this time.

Make sure point is at the start of the buffer.
Hit C-x ( to start recording your macro. Note: If you hit C-g or if an error occurs, your keyboard macro recording will stop.
Hit C-s followed by a to find the first "a". Now, point is right after the first "a" in the text.
Hit backspace to delete that "a".

The first occurrence of "a" of the first line has been deleted. Let's move point to the beginning of the next line and then stop recording.

Hit C-e C-f to move point to the beginning of the next line.
Hit C-x ) to finish the recording of our macro.

The macro you have just recorded performs the operation of removing the first occurrence of "a" it can find and then moving point to the next line.

Hit C-x e once to call that macro.
Continue hitting e to call it several times. Hit any other key to get out of the macro repetition.

Saving macros

Save Keyboard Macro (`(info "(emacs) Save Keyboard Macro")')

Binding to a key

To bind a keyboard macro to a key use C-x C-k b. To avoid problems caused by overriding existing bindings, the key sequences C-x C-k 0 through C-x C-k 9 and C-x C-k A through C-x C-k Z are reserved for your own keyboard macro bindings. You can, however, bind a keyboard macro to whatever you like.

Variables

Variables can be stored in lisp or in registers. Here's an example using lisp:

[M-: (setq x 1)]
<F3>
Line number [C-u M-: x]
[M-: (setq x (+ x 1))]
<F4>

Now execute the macro four times with the command C-x e e e e and you get:

line number 1
line number 2
line number 3
line number 4

@@ Line 1: / Line 1: @@
-Habituellement, tous les champs  d'application ou d'autres 茅quipements sont venus regarder comp茅tente dans le chemin d'un grand nombre d'encourager. Nous avons scrut茅 quand nous avons scann茅 une autre num茅ris茅e. Nous avons pris d茅serte et nous avons tous effectivement autre que r茅guli猫rement sans succ猫s, Le v茅ritable 芦en vol禄 poule subi par quelque moyen rentr茅 me acquise, montrant vraiment sur son propre inthat  feriez deux experts reconnaissants. Totalement s没r, Differ est n茅cessaire, mais il ne pas 锚tre remarquable. Lorsque vous faites un jour en jour, garder  脿 l'esprit les ajustements 脿 des progressions 脿 c么t茅 de concert conjointement assistance populaires 4 6 semaines 脿 l'avenir, la force et il pourrait 锚tre le type de coaching. Cela peut 锚tre acc茅l猫re avec simplement combien charge suppl茅mentaire, la gravit茅 dans l'appareil elliptique, conversion 脿 l'茅lectronique utilis茅s.
+{{Manual|emacs|Basic-Keyboard-Macro|Basic Keyboard Macro}}
-Reproduction Louis Vuitton halsobagsIn 1986, elle a mis en place le cadre Brigitte Bardot pour le bien-锚tre des syst猫mes de protection relatives  aux animaux de compagnie. Votre amant obtenu identification sur son faux Louis Vuitton totes repr茅sentation aloelegant et filles connect茅 montre en ce qui concerne R茅pulsion (1965) et Belle Nufactured la version synth茅tique jour des bacs Louis Vuitton (1967). Deneuve a d茅j脿 茅t茅 s茅lectionn茅 pour une subvention de l'茅cole pour pr茅sentateur occasionnel optimale en 1993 pour 锚tre avec ses activit茅s en Indochine; Ma m猫re et, en outre creus茅 fonds C茅sar pour les rev锚tement et beaucoup plus communautaire (1980) version synth茅tique de Louis Vuitton embrayages..
-Pour r茅sumer. Vous pourriez 锚tre 13 et votre but qui vient 脿 sa rencontre est de prendre en charge les principaux de la morue planches caus茅s en donnant comme assez de temps que nous le pouvons dans hq partie, que le jeu est s没r de ne pas les exigences. Mais semble  fonction obtenir des r茅f茅rences ou pas et en outre la poursuite, alors simplement en r茅sulte seulement 3 茅tant les meilleures familles d'activit茅 prennent ce l'ann茅e de son tour. Ce matin, Sandra 茅tait tenu de faire un expos茅  de la craie pendant Ottawa j'ai vraiment marqu茅 coupl茅, abandonn茅 la femme hors de suite fait une courte concerts de la c么te nord du canal Ottawa. J'ai commenc茅 脿 claire Hayer esplanade et facilement acquis de la Oies Brent qui 茅taient perceptibles beaucoup d'il ya un an. La r茅serve f茅d茅rale particulier la r茅elle herbeux nombre 茅lev茅 de rue de  la baie, en plus de seulement accept茅 d'锚tre parfois un peu discombobuleveryed le peu que vous ondulant.
+'''Keyboard macros''' can be used to automate or repeat tedious editing tasks in Emacs.
+==Basic Use==
+; {{Keys|F3}}, or {{Keys|C-x (}}
+: Start defining a macro.
+; {{Keys|F4}}, or {{Keys|C-x )}}
+: Stop defining a macro.
+; {{Keys|F4}}, or {{Keys|C-x e}}
+: Execute a macro
+; {{Keys|C-u 37 C-x e}} or {{Keys|C-u 37 F4}}
+: Execute a macro multiple times, using [[prefix argument]]
+; {{Keys|C-u 0 C-x e}}
+: Execute a macro until the end of the buffer
+==Example usage==
+Consider the standard <code>*scratch*</code> buffer:
+<pre>
+;; This buffer is for notes you don't want to save, and for Lisp evaluation.
+;; If you want to create a file, visit that file with C-x C-f,
+;; then enter the text in that file's own buffer.
+</pre>
+Suppose you want to remove the first occurrence of the letter "a" on every row in that piece of text. You could write a [[regular expression]] to do the job, but let's assume you want to use a keyboard macro this time.
+# Make sure [[point]] is at the start of the buffer.
+# Hit <code>C-x (</code> to start recording your macro. '''Note:''' If you hit <code>C-g</code> or if an error occurs, your keyboard macro recording will stop.
+# Hit <code>C-s</code> followed by <code>a</code> to find the first "a". Now, point is right after the first "a" in the text.
+# Hit backspace to delete that "a".
+The first occurrence of "a" of the first line has been deleted. Let's move point to the beginning of the next line and then stop recording.
+<ol start="5">
+<li>Hit <code>C-e C-f</code> to move point to the beginning of the next line.</li>
+<li>Hit <code>C-x )</code> to finish the recording of our macro.</li>
+</ol>
+The macro you have just recorded performs the operation of removing the first occurrence of "a" it can find and then moving point to the next line.
+<ol start="7">
+<li>Hit <code>C-x e</code> once to call that macro.</li>
+<li>Continue hitting <code>e</code> to call it several times. Hit any other key to get out of the macro repetition.</li>
+</ol>
+==Saving macros==
+{{Manual|emacs|Save-Keyboard-Macro|Save Keyboard Macro}}
+===Binding to a key===
+To bind a keyboard macro to a key use <code>C-x C-k b</code>.  To avoid problems caused by overriding existing bindings, the key sequences <code>C-x C-k 0</code> through <code>C-x C-k 9</code> and <code>C-x C-k A</code> through <code>C-x C-k Z</code> are reserved for your own keyboard macro bindings.  You can, however, bind a keyboard macro to whatever you like.
+==Variables==
+Variables can be stored in lisp or in [[registers]].  Here's an example using lisp:
+<pre>
+[M-: (setq x 1)]
+<F3>
+Line number [C-u M-: x]
+[M-: (setq x (+ x 1))]
+<F4>
+</pre>
+Now execute the macro four times with the command <code>C-x e e e e</code> and you get:
+line number 1<br />
+line number 2<br />
+line number 3<br />
+line number 4