Commit | Line | Data |
---|---|---|
8cf51b2c | 1 | @c This is part of the Emacs manual. |
ab422c4d PE |
2 | @c Copyright (C) 1985-1987, 1993-1995, 1997, 2000-2013 Free Software |
3 | @c Foundation, Inc. | |
8cf51b2c | 4 | @c See file emacs.texi for copying conditions. |
abb9615e | 5 | @node Search |
8cf51b2c GM |
6 | @chapter Searching and Replacement |
7 | @cindex searching | |
8 | @cindex finding strings within text | |
9 | ||
b5fb9df5 CY |
10 | Like other editors, Emacs has commands to search for occurrences of |
11 | a string. Emacs also has commands to replace occurrences of a string | |
12 | with a different string. There are also commands that do the same | |
13 | thing, but search for patterns instead of fixed strings. | |
14 | ||
15 | You can also search multiple files under the control of a tags table | |
16 | (@pxref{Tags Search}) or through the Dired @kbd{A} command | |
8cf51b2c GM |
17 | (@pxref{Operating on Files}), or ask the @code{grep} program to do it |
18 | (@pxref{Grep Searching}). | |
19 | ||
8cf51b2c | 20 | @menu |
8838673e GM |
21 | * Incremental Search:: Search happens as you type the string. |
22 | * Nonincremental Search:: Specify entire string and then search. | |
23 | * Word Search:: Search for sequence of words. | |
05b621a6 | 24 | * Symbol Search:: Search for a source code symbol. |
8838673e GM |
25 | * Regexp Search:: Search for match for a regexp. |
26 | * Regexps:: Syntax of regular expressions. | |
27 | * Regexp Backslash:: Regular expression constructs starting with `\'. | |
28 | * Regexp Example:: A complex regular expression explained. | |
29 | * Search Case:: To ignore case while searching, or not. | |
30 | * Replace:: Search, and replace some or all matches. | |
31 | * Other Repeating Search:: Operating on all matches for some regexp. | |
8cf51b2c GM |
32 | @end menu |
33 | ||
34 | @node Incremental Search | |
35 | @section Incremental Search | |
36 | @cindex incremental search | |
37 | @cindex isearch | |
38 | ||
b5fb9df5 CY |
39 | The principal search command in Emacs is @dfn{incremental}: it |
40 | begins searching as soon as you type the first character of the search | |
41 | string. As you type in the search string, Emacs shows you where the | |
42 | string (as you have typed it so far) would be found. When you have | |
43 | typed enough characters to identify the place you want, you can stop. | |
44 | Depending on what you plan to do next, you may or may not need to | |
45 | terminate the search explicitly with @key{RET}. | |
8cf51b2c GM |
46 | |
47 | @table @kbd | |
48 | @item C-s | |
49 | Incremental search forward (@code{isearch-forward}). | |
50 | @item C-r | |
51 | Incremental search backward (@code{isearch-backward}). | |
52 | @end table | |
53 | ||
54 | @menu | |
80fa505f AM |
55 | * Basic Isearch:: Basic incremental search commands. |
56 | * Repeat Isearch:: Searching for the same string again. | |
57 | * Error in Isearch:: When your string is not found. | |
58 | * Special Isearch:: Special input in incremental search. | |
59 | * Isearch Yank:: Commands that grab text into the search string | |
60 | or else edit the search string. | |
61 | * Not Exiting Isearch:: Prefix argument and scrolling commands. | |
62 | * Isearch Minibuffer:: Incremental search of the minibuffer history. | |
8cf51b2c GM |
63 | @end menu |
64 | ||
65 | @node Basic Isearch | |
66 | @subsection Basics of Incremental Search | |
67 | ||
b5fb9df5 | 68 | @table @kbd |
97b3a00b | 69 | @item C-s |
b5fb9df5 CY |
70 | Begin incremental search (@code{isearch-forward}). |
71 | @item C-r | |
72 | Begin reverse incremental search (@code{isearch-backward}). | |
73 | @end table | |
74 | ||
8cf51b2c GM |
75 | @kindex C-s |
76 | @findex isearch-forward | |
b5fb9df5 CY |
77 | @kbd{C-s} (@code{isearch-forward}) starts a forward incremental |
78 | search. It reads characters from the keyboard, and moves point just | |
79 | past the end of the next occurrence of those characters in the buffer. | |
80 | ||
81 | For instance, if you type @kbd{C-s} and then @kbd{F}, that puts the | |
82 | cursor after the first @samp{F} that occurs in the buffer after the | |
83 | starting point. Then if you then type @kbd{O}, the cursor moves to | |
84 | just after the first @samp{FO}; the @samp{F} in that @samp{FO} might | |
85 | not be the first @samp{F} previously found. After another @kbd{O}, | |
86 | the cursor moves to just after the first @samp{FOO}. | |
87 | ||
88 | @cindex faces for highlighting search matches | |
89 | At each step, Emacs highlights the @dfn{current match}---the buffer | |
90 | text that matches the search string---using the @code{isearch} face | |
91 | (@pxref{Faces}). The current search string is also displayed in the | |
92 | echo area. | |
93 | ||
94 | If you make a mistake typing the search string, type @key{DEL}. | |
95 | Each @key{DEL} cancels the last character of the search string. | |
96 | ||
97 | When you are satisfied with the place you have reached, type | |
98 | @key{RET}. This stops searching, leaving the cursor where the search | |
8cf51b2c GM |
99 | brought it. Also, any command not specially meaningful in searches |
100 | stops the searching and is then executed. Thus, typing @kbd{C-a} | |
b5fb9df5 | 101 | exits the search and then moves to the beginning of the line. |
8cf51b2c GM |
102 | @key{RET} is necessary only if the next command you want to type is a |
103 | printing character, @key{DEL}, @key{RET}, or another character that is | |
104 | special within searches (@kbd{C-q}, @kbd{C-w}, @kbd{C-r}, @kbd{C-s}, | |
b5fb9df5 CY |
105 | @kbd{C-y}, @kbd{M-y}, @kbd{M-r}, @kbd{M-c}, @kbd{M-e}, and some others |
106 | described below). | |
107 | ||
108 | As a special exception, entering @key{RET} when the search string is | |
109 | empty launches nonincremental search (@pxref{Nonincremental Search}). | |
8cf51b2c | 110 | |
6184c708 | 111 | When you exit the incremental search, it adds the original value of |
b5fb9df5 CY |
112 | point to the mark ring, without activating the mark; you can thus use |
113 | @kbd{C-u C-@key{SPC}} to return to where you were before beginning the | |
6184c708 CY |
114 | search. @xref{Mark Ring}. It only does this if the mark was not |
115 | already active. | |
8cf51b2c | 116 | |
b5fb9df5 CY |
117 | @kindex C-r |
118 | @findex isearch-backward | |
119 | To search backwards, use @kbd{C-r} (@code{isearch-backward}) instead | |
120 | of @kbd{C-s} to start the search. A backward search finds matches | |
121 | that end before the starting point, just as a forward search finds | |
122 | matches that begin after it. | |
123 | ||
8cf51b2c GM |
124 | @node Repeat Isearch |
125 | @subsection Repeating Incremental Search | |
126 | ||
b5fb9df5 CY |
127 | Suppose you search forward for @samp{FOO} and find a match, but not |
128 | the one you expected to find: the @samp{FOO} you were aiming for | |
129 | occurs later in the buffer. In this event, type another @kbd{C-s} to | |
130 | move to the next occurrence of the search string. You can repeat this | |
131 | any number of times. If you overshoot, you can cancel some @kbd{C-s} | |
132 | characters with @key{DEL}. Similarly, each @kbd{C-r} in a backward | |
133 | incremental search repeats the backward search. | |
134 | ||
135 | @cindex lazy search highlighting | |
136 | @vindex isearch-lazy-highlight | |
137 | If you pause for a little while during incremental search, Emacs | |
138 | highlights all the other possible matches for the search string that | |
139 | are present on the screen. This helps you anticipate where you can | |
140 | get to by typing @kbd{C-s} or @kbd{C-r} to repeat the search. The | |
141 | other matches are highlighted differently from the current match, | |
142 | using the customizable face @code{lazy-highlight} (@pxref{Faces}). If | |
143 | you don't like this feature, you can disable it by setting | |
144 | @code{isearch-lazy-highlight} to @code{nil}. | |
145 | ||
146 | After exiting a search, you can search for the same string again by | |
147 | typing just @kbd{C-s C-s}. The first @kbd{C-s} is the key that | |
148 | invokes incremental search, and the second @kbd{C-s} means ``search | |
16152b76 | 149 | again''. Similarly, @kbd{C-r C-r} searches backward for the last |
b5fb9df5 CY |
150 | search string. In determining the last search string, it doesn't |
151 | matter whether the string was searched for with @kbd{C-s} or | |
152 | @kbd{C-r}. | |
8cf51b2c | 153 | |
b5fb9df5 CY |
154 | If you are searching forward but you realize you were looking for |
155 | something before the starting point, type @kbd{C-r} to switch to a | |
156 | backward search, leaving the search string unchanged. Similarly, | |
157 | @kbd{C-s} in a backward search switches to a forward search. | |
8cf51b2c GM |
158 | |
159 | If a search is failing and you ask to repeat it by typing another | |
160 | @kbd{C-s}, it starts again from the beginning of the buffer. | |
161 | Repeating a failing reverse search with @kbd{C-r} starts again from | |
162 | the end. This is called @dfn{wrapping around}, and @samp{Wrapped} | |
163 | appears in the search prompt once this has happened. If you keep on | |
164 | going past the original starting point of the search, it changes to | |
165 | @samp{Overwrapped}, which means that you are revisiting matches that | |
166 | you have already seen. | |
167 | ||
b5fb9df5 | 168 | @cindex search ring |
5abc31ef CY |
169 | @kindex M-n @r{(Incremental search)} |
170 | @kindex M-p @r{(Incremental search)} | |
8cf51b2c | 171 | To reuse earlier search strings, use the @dfn{search ring}. The |
b5fb9df5 CY |
172 | commands @kbd{M-p} and @kbd{M-n} move through the ring to pick a |
173 | search string to reuse. These commands leave the selected search ring | |
5abc31ef CY |
174 | element in the minibuffer, where you can edit it. |
175 | ||
176 | @kindex M-e @r{(Incremental search)} | |
177 | To edit the current search string in the minibuffer without | |
6d65486d | 178 | replacing it with items from the search ring, type @kbd{M-e}. Type @key{RET}, |
5abc31ef | 179 | @kbd{C-s} or @kbd{C-r} to finish editing the string and search for it. |
8cf51b2c GM |
180 | |
181 | @node Error in Isearch | |
182 | @subsection Errors in Incremental Search | |
183 | ||
184 | If your string is not found at all, the echo area says @samp{Failing | |
5abc31ef CY |
185 | I-Search}, and the cursor moves past the place where Emacs found as |
186 | much of your string as it could. Thus, if you search for @samp{FOOT}, | |
187 | and there is no @samp{FOOT}, you might see the cursor after the | |
188 | @samp{FOO} in @samp{FOOL}. In the echo area, the part of the search | |
189 | string that failed to match is highlighted using the face | |
b5fb9df5 CY |
190 | @code{isearch-fail}. |
191 | ||
192 | At this point, there are several things you can do. If your string | |
193 | was mistyped, you can use @key{DEL} to erase some of it and correct | |
194 | it. If you like the place you have found, you can type @key{RET} to | |
195 | remain there. Or you can type @kbd{C-g}, which removes from the | |
196 | search string the characters that could not be found (the @samp{T} in | |
197 | @samp{FOOT}), leaving those that were found (the @samp{FOO} in | |
8cf51b2c GM |
198 | @samp{FOOT}). A second @kbd{C-g} at that point cancels the search |
199 | entirely, returning point to where it was when the search started. | |
200 | ||
201 | @cindex quitting (in search) | |
5abc31ef | 202 | @kindex C-g @r{(Incremental search)} |
b5fb9df5 CY |
203 | The quit command, @kbd{C-g}, does special things during searches; |
204 | just what it does depends on the status of the search. If the search | |
205 | has found what you specified and is waiting for input, @kbd{C-g} | |
206 | cancels the entire search, moving the cursor back to where you started | |
207 | the search. If @kbd{C-g} is typed when there are characters in the | |
208 | search string that have not been found---because Emacs is still | |
209 | searching for them, or because it has failed to find them---then the | |
210 | search string characters which have not been found are discarded from | |
211 | the search string. With them gone, the search is now successful and | |
212 | waiting for more input, so a second @kbd{C-g} will cancel the entire | |
213 | search. | |
8cf51b2c GM |
214 | |
215 | @node Special Isearch | |
216 | @subsection Special Input for Incremental Search | |
217 | ||
b5fb9df5 CY |
218 | Some of the characters you type during incremental search have |
219 | special effects. | |
220 | ||
48de8b12 CY |
221 | @cindex lax space matching |
222 | @kindex M-s SPC @r{(Incremental search)} | |
223 | @kindex SPC @r{(Incremental search)} | |
224 | @findex isearch-toggle-lax-whitespace | |
225 | @vindex search-whitespace-regexp | |
226 | By default, incremental search performs @dfn{lax space matching}: | |
227 | each space, or sequence of spaces, matches any sequence of one or more | |
228 | spaces in the text. Hence, @samp{foo bar} matches @samp{foo bar}, | |
229 | @samp{foo bar}, @samp{foo bar}, and so on (but not @samp{foobar}). | |
230 | More precisely, Emacs matches each sequence of space characters in the | |
231 | search string to a regular expression specified by the variable | |
232 | @code{search-whitespace-regexp}. For example, set it to | |
233 | @samp{"[[:space:]\n]+"} to make spaces match sequences of newlines as | |
234 | well as spaces. To toggle lax space matching, type @kbd{M-s SPC} | |
235 | (@code{isearch-toggle-lax-whitespace}). To disable this feature | |
236 | entirely, change @code{search-whitespace-regexp} to @code{nil}; then | |
237 | each space in the search string matches exactly one space | |
238 | ||
b5fb9df5 CY |
239 | If the search string you entered contains only lower-case letters, |
240 | the search is case-insensitive; as long as an upper-case letter exists | |
241 | in the search string, the search becomes case-sensitive. If you | |
242 | delete the upper-case character from the search string, it ceases to | |
243 | have this effect. @xref{Search Case}. | |
244 | ||
245 | To search for a newline character, type @kbd{C-j}. | |
246 | ||
247 | To search for other control characters, such as @key{control-S}, | |
248 | quote it by typing @kbd{C-q} first (@pxref{Inserting Text}). To | |
249 | search for non-@acronym{ASCII} characters, you can either use | |
250 | @kbd{C-q} and enter its octal code, or use an input method | |
251 | (@pxref{Input Methods}). If an input method is enabled in the current | |
252 | buffer when you start the search, you can use it in the search string | |
253 | also. While typing the search string, you can toggle the input method | |
254 | with the command @kbd{C-\} (@code{isearch-toggle-input-method}). You | |
255 | can also turn on a non-default input method with @kbd{C-^} | |
256 | (@code{isearch-toggle-specified-input-method}), which prompts for the | |
257 | name of the input method. When an input method is active during | |
258 | incremental search, the search prompt includes the input method | |
259 | mnemonic, like this: | |
8cf51b2c GM |
260 | |
261 | @example | |
262 | I-search [@var{im}]: | |
263 | @end example | |
264 | ||
265 | @noindent | |
266 | @findex isearch-toggle-input-method | |
267 | @findex isearch-toggle-specified-input-method | |
b5fb9df5 CY |
268 | where @var{im} is the mnemonic of the active input method. Any input |
269 | method you enable during incremental search remains enabled in the | |
270 | current buffer afterwards. | |
8cf51b2c | 271 | |
9cfa31ea CY |
272 | @kindex M-% @r{(Incremental search)} |
273 | Typing @kbd{M-%} in incremental search invokes @code{query-replace} | |
b5fb9df5 CY |
274 | or @code{query-replace-regexp} (depending on search mode) with the |
275 | current search string used as the string to replace. @xref{Query | |
276 | Replace}. | |
277 | ||
9cfa31ea CY |
278 | @kindex M-TAB @r{(Incremental search)} |
279 | Typing @kbd{M-@key{TAB}} in incremental search invokes | |
280 | @code{isearch-complete}, which attempts to complete the search string | |
281 | using the search ring as a list of completion alternatives. | |
282 | @xref{Completion}. In many operating systems, the @kbd{M-@key{TAB}} | |
283 | key sequence is captured by the window manager; you then need to | |
284 | rebind @code{isearch-complete} to another key sequence if you want to | |
285 | use it (@pxref{Rebinding}). | |
286 | ||
b5fb9df5 CY |
287 | @vindex isearch-mode-map |
288 | When incremental search is active, you can type @kbd{C-h C-h} to | |
e7a3ff06 CY |
289 | access interactive help options, including a list of special key |
290 | bindings. These key bindings are part of the keymap | |
b5fb9df5 | 291 | @code{isearch-mode-map} (@pxref{Keymaps}). |
8cf51b2c GM |
292 | |
293 | @node Isearch Yank | |
294 | @subsection Isearch Yanking | |
295 | ||
5abc31ef CY |
296 | @kindex C-y @r{(Incremental search)} |
297 | @kindex M-y @r{(Incremental search)} | |
298 | @findex isearch-yank-kill | |
299 | @findex isearch-yank-pop | |
892777ba | 300 | Within incremental search, @kbd{C-y} (@code{isearch-yank-kill}) |
5abc31ef CY |
301 | appends the current kill to the search string. @kbd{M-y} |
302 | (@code{isearch-yank-pop}), if called after @kbd{C-y}, replaces that | |
303 | appended text with an earlier kill, similar to the usual @kbd{M-y} | |
304 | (@code{yank-pop}) command (@pxref{Yanking}). @kbd{Mouse-2} appends | |
305 | the current X selection (@pxref{Primary Selection}). | |
306 | ||
307 | @kindex C-w @r{(Incremental search)} | |
308 | @findex isearch-yank-word-or-char | |
309 | @kbd{C-w} (@code{isearch-yank-word-or-char}) appends the next | |
310 | character or word at point to the search string. This is an easy way | |
311 | to search for another occurrence of the text at point. (The decision | |
312 | of whether to copy a character or a word is heuristic.) | |
313 | ||
314 | @kindex M-s C-e @r{(Incremental search)} | |
315 | @findex isearch-yank-line | |
316 | Similarly, @kbd{M-s C-e} (@code{isearch-yank-line}) appends the rest | |
317 | of the current line to the search string. If point is already at the | |
318 | end of a line, it appends the next line. | |
892777ba CY |
319 | |
320 | If the search is currently case-insensitive, both @kbd{C-w} and | |
321 | @kbd{M-s C-e} convert the text they copy to lower case, so that the | |
322 | search remains case-insensitive. | |
8cf51b2c | 323 | |
5abc31ef CY |
324 | @kindex C-M-w @r{(Incremental search)} |
325 | @kindex C-M-y @r{(Incremental search)} | |
326 | @findex isearch-del-char | |
327 | @findex isearch-yank-char | |
328 | @kbd{C-M-w} (@code{isearch-del-char}) deletes the last character | |
329 | from the search string, and @kbd{C-M-y} (@code{isearch-yank-char}) | |
58179cce | 330 | appends the character after point to the search string. An |
5abc31ef CY |
331 | alternative method to add the character after point is to enter the |
332 | minibuffer with @kbd{M-e} (@pxref{Repeat Isearch}) and type @kbd{C-f} | |
333 | at the end of the search string in the minibuffer. | |
8cf51b2c | 334 | |
80fa505f AM |
335 | @node Not Exiting Isearch |
336 | @subsection Not Exiting Incremental Search | |
8cf51b2c | 337 | |
80fa505f AM |
338 | This subsection describes two categories of commands which you can |
339 | type without exiting the current incremental search, even though they | |
340 | are not themselves part of incremental search. | |
341 | ||
342 | @table @asis | |
343 | @item Prefix Arguments | |
344 | @vindex isearch-allow-prefix | |
345 | In incremental search, when you enter a prefix argument | |
346 | (@pxref{Arguments}), by default it will apply either to the next | |
347 | action in the search or to the command that exits the search. | |
348 | ||
349 | In previous versions of Emacs, entering a prefix argument always | |
350 | terminated the search. You can revert to this behavior by setting the | |
351 | variable @code{isearch-allow-prefix} to @code{nil}. | |
352 | ||
353 | When @code{isearch-allow-scroll} is non-@code{nil} (see below), | |
354 | prefix arguments always have the default behavior described above. | |
355 | ||
356 | @item Scrolling Commands | |
40e67246 | 357 | @vindex isearch-allow-scroll |
5abc31ef CY |
358 | Normally, scrolling commands exit incremental search. If you change |
359 | the variable @code{isearch-allow-scroll} to a non-@code{nil} value, | |
360 | that enables the use of the scroll-bar, as well as keyboard scrolling | |
361 | commands like @kbd{C-v}, @kbd{M-v}, and @kbd{C-l} (@pxref{Scrolling}). | |
362 | This applies only to calling these commands via their bound key | |
363 | sequences---typing @kbd{M-x} will still exit the search. You can give | |
364 | prefix arguments to these commands in the usual way. This feature | |
365 | won't let you scroll the current match out of visibility, however. | |
366 | ||
367 | The @code{isearch-allow-scroll} feature also affects some other | |
291d142b CY |
368 | commands, such as @kbd{C-x 2} (@code{split-window-below}) and @kbd{C-x |
369 | ^} (@code{enlarge-window}), which don't exactly scroll but do affect | |
370 | where the text appears on the screen. It applies to any command whose | |
371 | name has a non-@code{nil} @code{isearch-scroll} property. So you can | |
372 | control which commands are affected by changing these properties. | |
8cf51b2c GM |
373 | |
374 | For example, to make @kbd{C-h l} usable within an incremental search | |
375 | in all future Emacs sessions, use @kbd{C-h c} to find what command it | |
5abc31ef CY |
376 | runs (@pxref{Key Help}), which is @code{view-lossage}. Then you can |
377 | put the following line in your init file (@pxref{Init File}): | |
8cf51b2c GM |
378 | |
379 | @example | |
380 | (put 'view-lossage 'isearch-scroll t) | |
381 | @end example | |
382 | ||
383 | @noindent | |
384 | This feature can be applied to any command that doesn't permanently | |
385 | change point, the buffer contents, the match data, the current buffer, | |
386 | or the selected window and frame. The command must not itself attempt | |
387 | an incremental search. | |
80fa505f | 388 | @end table |
8cf51b2c | 389 | |
b5fb9df5 CY |
390 | @node Isearch Minibuffer |
391 | @subsection Searching the Minibuffer | |
392 | @cindex minibuffer history, searching | |
393 | ||
394 | If you start an incremental search while the minibuffer is active, | |
395 | Emacs searches the contents of the minibuffer. Unlike searching an | |
396 | ordinary buffer, the search string is not shown in the echo area, | |
397 | because that is used to display the minibuffer. | |
398 | ||
399 | If an incremental search fails in the minibuffer, it tries searching | |
400 | the minibuffer history. @xref{Minibuffer History}. You can visualize | |
401 | the minibuffer and its history as a series of ``pages'', with the | |
402 | earliest history element on the first page and the current minibuffer | |
403 | on the last page. A forward search, @kbd{C-s}, searches forward to | |
404 | later pages; a reverse search, @kbd{C-r}, searches backwards to | |
405 | earlier pages. Like in ordinary buffer search, a failing search can | |
406 | wrap around, going from the last page to the first page or vice versa. | |
407 | ||
408 | When the current match is on a history element, that history element | |
409 | is pulled into the minibuffer. If you exit the incremental search | |
1df7defd | 410 | normally (e.g., by typing @key{RET}), it remains in the minibuffer |
bfd779dd | 411 | afterwards. Canceling the search, with @kbd{C-g}, restores the |
b5fb9df5 CY |
412 | contents of the minibuffer when you began the search. |
413 | ||
8cf51b2c GM |
414 | @node Nonincremental Search |
415 | @section Nonincremental Search | |
416 | @cindex nonincremental search | |
417 | ||
418 | Emacs also has conventional nonincremental search commands, which require | |
419 | you to type the entire search string before searching begins. | |
420 | ||
421 | @table @kbd | |
422 | @item C-s @key{RET} @var{string} @key{RET} | |
423 | Search for @var{string}. | |
424 | @item C-r @key{RET} @var{string} @key{RET} | |
425 | Search backward for @var{string}. | |
426 | @end table | |
427 | ||
b5fb9df5 CY |
428 | To start a nonincremental search, first type @kbd{C-s @key{RET}}. |
429 | This enters the minibuffer to read the search string; terminate the | |
430 | string with @key{RET}, and then the search takes place. If the string | |
431 | is not found, the search command signals an error. | |
8cf51b2c | 432 | |
8cf51b2c GM |
433 | @findex search-forward |
434 | @findex search-backward | |
5abc31ef CY |
435 | When you type @kbd{C-s @key{RET}}, the @kbd{C-s} invokes incremental |
436 | search as usual. That command is specially programmed to invoke the | |
437 | command for nonincremental search, @code{search-forward}, if the | |
438 | string you specify is empty. (Such an empty argument would otherwise | |
439 | be useless.) @kbd{C-r @key{RET}} does likewise, invoking the command | |
440 | @code{search-backward}. | |
8cf51b2c GM |
441 | |
442 | @node Word Search | |
443 | @section Word Search | |
444 | @cindex word search | |
445 | ||
b5fb9df5 CY |
446 | A @dfn{word search} finds a sequence of words without regard to the |
447 | type of punctuation between them. For instance, if you enter a search | |
448 | string that consists of two words separated by a single space, the | |
449 | search matches any sequence of those two words separated by one or | |
450 | more spaces, newlines, or other punctuation characters. This is | |
451 | particularly useful for searching text documents, because you don't | |
452 | have to worry whether the words you are looking for are separated by | |
453 | newlines or spaces. | |
8cf51b2c GM |
454 | |
455 | @table @kbd | |
b5fb9df5 CY |
456 | @item M-s w |
457 | If incremental search is active, toggle word search mode | |
458 | (@code{isearch-toggle-word}); otherwise, begin an incremental forward | |
459 | word search (@code{isearch-forward-word}). | |
97b3a00b JL |
460 | @item M-s w @key{RET} @var{words} @key{RET} |
461 | Search for @var{words}, using a forward nonincremental word search. | |
462 | @item M-s w C-r @key{RET} @var{words} @key{RET} | |
463 | Search backward for @var{words}, using a nonincremental word search. | |
8cf51b2c GM |
464 | @end table |
465 | ||
97b3a00b JL |
466 | @kindex M-s w |
467 | @findex isearch-forward-word | |
b5fb9df5 CY |
468 | To begin a forward incremental word search, type @kbd{M-s w}. If |
469 | incremental search is not already active, this runs the command | |
470 | @code{isearch-forward-word}. If incremental search is already active | |
471 | (whether a forward or backward search), @kbd{M-s w} switches to a word | |
472 | search while keeping the direction of the search and the current | |
473 | search string unchanged. You can toggle word search back off by | |
474 | typing @kbd{M-s w} again. | |
8cf51b2c GM |
475 | |
476 | @findex word-search-forward | |
477 | @findex word-search-backward | |
97b3a00b JL |
478 | To begin a nonincremental word search, type @kbd{M-s w @key{RET}} |
479 | for a forward search, or @kbd{M-s w C-r @key{RET}} for a backward search. | |
b5fb9df5 CY |
480 | These run the commands @code{word-search-forward} and |
481 | @code{word-search-backward} respectively. | |
482 | ||
2931c841 CY |
483 | Incremental and nonincremental word searches differ slightly in the |
484 | way they find a match. In a nonincremental word search, the last word | |
485 | in the search string must exactly match a whole word. In an | |
486 | incremental word search, the matching is more lax: the last word in | |
487 | the search string can match part of a word, so that the matching | |
488 | proceeds incrementally as you type. This additional laxity does not | |
489 | apply to the lazy highlight, which always matches whole words. | |
8cf51b2c | 490 | |
05b621a6 CY |
491 | @node Symbol Search |
492 | @section Symbol Search | |
493 | @cindex symbol search | |
494 | ||
495 | A @dfn{symbol search} is much like an ordinary search, except that | |
496 | the boundaries of the search must match the boundaries of a symbol. | |
497 | The meaning of @dfn{symbol} in this context depends on the major mode, | |
498 | and usually refers to a source code token, such as a Lisp symbol in | |
499 | Emacs Lisp mode. For instance, if you perform an incremental symbol | |
500 | search for the Lisp symbol @code{forward-word}, it would not match | |
501 | @code{isearch-forward-word}. This feature is thus mainly useful for | |
502 | searching source code. | |
503 | ||
504 | @table @kbd | |
505 | @item M-s _ | |
506 | If incremental search is active, toggle symbol search mode | |
507 | (@code{isearch-toggle-symbol}); otherwise, begin an incremental | |
508 | forward symbol search (@code{isearch-forward-symbol}). | |
509 | @item M-s _ @key{RET} @var{symbol} @key{RET} | |
510 | Search forward for @var{symbol}, nonincrementally. | |
511 | @item M-s _ C-r @key{RET} @var{symbol} @key{RET} | |
512 | Search backward for @var{symbol}, nonincrementally. | |
513 | @end table | |
514 | ||
515 | @kindex M-s _ | |
516 | @findex isearch-forward-symbol | |
517 | To begin a forward incremental symbol search, type @kbd{M-s _}. If | |
518 | incremental search is not already active, this runs the command | |
519 | @code{isearch-forward-symbol}. If incremental search is already | |
520 | active, @kbd{M-s _} switches to a symbol search, preserving the | |
521 | direction of the search and the current search string; you can disable | |
522 | symbol search by typing @kbd{M-s _} again. In incremental symbol | |
523 | search, only the beginning of the search string is required to match | |
524 | the beginning of a symbol. | |
525 | ||
526 | To begin a nonincremental symbol search, type @kbd{M-s _ @key{RET}} | |
527 | for a forward search, or @kbd{M-s _ C-r @key{RET}} or a backward | |
528 | search. In nonincremental symbol searches, the beginning and end of | |
529 | the search string are required to match the beginning and end of a | |
530 | symbol, respectively. | |
531 | ||
8cf51b2c GM |
532 | @node Regexp Search |
533 | @section Regular Expression Search | |
116b6d38 EZ |
534 | @cindex regexp search |
535 | @cindex search for a regular expression | |
8cf51b2c | 536 | |
b5fb9df5 | 537 | A @dfn{regular expression} (or @dfn{regexp} for short) is a pattern |
e2058813 | 538 | that denotes a class of alternative strings to match. Emacs |
b5fb9df5 CY |
539 | provides both incremental and nonincremental ways to search for a |
540 | match for a regexp. The syntax of regular expressions is explained in | |
5abc31ef | 541 | the next section. |
8cf51b2c | 542 | |
97b3a00b JL |
543 | @table @kbd |
544 | @item C-M-s | |
545 | Begin incremental regexp search (@code{isearch-forward-regexp}). | |
546 | @item C-M-r | |
547 | Begin reverse incremental regexp search (@code{isearch-backward-regexp}). | |
548 | @end table | |
549 | ||
8cf51b2c GM |
550 | @kindex C-M-s |
551 | @findex isearch-forward-regexp | |
552 | @kindex C-M-r | |
553 | @findex isearch-backward-regexp | |
554 | Incremental search for a regexp is done by typing @kbd{C-M-s} | |
555 | (@code{isearch-forward-regexp}), by invoking @kbd{C-s} with a | |
556 | prefix argument (whose value does not matter), or by typing @kbd{M-r} | |
557 | within a forward incremental search. This command reads a | |
558 | search string incrementally just like @kbd{C-s}, but it treats the | |
559 | search string as a regexp rather than looking for an exact match | |
560 | against the text in the buffer. Each time you add text to the search | |
561 | string, you make the regexp longer, and the new regexp is searched | |
562 | for. To search backward for a regexp, use @kbd{C-M-r} | |
563 | (@code{isearch-backward-regexp}), @kbd{C-r} with a prefix argument, | |
564 | or @kbd{M-r} within a backward incremental search. | |
565 | ||
b5fb9df5 CY |
566 | All of the special key sequences in an ordinary incremental search |
567 | do similar things in an incremental regexp search. For instance, | |
568 | typing @kbd{C-s} immediately after starting the search retrieves the | |
569 | last incremental search regexp used and searches forward for it. | |
570 | Incremental regexp and non-regexp searches have independent defaults. | |
571 | They also have separate search rings, which you can access with | |
8cf51b2c GM |
572 | @kbd{M-p} and @kbd{M-n}. |
573 | ||
48de8b12 CY |
574 | Just as in ordinary incremental search, any @key{SPC} typed in |
575 | incremental regexp search matches any sequence of one or more | |
576 | whitespace characters. The variable @code{search-whitespace-regexp} | |
577 | specifies the regexp for the lax space matching, and @kbd{M-s SPC} | |
578 | (@code{isearch-toggle-lax-whitespace}) toggles the feature. | |
579 | @xref{Special Isearch}. | |
8cf51b2c | 580 | |
b5fb9df5 CY |
581 | In some cases, adding characters to the regexp in an incremental |
582 | regexp search can make the cursor move back and start again. For | |
583 | example, if you have searched for @samp{foo} and you add @samp{\|bar}, | |
584 | the cursor backs up in case the first @samp{bar} precedes the first | |
585 | @samp{foo}. @xref{Regexps}. | |
8cf51b2c GM |
586 | |
587 | Forward and backward regexp search are not symmetrical, because | |
588 | regexp matching in Emacs always operates forward, starting with the | |
589 | beginning of the regexp. Thus, forward regexp search scans forward, | |
590 | trying a forward match at each possible starting position. Backward | |
591 | regexp search scans backward, trying a forward match at each possible | |
592 | starting position. These search methods are not mirror images. | |
593 | ||
594 | @findex re-search-forward | |
595 | @findex re-search-backward | |
5abc31ef | 596 | Nonincremental search for a regexp is done with the commands |
b5fb9df5 CY |
597 | @code{re-search-forward} and @code{re-search-backward}. You can |
598 | invoke these with @kbd{M-x}, or by way of incremental regexp search | |
599 | with @kbd{C-M-s @key{RET}} and @kbd{C-M-r @key{RET}}. | |
8cf51b2c GM |
600 | |
601 | If you use the incremental regexp search commands with a prefix | |
602 | argument, they perform ordinary string search, like | |
603 | @code{isearch-forward} and @code{isearch-backward}. @xref{Incremental | |
604 | Search}. | |
605 | ||
606 | @node Regexps | |
607 | @section Syntax of Regular Expressions | |
608 | @cindex syntax of regexps | |
116b6d38 EZ |
609 | @cindex regular expression |
610 | @cindex regexp | |
8cf51b2c GM |
611 | |
612 | This manual describes regular expression features that users | |
65401ee3 CY |
613 | typically use. @xref{Regular Expressions,,, elisp, The Emacs Lisp |
614 | Reference Manual}, for additional features used mainly in Lisp | |
615 | programs. | |
8cf51b2c GM |
616 | |
617 | Regular expressions have a syntax in which a few characters are | |
618 | special constructs and the rest are @dfn{ordinary}. An ordinary | |
65401ee3 CY |
619 | character matches that same character and nothing else. The special |
620 | characters are @samp{$^.*+?[\}. The character @samp{]} is special if | |
621 | it ends a character alternative (see later). The character @samp{-} | |
622 | is special inside a character alternative. Any other character | |
623 | appearing in a regular expression is ordinary, unless a @samp{\} | |
624 | precedes it. (When you use regular expressions in a Lisp program, | |
625 | each @samp{\} must be doubled, see the example near the end of this | |
626 | section.) | |
8cf51b2c GM |
627 | |
628 | For example, @samp{f} is not a special character, so it is ordinary, and | |
629 | therefore @samp{f} is a regular expression that matches the string | |
630 | @samp{f} and no other string. (It does @emph{not} match the string | |
631 | @samp{ff}.) Likewise, @samp{o} is a regular expression that matches | |
632 | only @samp{o}. (When case distinctions are being ignored, these regexps | |
633 | also match @samp{F} and @samp{O}, but we consider this a generalization | |
16152b76 | 634 | of ``the same string'', rather than an exception.) |
8cf51b2c | 635 | |
65401ee3 CY |
636 | Any two regular expressions @var{a} and @var{b} can be concatenated. |
637 | The result is a regular expression which matches a string if @var{a} | |
638 | matches some amount of the beginning of that string and @var{b} | |
639 | matches the rest of the string. For example, concatenating the | |
640 | regular expressions @samp{f} and @samp{o} gives the regular expression | |
641 | @samp{fo}, which matches only the string @samp{fo}. Still trivial. | |
642 | To do something nontrivial, you need to use one of the special | |
643 | characters. Here is a list of them. | |
8cf51b2c GM |
644 | |
645 | @table @asis | |
646 | @item @kbd{.}@: @r{(Period)} | |
65401ee3 CY |
647 | is a special character that matches any single character except a |
648 | newline. For example, the regular expressions @samp{a.b} matches any | |
649 | three-character string that begins with @samp{a} and ends with | |
650 | @samp{b}. | |
8cf51b2c GM |
651 | |
652 | @item @kbd{*} | |
653 | is not a construct by itself; it is a postfix operator that means to | |
65401ee3 CY |
654 | match the preceding regular expression repetitively any number of |
655 | times, as many times as possible. Thus, @samp{o*} matches any number | |
656 | of @samp{o}s, including no @samp{o}s. | |
8cf51b2c GM |
657 | |
658 | @samp{*} always applies to the @emph{smallest} possible preceding | |
659 | expression. Thus, @samp{fo*} has a repeating @samp{o}, not a repeating | |
660 | @samp{fo}. It matches @samp{f}, @samp{fo}, @samp{foo}, and so on. | |
661 | ||
662 | The matcher processes a @samp{*} construct by matching, immediately, | |
663 | as many repetitions as can be found. Then it continues with the rest | |
664 | of the pattern. If that fails, backtracking occurs, discarding some | |
665 | of the matches of the @samp{*}-modified construct in case that makes | |
666 | it possible to match the rest of the pattern. For example, in matching | |
667 | @samp{ca*ar} against the string @samp{caaar}, the @samp{a*} first | |
668 | tries to match all three @samp{a}s; but the rest of the pattern is | |
669 | @samp{ar} and there is only @samp{r} left to match, so this try fails. | |
670 | The next alternative is for @samp{a*} to match only two @samp{a}s. | |
671 | With this choice, the rest of the regexp matches successfully.@refill | |
672 | ||
673 | @item @kbd{+} | |
674 | is a postfix operator, similar to @samp{*} except that it must match | |
65401ee3 CY |
675 | the preceding expression at least once. Thus, @samp{ca+r} matches the |
676 | strings @samp{car} and @samp{caaaar} but not the string @samp{cr}, | |
677 | whereas @samp{ca*r} matches all three strings. | |
8cf51b2c GM |
678 | |
679 | @item @kbd{?} | |
65401ee3 CY |
680 | is a postfix operator, similar to @samp{*} except that it can match |
681 | the preceding expression either once or not at all. Thus, @samp{ca?r} | |
682 | matches @samp{car} or @samp{cr}, and nothing else. | |
8cf51b2c GM |
683 | |
684 | @item @kbd{*?}, @kbd{+?}, @kbd{??} | |
685 | @cindex non-greedy regexp matching | |
65401ee3 CY |
686 | are non-@dfn{greedy} variants of the operators above. The normal |
687 | operators @samp{*}, @samp{+}, @samp{?} match as much as they can, as | |
688 | long as the overall regexp can still match. With a following | |
689 | @samp{?}, they will match as little as possible. | |
8cf51b2c GM |
690 | |
691 | Thus, both @samp{ab*} and @samp{ab*?} can match the string @samp{a} | |
692 | and the string @samp{abbbb}; but if you try to match them both against | |
693 | the text @samp{abbb}, @samp{ab*} will match it all (the longest valid | |
694 | match), while @samp{ab*?} will match just @samp{a} (the shortest | |
695 | valid match). | |
696 | ||
697 | Non-greedy operators match the shortest possible string starting at a | |
698 | given starting point; in a forward search, though, the earliest | |
699 | possible starting point for match is always the one chosen. Thus, if | |
700 | you search for @samp{a.*?$} against the text @samp{abbab} followed by | |
701 | a newline, it matches the whole string. Since it @emph{can} match | |
702 | starting at the first @samp{a}, it does. | |
703 | ||
704 | @item @kbd{\@{@var{n}\@}} | |
65401ee3 CY |
705 | is a postfix operator specifying @var{n} repetitions---that is, the |
706 | preceding regular expression must match exactly @var{n} times in a | |
707 | row. For example, @samp{x\@{4\@}} matches the string @samp{xxxx} and | |
708 | nothing else. | |
8cf51b2c GM |
709 | |
710 | @item @kbd{\@{@var{n},@var{m}\@}} | |
65401ee3 CY |
711 | is a postfix operator specifying between @var{n} and @var{m} |
712 | repetitions---that is, the preceding regular expression must match at | |
713 | least @var{n} times, but no more than @var{m} times. If @var{m} is | |
8cf51b2c GM |
714 | omitted, then there is no upper limit, but the preceding regular |
715 | expression must match at least @var{n} times.@* @samp{\@{0,1\@}} is | |
716 | equivalent to @samp{?}. @* @samp{\@{0,\@}} is equivalent to | |
717 | @samp{*}. @* @samp{\@{1,\@}} is equivalent to @samp{+}. | |
718 | ||
719 | @item @kbd{[ @dots{} ]} | |
65401ee3 CY |
720 | is a @dfn{character set}, beginning with @samp{[} and terminated by |
721 | @samp{]}. | |
8cf51b2c | 722 | |
65401ee3 CY |
723 | In the simplest case, the characters between the two brackets are what |
724 | this set can match. Thus, @samp{[ad]} matches either one @samp{a} or | |
725 | one @samp{d}, and @samp{[ad]*} matches any string composed of just | |
726 | @samp{a}s and @samp{d}s (including the empty string). It follows that | |
727 | @samp{c[ad]*r} matches @samp{cr}, @samp{car}, @samp{cdr}, | |
728 | @samp{caddaar}, etc. | |
8cf51b2c GM |
729 | |
730 | You can also include character ranges in a character set, by writing the | |
731 | starting and ending characters with a @samp{-} between them. Thus, | |
732 | @samp{[a-z]} matches any lower-case @acronym{ASCII} letter. Ranges may be | |
733 | intermixed freely with individual characters, as in @samp{[a-z$%.]}, | |
734 | which matches any lower-case @acronym{ASCII} letter or @samp{$}, @samp{%} or | |
735 | period. | |
736 | ||
65401ee3 CY |
737 | You can also include certain special @dfn{character classes} in a |
738 | character set. A @samp{[:} and balancing @samp{:]} enclose a | |
739 | character class inside a character alternative. For instance, | |
740 | @samp{[[:alnum:]]} matches any letter or digit. @xref{Char Classes,,, | |
741 | elisp, The Emacs Lisp Reference Manual}, for a list of character | |
742 | classes. | |
8cf51b2c GM |
743 | |
744 | To include a @samp{]} in a character set, you must make it the first | |
745 | character. For example, @samp{[]a]} matches @samp{]} or @samp{a}. To | |
746 | include a @samp{-}, write @samp{-} as the first or last character of the | |
747 | set, or put it after a range. Thus, @samp{[]-]} matches both @samp{]} | |
748 | and @samp{-}. | |
749 | ||
750 | To include @samp{^} in a set, put it anywhere but at the beginning of | |
751 | the set. (At the beginning, it complements the set---see below.) | |
752 | ||
753 | When you use a range in case-insensitive search, you should write both | |
754 | ends of the range in upper case, or both in lower case, or both should | |
755 | be non-letters. The behavior of a mixed-case range such as @samp{A-z} | |
756 | is somewhat ill-defined, and it may change in future Emacs versions. | |
757 | ||
758 | @item @kbd{[^ @dots{} ]} | |
759 | @samp{[^} begins a @dfn{complemented character set}, which matches any | |
760 | character except the ones specified. Thus, @samp{[^a-z0-9A-Z]} matches | |
761 | all characters @emph{except} @acronym{ASCII} letters and digits. | |
762 | ||
763 | @samp{^} is not special in a character set unless it is the first | |
764 | character. The character following the @samp{^} is treated as if it | |
765 | were first (in other words, @samp{-} and @samp{]} are not special there). | |
766 | ||
767 | A complemented character set can match a newline, unless newline is | |
768 | mentioned as one of the characters not to match. This is in contrast to | |
769 | the handling of regexps in programs such as @code{grep}. | |
770 | ||
771 | @item @kbd{^} | |
772 | is a special character that matches the empty string, but only at the | |
773 | beginning of a line in the text being matched. Otherwise it fails to | |
774 | match anything. Thus, @samp{^foo} matches a @samp{foo} that occurs at | |
775 | the beginning of a line. | |
776 | ||
777 | For historical compatibility reasons, @samp{^} can be used with this | |
778 | meaning only at the beginning of the regular expression, or after | |
779 | @samp{\(} or @samp{\|}. | |
780 | ||
781 | @item @kbd{$} | |
782 | is similar to @samp{^} but matches only at the end of a line. Thus, | |
783 | @samp{x+$} matches a string of one @samp{x} or more at the end of a line. | |
784 | ||
785 | For historical compatibility reasons, @samp{$} can be used with this | |
786 | meaning only at the end of the regular expression, or before @samp{\)} | |
787 | or @samp{\|}. | |
788 | ||
789 | @item @kbd{\} | |
790 | has two functions: it quotes the special characters (including | |
791 | @samp{\}), and it introduces additional special constructs. | |
792 | ||
793 | Because @samp{\} quotes special characters, @samp{\$} is a regular | |
794 | expression that matches only @samp{$}, and @samp{\[} is a regular | |
795 | expression that matches only @samp{[}, and so on. | |
796 | ||
797 | See the following section for the special constructs that begin | |
798 | with @samp{\}. | |
799 | @end table | |
800 | ||
801 | Note: for historical compatibility, special characters are treated as | |
802 | ordinary ones if they are in contexts where their special meanings make no | |
803 | sense. For example, @samp{*foo} treats @samp{*} as ordinary since there is | |
804 | no preceding expression on which the @samp{*} can act. It is poor practice | |
805 | to depend on this behavior; it is better to quote the special character anyway, | |
806 | regardless of where it appears. | |
807 | ||
808 | As a @samp{\} is not special inside a character alternative, it can | |
809 | never remove the special meaning of @samp{-} or @samp{]}. So you | |
810 | should not quote these characters when they have no special meaning | |
811 | either. This would not clarify anything, since backslashes can | |
812 | legitimately precede these characters where they @emph{have} special | |
813 | meaning, as in @samp{[^\]} (@code{"[^\\]"} for Lisp string syntax), | |
814 | which matches any single character except a backslash. | |
815 | ||
816 | @node Regexp Backslash | |
817 | @section Backslash in Regular Expressions | |
818 | ||
819 | For the most part, @samp{\} followed by any character matches only | |
820 | that character. However, there are several exceptions: two-character | |
821 | sequences starting with @samp{\} that have special meanings. The | |
822 | second character in the sequence is always an ordinary character when | |
823 | used on its own. Here is a table of @samp{\} constructs. | |
824 | ||
825 | @table @kbd | |
826 | @item \| | |
827 | specifies an alternative. Two regular expressions @var{a} and @var{b} | |
828 | with @samp{\|} in between form an expression that matches some text if | |
829 | either @var{a} matches it or @var{b} matches it. It works by trying to | |
830 | match @var{a}, and if that fails, by trying to match @var{b}. | |
831 | ||
832 | Thus, @samp{foo\|bar} matches either @samp{foo} or @samp{bar} | |
833 | but no other string.@refill | |
834 | ||
835 | @samp{\|} applies to the largest possible surrounding expressions. Only a | |
836 | surrounding @samp{\( @dots{} \)} grouping can limit the grouping power of | |
837 | @samp{\|}.@refill | |
838 | ||
839 | Full backtracking capability exists to handle multiple uses of @samp{\|}. | |
840 | ||
841 | @item \( @dots{} \) | |
842 | is a grouping construct that serves three purposes: | |
843 | ||
844 | @enumerate | |
845 | @item | |
846 | To enclose a set of @samp{\|} alternatives for other operations. | |
847 | Thus, @samp{\(foo\|bar\)x} matches either @samp{foox} or @samp{barx}. | |
848 | ||
849 | @item | |
850 | To enclose a complicated expression for the postfix operators @samp{*}, | |
851 | @samp{+} and @samp{?} to operate on. Thus, @samp{ba\(na\)*} matches | |
852 | @samp{bananana}, etc., with any (zero or more) number of @samp{na} | |
853 | strings.@refill | |
854 | ||
855 | @item | |
856 | To record a matched substring for future reference. | |
857 | @end enumerate | |
858 | ||
859 | This last application is not a consequence of the idea of a | |
860 | parenthetical grouping; it is a separate feature that is assigned as a | |
861 | second meaning to the same @samp{\( @dots{} \)} construct. In practice | |
862 | there is usually no conflict between the two meanings; when there is | |
863 | a conflict, you can use a ``shy'' group. | |
864 | ||
865 | @item \(?: @dots{} \) | |
866 | @cindex shy group, in regexp | |
867 | specifies a ``shy'' group that does not record the matched substring; | |
868 | you can't refer back to it with @samp{\@var{d}}. This is useful | |
869 | in mechanically combining regular expressions, so that you | |
870 | can add groups for syntactic purposes without interfering with | |
871 | the numbering of the groups that are meant to be referred to. | |
872 | ||
873 | @item \@var{d} | |
874 | @cindex back reference, in regexp | |
875 | matches the same text that matched the @var{d}th occurrence of a | |
876 | @samp{\( @dots{} \)} construct. This is called a @dfn{back | |
877 | reference}. | |
878 | ||
879 | After the end of a @samp{\( @dots{} \)} construct, the matcher remembers | |
880 | the beginning and end of the text matched by that construct. Then, | |
881 | later on in the regular expression, you can use @samp{\} followed by the | |
882 | digit @var{d} to mean ``match the same text matched the @var{d}th time | |
16152b76 | 883 | by the @samp{\( @dots{} \)} construct''. |
8cf51b2c GM |
884 | |
885 | The strings matching the first nine @samp{\( @dots{} \)} constructs | |
886 | appearing in a regular expression are assigned numbers 1 through 9 in | |
887 | the order that the open-parentheses appear in the regular expression. | |
888 | So you can use @samp{\1} through @samp{\9} to refer to the text matched | |
889 | by the corresponding @samp{\( @dots{} \)} constructs. | |
890 | ||
891 | For example, @samp{\(.*\)\1} matches any newline-free string that is | |
892 | composed of two identical halves. The @samp{\(.*\)} matches the first | |
893 | half, which may be anything, but the @samp{\1} that follows must match | |
894 | the same exact text. | |
895 | ||
896 | If a particular @samp{\( @dots{} \)} construct matches more than once | |
897 | (which can easily happen if it is followed by @samp{*}), only the last | |
898 | match is recorded. | |
899 | ||
900 | @item \` | |
901 | matches the empty string, but only at the beginning of the string or | |
902 | buffer (or its accessible portion) being matched against. | |
903 | ||
904 | @item \' | |
905 | matches the empty string, but only at the end of the string or buffer | |
906 | (or its accessible portion) being matched against. | |
907 | ||
908 | @item \= | |
909 | matches the empty string, but only at point. | |
910 | ||
911 | @item \b | |
912 | matches the empty string, but only at the beginning or | |
913 | end of a word. Thus, @samp{\bfoo\b} matches any occurrence of | |
914 | @samp{foo} as a separate word. @samp{\bballs?\b} matches | |
915 | @samp{ball} or @samp{balls} as a separate word.@refill | |
916 | ||
917 | @samp{\b} matches at the beginning or end of the buffer | |
918 | regardless of what text appears next to it. | |
919 | ||
920 | @item \B | |
921 | matches the empty string, but @emph{not} at the beginning or | |
922 | end of a word. | |
923 | ||
924 | @item \< | |
925 | matches the empty string, but only at the beginning of a word. | |
926 | @samp{\<} matches at the beginning of the buffer only if a | |
927 | word-constituent character follows. | |
928 | ||
929 | @item \> | |
930 | matches the empty string, but only at the end of a word. @samp{\>} | |
931 | matches at the end of the buffer only if the contents end with a | |
932 | word-constituent character. | |
933 | ||
934 | @item \w | |
6cfd0fa2 CY |
935 | matches any word-constituent character. The syntax table determines |
936 | which characters these are. @xref{Syntax Tables,, Syntax Tables, | |
937 | elisp, The Emacs Lisp Reference Manual}. | |
8cf51b2c GM |
938 | |
939 | @item \W | |
940 | matches any character that is not a word-constituent. | |
941 | ||
942 | @item \_< | |
943 | matches the empty string, but only at the beginning of a symbol. | |
944 | A symbol is a sequence of one or more symbol-constituent characters. | |
945 | A symbol-constituent character is a character whose syntax is either | |
946 | @samp{w} or @samp{_}. @samp{\_<} matches at the beginning of the | |
947 | buffer only if a symbol-constituent character follows. | |
948 | ||
949 | @item \_> | |
950 | matches the empty string, but only at the end of a symbol. @samp{\_>} | |
951 | matches at the end of the buffer only if the contents end with a | |
952 | symbol-constituent character. | |
953 | ||
954 | @item \s@var{c} | |
955 | matches any character whose syntax is @var{c}. Here @var{c} is a | |
956 | character that designates a particular syntax class: thus, @samp{w} | |
957 | for word constituent, @samp{-} or @samp{ } for whitespace, @samp{.} | |
6cfd0fa2 CY |
958 | for ordinary punctuation, etc. @xref{Syntax Tables,, Syntax Tables, |
959 | elisp, The Emacs Lisp Reference Manual}. | |
8cf51b2c GM |
960 | |
961 | @item \S@var{c} | |
962 | matches any character whose syntax is not @var{c}. | |
963 | ||
964 | @cindex categories of characters | |
965 | @cindex characters which belong to a specific language | |
966 | @findex describe-categories | |
967 | @item \c@var{c} | |
968 | matches any character that belongs to the category @var{c}. For | |
969 | example, @samp{\cc} matches Chinese characters, @samp{\cg} matches | |
970 | Greek characters, etc. For the description of the known categories, | |
971 | type @kbd{M-x describe-categories @key{RET}}. | |
972 | ||
973 | @item \C@var{c} | |
974 | matches any character that does @emph{not} belong to category | |
975 | @var{c}. | |
976 | @end table | |
977 | ||
6cfd0fa2 CY |
978 | The constructs that pertain to words and syntax are controlled by |
979 | the setting of the syntax table. @xref{Syntax Tables,, Syntax Tables, | |
980 | elisp, The Emacs Lisp Reference Manual}. | |
8cf51b2c GM |
981 | |
982 | @node Regexp Example | |
983 | @section Regular Expression Example | |
984 | ||
62d94509 EZ |
985 | Here is an example of a regexp---similar to the regexp that Emacs |
986 | uses, by default, to recognize the end of a sentence, not including | |
987 | the following space (i.e., the variable @code{sentence-end-base}): | |
8cf51b2c GM |
988 | |
989 | @example | |
b5fb9df5 | 990 | @verbatim |
62d94509 | 991 | [.?!][]\"')}]* |
b5fb9df5 | 992 | @end verbatim |
8cf51b2c GM |
993 | @end example |
994 | ||
995 | @noindent | |
b5fb9df5 CY |
996 | This contains two parts in succession: a character set matching |
997 | period, @samp{?}, or @samp{!}, and a character set matching | |
998 | close-brackets, quotes, or parentheses, repeated zero or more times. | |
8cf51b2c GM |
999 | |
1000 | @node Search Case | |
1001 | @section Searching and Case | |
1002 | ||
b5fb9df5 CY |
1003 | Searches in Emacs normally ignore the case of the text they are |
1004 | searching through, if you specify the text in lower case. Thus, if | |
1005 | you specify searching for @samp{foo}, then @samp{Foo} and @samp{foo} | |
5abc31ef CY |
1006 | also match. Regexps, and in particular character sets, behave |
1007 | likewise: @samp{[ab]} matches @samp{a} or @samp{A} or @samp{b} or | |
1008 | @samp{B}.@refill | |
8cf51b2c GM |
1009 | |
1010 | An upper-case letter anywhere in the incremental search string makes | |
1011 | the search case-sensitive. Thus, searching for @samp{Foo} does not find | |
1012 | @samp{foo} or @samp{FOO}. This applies to regular expression search as | |
1013 | well as to string search. The effect ceases if you delete the | |
1014 | upper-case letter from the search string. | |
1015 | ||
1016 | Typing @kbd{M-c} within an incremental search toggles the case | |
1017 | sensitivity of that search. The effect does not extend beyond the | |
1018 | current incremental search to the next one, but it does override the | |
b5fb9df5 CY |
1019 | effect of adding or removing an upper-case letter in the current |
1020 | search. | |
8cf51b2c GM |
1021 | |
1022 | @vindex case-fold-search | |
8cf51b2c GM |
1023 | If you set the variable @code{case-fold-search} to @code{nil}, then |
1024 | all letters must match exactly, including case. This is a per-buffer | |
4e3b4528 SM |
1025 | variable; altering the variable normally affects only the current buffer, |
1026 | unless you change its default value. @xref{Locals}. | |
1027 | This variable applies to nonincremental searches also, including those | |
1028 | performed by the replace commands (@pxref{Replace}) and the minibuffer | |
1029 | history matching commands (@pxref{Minibuffer History}). | |
8cf51b2c GM |
1030 | |
1031 | Several related variables control case-sensitivity of searching and | |
1032 | matching for specific commands or activities. For instance, | |
1033 | @code{tags-case-fold-search} controls case sensitivity for | |
1034 | @code{find-tag}. To find these variables, do @kbd{M-x | |
1035 | apropos-variable @key{RET} case-fold-search @key{RET}}. | |
1036 | ||
1037 | @node Replace | |
1038 | @section Replacement Commands | |
1039 | @cindex replacement | |
1040 | @cindex search-and-replace commands | |
1041 | @cindex string substitution | |
1042 | @cindex global substitution | |
1043 | ||
b5fb9df5 CY |
1044 | Emacs provides several commands for performing search-and-replace |
1045 | operations. In addition to the simple @kbd{M-x replace-string} | |
1046 | command, there is @kbd{M-%} (@code{query-replace}), which presents | |
1047 | each occurrence of the pattern and asks you whether to replace it. | |
8cf51b2c GM |
1048 | |
1049 | The replace commands normally operate on the text from point to the | |
5abc31ef CY |
1050 | end of the buffer. When the region is active, they operate on it |
1051 | instead (@pxref{Mark}). The basic replace commands replace one | |
b5fb9df5 CY |
1052 | @dfn{search string} (or regexp) with one @dfn{replacement string}. It |
1053 | is possible to perform several replacements in parallel, using the | |
1054 | command @code{expand-region-abbrevs} (@pxref{Expanding Abbrevs}). | |
8cf51b2c | 1055 | |
48de8b12 CY |
1056 | @vindex replace-lax-whitespace |
1057 | Unlike incremental search, the replacement commands do not use lax | |
1058 | space matching (@pxref{Special Isearch}) by default. To enable lax | |
1059 | space matching for replacement, change the variable | |
1060 | @code{replace-lax-whitespace} to @code{t}. (This only affects how | |
1061 | Emacs finds the text to replace, not the replacement text.) | |
1062 | ||
8cf51b2c | 1063 | @menu |
8838673e GM |
1064 | * Unconditional Replace:: Replacing all matches for a string. |
1065 | * Regexp Replace:: Replacing all matches for a regexp. | |
1066 | * Replacement and Case:: How replacements preserve case of letters. | |
1067 | * Query Replace:: How to use querying. | |
8cf51b2c GM |
1068 | @end menu |
1069 | ||
abb9615e | 1070 | @node Unconditional Replace |
8cf51b2c GM |
1071 | @subsection Unconditional Replacement |
1072 | @findex replace-string | |
1073 | ||
1074 | @table @kbd | |
1075 | @item M-x replace-string @key{RET} @var{string} @key{RET} @var{newstring} @key{RET} | |
1076 | Replace every occurrence of @var{string} with @var{newstring}. | |
1077 | @end table | |
1078 | ||
1079 | To replace every instance of @samp{foo} after point with @samp{bar}, | |
1080 | use the command @kbd{M-x replace-string} with the two arguments | |
1081 | @samp{foo} and @samp{bar}. Replacement happens only in the text after | |
1082 | point, so if you want to cover the whole buffer you must go to the | |
1083 | beginning first. All occurrences up to the end of the buffer are | |
b5fb9df5 CY |
1084 | replaced; to limit replacement to part of the buffer, activate the |
1085 | region around that part. When the region is active, replacement is | |
1086 | limited to the region (@pxref{Mark}). | |
8cf51b2c GM |
1087 | |
1088 | When @code{replace-string} exits, it leaves point at the last | |
6184c708 CY |
1089 | occurrence replaced. It adds the prior position of point (where the |
1090 | @code{replace-string} command was issued) to the mark ring, without | |
1091 | activating the mark; use @kbd{C-u C-@key{SPC}} to move back there. | |
1092 | @xref{Mark Ring}. | |
8cf51b2c | 1093 | |
b5fb9df5 | 1094 | A prefix argument restricts replacement to matches that are |
5abc31ef | 1095 | surrounded by word boundaries. |
8cf51b2c GM |
1096 | |
1097 | @xref{Replacement and Case}, for details about case-sensitivity in | |
1098 | replace commands. | |
1099 | ||
abb9615e | 1100 | @node Regexp Replace |
8cf51b2c GM |
1101 | @subsection Regexp Replacement |
1102 | @findex replace-regexp | |
1103 | ||
1104 | The @kbd{M-x replace-string} command replaces exact matches for a | |
1105 | single string. The similar command @kbd{M-x replace-regexp} replaces | |
1106 | any match for a specified pattern. | |
1107 | ||
1108 | @table @kbd | |
1109 | @item M-x replace-regexp @key{RET} @var{regexp} @key{RET} @var{newstring} @key{RET} | |
1110 | Replace every match for @var{regexp} with @var{newstring}. | |
1111 | @end table | |
1112 | ||
1113 | @cindex back reference, in regexp replacement | |
1114 | In @code{replace-regexp}, the @var{newstring} need not be constant: | |
1115 | it can refer to all or part of what is matched by the @var{regexp}. | |
1116 | @samp{\&} in @var{newstring} stands for the entire match being | |
1117 | replaced. @samp{\@var{d}} in @var{newstring}, where @var{d} is a | |
1118 | digit, stands for whatever matched the @var{d}th parenthesized | |
16152b76 | 1119 | grouping in @var{regexp}. (This is called a ``back reference''.) |
8cf51b2c GM |
1120 | @samp{\#} refers to the count of replacements already made in this |
1121 | command, as a decimal number. In the first replacement, @samp{\#} | |
1122 | stands for @samp{0}; in the second, for @samp{1}; and so on. For | |
1123 | example, | |
1124 | ||
1125 | @example | |
1126 | M-x replace-regexp @key{RET} c[ad]+r @key{RET} \&-safe @key{RET} | |
1127 | @end example | |
1128 | ||
1129 | @noindent | |
1130 | replaces (for example) @samp{cadr} with @samp{cadr-safe} and @samp{cddr} | |
1131 | with @samp{cddr-safe}. | |
1132 | ||
1133 | @example | |
1134 | M-x replace-regexp @key{RET} \(c[ad]+r\)-safe @key{RET} \1 @key{RET} | |
1135 | @end example | |
1136 | ||
1137 | @noindent | |
1138 | performs the inverse transformation. To include a @samp{\} in the | |
1139 | text to replace with, you must enter @samp{\\}. | |
1140 | ||
1141 | If you want to enter part of the replacement string by hand each | |
1142 | time, use @samp{\?} in the replacement string. Each replacement will | |
1143 | ask you to edit the replacement string in the minibuffer, putting | |
1144 | point where the @samp{\?} was. | |
1145 | ||
1146 | The remainder of this subsection is intended for specialized tasks | |
1147 | and requires knowledge of Lisp. Most readers can skip it. | |
1148 | ||
1149 | You can use Lisp expressions to calculate parts of the | |
1150 | replacement string. To do this, write @samp{\,} followed by the | |
1151 | expression in the replacement string. Each replacement calculates the | |
1152 | value of the expression and converts it to text without quoting (if | |
1153 | it's a string, this means using the string's contents), and uses it in | |
1154 | the replacement string in place of the expression itself. If the | |
1155 | expression is a symbol, one space in the replacement string after the | |
1156 | symbol name goes with the symbol name, so the value replaces them | |
1157 | both. | |
1158 | ||
1159 | Inside such an expression, you can use some special sequences. | |
1160 | @samp{\&} and @samp{\@var{n}} refer here, as usual, to the entire | |
1161 | match as a string, and to a submatch as a string. @var{n} may be | |
1162 | multiple digits, and the value of @samp{\@var{n}} is @code{nil} if | |
1163 | subexpression @var{n} did not match. You can also use @samp{\#&} and | |
1164 | @samp{\#@var{n}} to refer to those matches as numbers (this is valid | |
1165 | when the match or submatch has the form of a numeral). @samp{\#} here | |
1166 | too stands for the number of already-completed replacements. | |
1167 | ||
1168 | Repeating our example to exchange @samp{x} and @samp{y}, we can thus | |
1169 | do it also this way: | |
1170 | ||
1171 | @example | |
1172 | M-x replace-regexp @key{RET} \(x\)\|y @key{RET} | |
1173 | \,(if \1 "y" "x") @key{RET} | |
1174 | @end example | |
1175 | ||
1176 | For computing replacement strings for @samp{\,}, the @code{format} | |
1177 | function is often useful (@pxref{Formatting Strings,,, elisp, The Emacs | |
1178 | Lisp Reference Manual}). For example, to add consecutively numbered | |
1179 | strings like @samp{ABC00042} to columns 73 @w{to 80} (unless they are | |
1180 | already occupied), you can use | |
1181 | ||
1182 | @example | |
1183 | M-x replace-regexp @key{RET} ^.\@{0,72\@}$ @key{RET} | |
1184 | \,(format "%-72sABC%05d" \& \#) @key{RET} | |
1185 | @end example | |
1186 | ||
abb9615e | 1187 | @node Replacement and Case |
8cf51b2c GM |
1188 | @subsection Replace Commands and Case |
1189 | ||
1190 | If the first argument of a replace command is all lower case, the | |
1191 | command ignores case while searching for occurrences to | |
1192 | replace---provided @code{case-fold-search} is non-@code{nil}. If | |
1193 | @code{case-fold-search} is set to @code{nil}, case is always significant | |
1194 | in all searches. | |
1195 | ||
1196 | @vindex case-replace | |
1197 | In addition, when the @var{newstring} argument is all or partly lower | |
1198 | case, replacement commands try to preserve the case pattern of each | |
1199 | occurrence. Thus, the command | |
1200 | ||
1201 | @example | |
1202 | M-x replace-string @key{RET} foo @key{RET} bar @key{RET} | |
1203 | @end example | |
1204 | ||
1205 | @noindent | |
1206 | replaces a lower case @samp{foo} with a lower case @samp{bar}, an | |
1207 | all-caps @samp{FOO} with @samp{BAR}, and a capitalized @samp{Foo} with | |
1208 | @samp{Bar}. (These three alternatives---lower case, all caps, and | |
1209 | capitalized, are the only ones that @code{replace-string} can | |
1210 | distinguish.) | |
1211 | ||
1212 | If upper-case letters are used in the replacement string, they remain | |
1213 | upper case every time that text is inserted. If upper-case letters are | |
1214 | used in the first argument, the second argument is always substituted | |
1215 | exactly as given, with no case conversion. Likewise, if either | |
1216 | @code{case-replace} or @code{case-fold-search} is set to @code{nil}, | |
1217 | replacement is done without case conversion. | |
1218 | ||
abb9615e | 1219 | @node Query Replace |
8cf51b2c GM |
1220 | @subsection Query Replace |
1221 | @cindex query replace | |
1222 | ||
1223 | @table @kbd | |
1224 | @item M-% @var{string} @key{RET} @var{newstring} @key{RET} | |
8cf51b2c GM |
1225 | Replace some occurrences of @var{string} with @var{newstring}. |
1226 | @item C-M-% @var{regexp} @key{RET} @var{newstring} @key{RET} | |
8cf51b2c GM |
1227 | Replace some matches for @var{regexp} with @var{newstring}. |
1228 | @end table | |
1229 | ||
1230 | @kindex M-% | |
1231 | @findex query-replace | |
1232 | If you want to change only some of the occurrences of @samp{foo} to | |
abfd0191 | 1233 | @samp{bar}, not all of them, use @kbd{M-%} (@code{query-replace}). |
8cf51b2c GM |
1234 | This command finds occurrences of @samp{foo} one by one, displays each |
1235 | occurrence and asks you whether to replace it. Aside from querying, | |
abfd0191 RS |
1236 | @code{query-replace} works just like @code{replace-string} |
1237 | (@pxref{Unconditional Replace}). In particular, it preserves case | |
1238 | provided @code{case-replace} is non-@code{nil}, as it normally is | |
5abc31ef | 1239 | (@pxref{Replacement and Case}). A numeric argument means to consider |
8cf51b2c GM |
1240 | only occurrences that are bounded by word-delimiter characters. |
1241 | ||
1242 | @kindex C-M-% | |
1243 | @findex query-replace-regexp | |
1244 | @kbd{C-M-%} performs regexp search and replace (@code{query-replace-regexp}). | |
1245 | It works like @code{replace-regexp} except that it queries | |
1246 | like @code{query-replace}. | |
1247 | ||
1248 | @cindex faces for highlighting query replace | |
1249 | These commands highlight the current match using the face | |
1250 | @code{query-replace}. They highlight other matches using | |
1251 | @code{lazy-highlight} just like incremental search (@pxref{Incremental | |
5abc31ef | 1252 | Search}). By default, @code{query-replace-regexp} will show the |
21d50ba1 JL |
1253 | substituted replacement string for the current match in the |
1254 | minibuffer. If you want to keep special sequences @samp{\&} and | |
1255 | @samp{\@var{n}} unexpanded, customize | |
1256 | @code{query-replace-show-replacement} variable. | |
8cf51b2c GM |
1257 | |
1258 | The characters you can type when you are shown a match for the string | |
1259 | or regexp are: | |
1260 | ||
1261 | @ignore @c Not worth it. | |
1262 | @kindex SPC @r{(query-replace)} | |
1263 | @kindex DEL @r{(query-replace)} | |
1264 | @kindex , @r{(query-replace)} | |
1265 | @kindex RET @r{(query-replace)} | |
1266 | @kindex . @r{(query-replace)} | |
1267 | @kindex ! @r{(query-replace)} | |
1268 | @kindex ^ @r{(query-replace)} | |
1269 | @kindex C-r @r{(query-replace)} | |
1270 | @kindex C-w @r{(query-replace)} | |
1271 | @kindex C-l @r{(query-replace)} | |
1272 | @end ignore | |
1273 | ||
1274 | @c WideCommands | |
1275 | @table @kbd | |
1276 | @item @key{SPC} | |
1277 | to replace the occurrence with @var{newstring}. | |
1278 | ||
1279 | @item @key{DEL} | |
1280 | to skip to the next occurrence without replacing this one. | |
1281 | ||
1282 | @item , @r{(Comma)} | |
1283 | to replace this occurrence and display the result. You are then asked | |
1284 | for another input character to say what to do next. Since the | |
1285 | replacement has already been made, @key{DEL} and @key{SPC} are | |
1286 | equivalent in this situation; both move to the next occurrence. | |
1287 | ||
1288 | You can type @kbd{C-r} at this point (see below) to alter the replaced | |
1289 | text. You can also type @kbd{C-x u} to undo the replacement; this exits | |
1290 | the @code{query-replace}, so if you want to do further replacement you | |
1291 | must use @kbd{C-x @key{ESC} @key{ESC} @key{RET}} to restart | |
1292 | (@pxref{Repetition}). | |
1293 | ||
1294 | @item @key{RET} | |
1295 | to exit without doing any more replacements. | |
1296 | ||
1297 | @item .@: @r{(Period)} | |
1298 | to replace this occurrence and then exit without searching for more | |
1299 | occurrences. | |
1300 | ||
1301 | @item ! | |
1302 | to replace all remaining occurrences without asking again. | |
1303 | ||
e5a94ec4 JL |
1304 | @item Y @r{(Upper-case)} |
1305 | to replace all remaining occurrences in all remaining buffers in | |
1306 | multi-buffer replacements (like the Dired `Q' command which performs | |
1307 | query replace on selected files). It answers this question and all | |
1308 | subsequent questions in the series with "yes", without further | |
1309 | user interaction. | |
1310 | ||
1311 | @item N @r{(Upper-case)} | |
1312 | to skip to the next buffer in multi-buffer replacements without | |
1313 | replacing remaining occurrences in the current buffer. It answers | |
1314 | this question "no", gives up on the questions for the current buffer, | |
1315 | and continues to the next buffer in the sequence. | |
1316 | ||
8cf51b2c GM |
1317 | @item ^ |
1318 | to go back to the position of the previous occurrence (or what used to | |
1319 | be an occurrence), in case you changed it by mistake or want to | |
1320 | reexamine it. | |
1321 | ||
1322 | @item C-r | |
1323 | to enter a recursive editing level, in case the occurrence needs to be | |
1324 | edited rather than just replaced with @var{newstring}. When you are | |
1325 | done, exit the recursive editing level with @kbd{C-M-c} to proceed to | |
1326 | the next occurrence. @xref{Recursive Edit}. | |
1327 | ||
1328 | @item C-w | |
1329 | to delete the occurrence, and then enter a recursive editing level as in | |
1330 | @kbd{C-r}. Use the recursive edit to insert text to replace the deleted | |
1331 | occurrence of @var{string}. When done, exit the recursive editing level | |
1332 | with @kbd{C-M-c} to proceed to the next occurrence. | |
1333 | ||
1334 | @item e | |
1335 | to edit the replacement string in the minibuffer. When you exit the | |
1336 | minibuffer by typing @key{RET}, the minibuffer contents replace the | |
1337 | current occurrence of the pattern. They also become the new | |
1338 | replacement string for any further occurrences. | |
1339 | ||
1340 | @item C-l | |
1341 | to redisplay the screen. Then you must type another character to | |
1342 | specify what to do with this occurrence. | |
1343 | ||
1344 | @item C-h | |
1345 | to display a message summarizing these options. Then you must type | |
1346 | another character to specify what to do with this occurrence. | |
1347 | @end table | |
1348 | ||
1349 | Some other characters are aliases for the ones listed above: @kbd{y}, | |
1350 | @kbd{n} and @kbd{q} are equivalent to @key{SPC}, @key{DEL} and | |
1351 | @key{RET}. | |
1352 | ||
1353 | Aside from this, any other character exits the @code{query-replace}, | |
1354 | and is then reread as part of a key sequence. Thus, if you type | |
1355 | @kbd{C-k}, it exits the @code{query-replace} and then kills to end of | |
1356 | line. | |
1357 | ||
1358 | To restart a @code{query-replace} once it is exited, use @kbd{C-x | |
1359 | @key{ESC} @key{ESC}}, which repeats the @code{query-replace} because it | |
1360 | used the minibuffer to read its arguments. @xref{Repetition, C-x ESC | |
1361 | ESC}. | |
1362 | ||
1363 | @xref{Operating on Files}, for the Dired @kbd{Q} command which | |
1364 | performs query replace on selected files. See also @ref{Transforming | |
1365 | File Names}, for Dired commands to rename, copy, or link files by | |
1366 | replacing regexp matches in file names. | |
1367 | ||
1368 | @node Other Repeating Search | |
1369 | @section Other Search-and-Loop Commands | |
1370 | ||
1371 | Here are some other commands that find matches for a regular | |
1372 | expression. They all ignore case in matching, if the pattern contains | |
1373 | no upper-case letters and @code{case-fold-search} is non-@code{nil}. | |
1374 | Aside from @code{occur} and its variants, all operate on the text from | |
6184c708 | 1375 | point to the end of the buffer, or on the region if it is active. |
8cf51b2c GM |
1376 | |
1377 | @findex list-matching-lines | |
1378 | @findex occur | |
1379 | @findex multi-occur | |
1380 | @findex multi-occur-in-matching-buffers | |
1381 | @findex how-many | |
8cf51b2c GM |
1382 | @findex flush-lines |
1383 | @findex keep-lines | |
1384 | ||
1385 | @table @kbd | |
15cf2f52 CY |
1386 | @item M-x multi-isearch-buffers |
1387 | Prompt for one or more buffer names, ending with @key{RET}; then, | |
1388 | begin a multi-buffer incremental search in those buffers. (If the | |
1389 | search fails in one buffer, the next @kbd{C-s} tries searching the | |
1390 | next specified buffer, and so forth.) With a prefix argument, prompt | |
1391 | for a regexp and begin a multi-buffer incremental search in buffers | |
1392 | matching that regexp. | |
1393 | ||
1394 | @item M-x multi-isearch-buffers-regexp | |
1395 | This command is just like @code{multi-isearch-buffers}, except it | |
1396 | performs an incremental regexp search. | |
1397 | ||
5abc31ef CY |
1398 | @cindex Occur mode |
1399 | @cindex mode, Occur | |
15cf2f52 CY |
1400 | @item M-x occur |
1401 | Prompt for a regexp, and display a list showing each line in the | |
1402 | buffer that contains a match for it. To limit the search to part of | |
1403 | the buffer, narrow to that part (@pxref{Narrowing}). A numeric | |
1404 | argument @var{n} specifies that @var{n} lines of context are to be | |
dc2d2590 | 1405 | displayed before and after each matching line. |
8cf51b2c GM |
1406 | |
1407 | @kindex RET @r{(Occur mode)} | |
1408 | @kindex o @r{(Occur mode)} | |
1409 | @kindex C-o @r{(Occur mode)} | |
1c64e6ed | 1410 | In the @file{*Occur*} buffer, you can click on each entry, or move |
5abc31ef CY |
1411 | point there and type @key{RET}, to visit the corresponding position in |
1412 | the buffer that was searched. @kbd{o} and @kbd{C-o} display the match | |
1413 | in another window; @kbd{C-o} does not select it. Alternatively, you | |
1414 | can use the @kbd{C-x `} (@code{next-error}) command to visit the | |
1415 | occurrences one by one (@pxref{Compilation Mode}). | |
1416 | ||
1417 | @cindex Occur Edit mode | |
1418 | @cindex mode, Occur Edit | |
1c64e6ed | 1419 | Typing @kbd{e} in the @file{*Occur*} buffer switches to Occur Edit |
5abc31ef CY |
1420 | mode, in which edits made to the entries are also applied to the text |
1421 | in the originating buffer. Type @kbd{C-c C-c} to return to Occur | |
1422 | mode. | |
1423 | ||
1424 | The command @kbd{M-x list-matching-lines} is a synonym for @kbd{M-x | |
1425 | occur}. | |
8cf51b2c | 1426 | |
b5fb9df5 CY |
1427 | @kindex M-s o |
1428 | @item M-s o | |
1429 | Run @code{occur} using the search string of the last incremental | |
97b3a00b | 1430 | string search. You can also run @kbd{M-s o} when an incremental |
b5fb9df5 CY |
1431 | search is active; this uses the current search string. |
1432 | ||
15cf2f52 CY |
1433 | @item M-x multi-occur |
1434 | This command is just like @code{occur}, except it is able to search | |
1435 | through multiple buffers. It asks you to specify the buffer names one | |
1436 | by one. | |
1437 | ||
1438 | @item M-x multi-occur-in-matching-buffers | |
1439 | This command is similar to @code{multi-occur}, except the buffers to | |
1440 | search are specified by a regular expression that matches visited file | |
1441 | names. With a prefix argument, it uses the regular expression to | |
1442 | match buffer names instead. | |
1443 | ||
1444 | @item M-x how-many | |
1445 | Prompt for a regexp, and print the number of matches for it in the | |
1446 | buffer after point. If the region is active, this operates on the | |
1447 | region instead. | |
1448 | ||
1449 | @item M-x flush-lines | |
1450 | Prompt for a regexp, and delete each line that contains a match for | |
1451 | it, operating on the text after point. This command deletes the | |
1452 | current line if it contains a match starting after point. If the | |
1453 | region is active, it operates on the region instead; if a line | |
1454 | partially contained in the region contains a match entirely contained | |
1455 | in the region, it is deleted. | |
8cf51b2c GM |
1456 | |
1457 | If a match is split across lines, @code{flush-lines} deletes all those | |
1458 | lines. It deletes the lines before starting to look for the next | |
1459 | match; hence, it ignores a match starting on the same line at which | |
1460 | another match ended. | |
1461 | ||
15cf2f52 CY |
1462 | @item M-x keep-lines |
1463 | Prompt for a regexp, and delete each line that @emph{does not} contain | |
1464 | a match for it, operating on the text after point. If point is not at | |
1465 | the beginning of a line, this command always keeps the current line. | |
1466 | If the region is active, the command operates on the region instead; | |
1467 | it never deletes lines that are only partially contained in the region | |
1468 | (a newline that ends a line counts as part of that line). | |
8cf51b2c GM |
1469 | |
1470 | If a match is split across lines, this command keeps all those lines. | |
1471 | @end table |