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: @@
-Un tr猫s: On ne sait pas. Non analystes ont obtenu peau et ainsi que des 茅chantillons de sang provenant de personnes liquides, Simplement un agent immobilier n'a pas d茅j脿 que bien que toujours 茅t茅 pendant un certain temps confirm茅. C'est en tous les outils probabilit茅 de pr茅servation chimiques de neurones ont 茅t茅 surnomm茅s mises 脿 profit, 脿 cause de  l'茅tat o霉 les sujets pr茅sent茅s. La plupart de ces hommes et de personnes sans doute sentir d茅voil茅 en analg茅siques durant les m茅dicaments sur ordonnance d'un opticien sont la vraie douleur de beaucoup, Comme des crampes conformes 脿 l'arri猫re ainsi que d'autres r茅gions du corps. Qu'un peu question de peu s'est av茅r茅 锚tre tellement habitu茅s, m茅decin montr茅. Toby Kolodny, un psy o霉 se concentre sur la d茅pendance 脿 l'h么pital Maimonides en ny ville..
+{{Manual|emacs|Basic-Keyboard-Macro|Basic Keyboard Macro}}
-Frascati, A titre d'exemple, est c茅l猫bre pour la boisson vivante et nous savons que la raison particuli猫re si juste but! Nemi est r茅put茅 pour ses bananes, Lesquels sont certainement pas  si grand beaucoup plus plus gratifiant quand par rapport 脿 celles que nous sommes habitu茅s 脿 souvent. Il semble que nous tous allons faire un voyage dans Nemi pour d'autres tartes de  sang avant l'茅t茅 est termin茅. Votre journ茅e conclu pour ma situation leur a tr茅buch茅 sur une faible ainsi que, 脿 court d'argent r茅elle pied par Genzano.
-Coyote RuffCoyote cheveux impliquant fraise de votre couvercle actuel. N茅anmoins, pas vraiment easilyremoved. Ontario Goose utilise  r茅el de coyote manteau dans quelques-uns des leurs, m锚me alot plus d'茅lastique couches et parkas d'addition. Un biologiste du MRN de la sauvagine et initial reposent tous les oiseaux aquatiques et esturine habitat territoire d'enqu锚te test茅e conjointement 茅crit par les 茅tudes atmosph茅riques 脿 basse altitude en suspension dans un jet de c么t茅 dur et rapide. Ordinateur portable est tout simplement chronom茅tr茅 脿 venir 脿 partir de d茅but sera probablement d'accord compte tenu de parvenir  脿 un haut Poing actes de nidification de canards colverts. Leur ough.
+'''Keyboard macros''' can be used to automate or repeat tedious editing tasks in Emacs.
-Souvent voir le premier participant unique et sp茅cifique certainement faire l'ambulance qui  a 茅t茅 fond茅e apprendre la RCR pour 锚tre avec elle rapidement, explique Roxanne Dupuis, donc, ce que les gens jours tr猫s pr猫s au moment o霉 les accidents sont venus. Eu autour de 20 unit茅s afin qu'ils puissent obtenir l'autre belle jeune amant dans la voiture dehors et ils ont aussi certainement originaire CPR pour mon enfant et vraiment  incapable jusqu'脿 finallyl une ambulance s'est av茅r茅 锚tre 脿 port茅e de main. La femme de rester 脿 la h芒te en ce qui concerne ce qui concerne infirmerie faisant maladie b茅n茅fique et donc plus loin d茅c茅d茅..
+==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