Mercurial > emacs
annotate man/search.texi @ 35954:c869b148aa3f
Document what does mouse-3 do on the mode line if there's only one window.
author | Eli Zaretskii <eliz@gnu.org> |
---|---|
date | Wed, 07 Feb 2001 13:50:12 +0000 |
parents | 250691f20cec |
children | bebad4c9dbcc |
rev | line source |
---|---|
25829 | 1 @c This is part of the Emacs manual. |
28126 | 2 @c Copyright (C) 1985, 86, 87, 93, 94, 95, 97, 2000 |
3 @c Free Software Foundation, Inc. | |
25829 | 4 @c See file emacs.texi for copying conditions. |
5 @node Search, Fixit, Display, Top | |
6 @chapter Searching and Replacement | |
7 @cindex searching | |
8 @cindex finding strings within text | |
9 | |
10 Like other editors, Emacs has commands for searching for occurrences of | |
11 a string. The principal search command is unusual in that it is | |
12 @dfn{incremental}; it begins to search before you have finished typing the | |
13 search string. There are also nonincremental search commands more like | |
14 those of other editors. | |
15 | |
16 Besides the usual @code{replace-string} command that finds all | |
17 occurrences of one string and replaces them with another, Emacs has a fancy | |
18 replacement command called @code{query-replace} which asks interactively | |
19 which occurrences to replace. | |
20 | |
21 @menu | |
22 * Incremental Search:: Search happens as you type the string. | |
23 * Nonincremental Search:: Specify entire string and then search. | |
24 * Word Search:: Search for sequence of words. | |
25 * Regexp Search:: Search for match for a regexp. | |
26 * Regexps:: Syntax of regular expressions. | |
27 * Search Case:: To ignore case while searching, or not. | |
28 * Replace:: Search, and replace some or all matches. | |
29 * Other Repeating Search:: Operating on all matches for some regexp. | |
30 @end menu | |
31 | |
32 @node Incremental Search, Nonincremental Search, Search, Search | |
33 @section Incremental Search | |
34 | |
35 @cindex incremental search | |
36 An incremental search begins searching as soon as you type the first | |
37 character of the search string. As you type in the search string, Emacs | |
38 shows you where the string (as you have typed it so far) would be | |
39 found. When you have typed enough characters to identify the place you | |
40 want, you can stop. Depending on what you plan to do next, you may or | |
41 may not need to terminate the search explicitly with @key{RET}. | |
42 | |
43 @c WideCommands | |
44 @table @kbd | |
45 @item C-s | |
46 Incremental search forward (@code{isearch-forward}). | |
47 @item C-r | |
48 Incremental search backward (@code{isearch-backward}). | |
49 @end table | |
50 | |
51 @kindex C-s | |
52 @findex isearch-forward | |
53 @kbd{C-s} starts an incremental search. @kbd{C-s} reads characters from | |
54 the keyboard and positions the cursor at the first occurrence of the | |
55 characters that you have typed. If you type @kbd{C-s} and then @kbd{F}, | |
56 the cursor moves right after the first @samp{F}. Type an @kbd{O}, and see | |
57 the cursor move to after the first @samp{FO}. After another @kbd{O}, the | |
58 cursor is after the first @samp{FOO} after the place where you started the | |
59 search. At each step, the buffer text that matches the search string is | |
60 highlighted, if the terminal can do that; at each step, the current search | |
35827 | 61 string is updated in the echo area. Multilingual text can be input by |
35904
250691f20cec
(Incremental Search): Document C-\ and C-^.
Eli Zaretskii <eliz@gnu.org>
parents:
35876
diff
changeset
|
62 toggling input methods with @kbd{C-\} or @kbd{C-^}, see below. |
25829 | 63 |
64 If you make a mistake in typing the search string, you can cancel | |
65 characters with @key{DEL}. Each @key{DEL} cancels the last character of | |
66 search string. This does not happen until Emacs is ready to read another | |
67 input character; first it must either find, or fail to find, the character | |
68 you want to erase. If you do not want to wait for this to happen, use | |
69 @kbd{C-g} as described below. | |
70 | |
71 When you are satisfied with the place you have reached, you can type | |
72 @key{RET}, which stops searching, leaving the cursor where the search | |
73 brought it. Also, any command not specially meaningful in searches | |
74 stops the searching and is then executed. Thus, typing @kbd{C-a} would | |
75 exit the search and then move to the beginning of the line. @key{RET} | |
76 is necessary only if the next command you want to type is a printing | |
77 character, @key{DEL}, @key{RET}, or another control character that is | |
78 special within searches (@kbd{C-q}, @kbd{C-w}, @kbd{C-r}, @kbd{C-s}, | |
79 @kbd{C-y}, @kbd{M-y}, @kbd{M-r}, or @kbd{M-s}). | |
80 | |
81 Sometimes you search for @samp{FOO} and find it, but not the one you | |
82 expected to find. There was a second @samp{FOO} that you forgot about, | |
83 before the one you were aiming for. In this event, type another @kbd{C-s} | |
84 to move to the next occurrence of the search string. This can be done any | |
85 number of times. If you overshoot, you can cancel some @kbd{C-s} | |
86 characters with @key{DEL}. | |
87 | |
88 After you exit a search, you can search for the same string again by | |
89 typing just @kbd{C-s C-s}: the first @kbd{C-s} is the key that invokes | |
90 incremental search, and the second @kbd{C-s} means ``search again.'' | |
91 | |
92 To reuse earlier search strings, use the @dfn{search ring}. The | |
93 commands @kbd{M-p} and @kbd{M-n} move through the ring to pick a search | |
94 string to reuse. These commands leave the selected search ring element | |
95 in the minibuffer, where you can edit it. Type @kbd{C-s} or @kbd{C-r} | |
96 to terminate editing the string and search for it. | |
97 | |
98 If your string is not found at all, the echo area says @samp{Failing | |
99 I-Search}. The cursor is after the place where Emacs found as much of your | |
100 string as it could. Thus, if you search for @samp{FOOT}, and there is no | |
101 @samp{FOOT}, you might see the cursor after the @samp{FOO} in @samp{FOOL}. | |
102 At this point there are several things you can do. If your string was | |
103 mistyped, you can rub some of it out and correct it. If you like the place | |
104 you have found, you can type @key{RET} or some other Emacs command to | |
105 ``accept what the search offered.'' Or you can type @kbd{C-g}, which | |
106 removes from the search string the characters that could not be found (the | |
107 @samp{T} in @samp{FOOT}), leaving those that were found (the @samp{FOO} in | |
108 @samp{FOOT}). A second @kbd{C-g} at that point cancels the search | |
109 entirely, returning point to where it was when the search started. | |
110 | |
111 An upper-case letter in the search string makes the search | |
112 case-sensitive. If you delete the upper-case character from the search | |
113 string, it ceases to have this effect. @xref{Search Case}. | |
114 | |
35904
250691f20cec
(Incremental Search): Document C-\ and C-^.
Eli Zaretskii <eliz@gnu.org>
parents:
35876
diff
changeset
|
115 @cindex searching for non-ASCII characters |
250691f20cec
(Incremental Search): Document C-\ and C-^.
Eli Zaretskii <eliz@gnu.org>
parents:
35876
diff
changeset
|
116 @cindex input method, during incremental search |
250691f20cec
(Incremental Search): Document C-\ and C-^.
Eli Zaretskii <eliz@gnu.org>
parents:
35876
diff
changeset
|
117 If an input method (@pxref{Input Methods}) is turned on in the |
250691f20cec
(Incremental Search): Document C-\ and C-^.
Eli Zaretskii <eliz@gnu.org>
parents:
35876
diff
changeset
|
118 current buffer when you start the search, that input method is used to |
250691f20cec
(Incremental Search): Document C-\ and C-^.
Eli Zaretskii <eliz@gnu.org>
parents:
35876
diff
changeset
|
119 read the characters while you type the search string. Emacs indicates |
250691f20cec
(Incremental Search): Document C-\ and C-^.
Eli Zaretskii <eliz@gnu.org>
parents:
35876
diff
changeset
|
120 that by including the input method mnemonic in its prompt, like this: |
250691f20cec
(Incremental Search): Document C-\ and C-^.
Eli Zaretskii <eliz@gnu.org>
parents:
35876
diff
changeset
|
121 |
250691f20cec
(Incremental Search): Document C-\ and C-^.
Eli Zaretskii <eliz@gnu.org>
parents:
35876
diff
changeset
|
122 @example |
250691f20cec
(Incremental Search): Document C-\ and C-^.
Eli Zaretskii <eliz@gnu.org>
parents:
35876
diff
changeset
|
123 I-search [@var{im}]: |
250691f20cec
(Incremental Search): Document C-\ and C-^.
Eli Zaretskii <eliz@gnu.org>
parents:
35876
diff
changeset
|
124 @end example |
250691f20cec
(Incremental Search): Document C-\ and C-^.
Eli Zaretskii <eliz@gnu.org>
parents:
35876
diff
changeset
|
125 |
250691f20cec
(Incremental Search): Document C-\ and C-^.
Eli Zaretskii <eliz@gnu.org>
parents:
35876
diff
changeset
|
126 @noindent |
250691f20cec
(Incremental Search): Document C-\ and C-^.
Eli Zaretskii <eliz@gnu.org>
parents:
35876
diff
changeset
|
127 @findex isearch-toggle-input-method |
250691f20cec
(Incremental Search): Document C-\ and C-^.
Eli Zaretskii <eliz@gnu.org>
parents:
35876
diff
changeset
|
128 @findex isearch-toggle-specified-input-method |
250691f20cec
(Incremental Search): Document C-\ and C-^.
Eli Zaretskii <eliz@gnu.org>
parents:
35876
diff
changeset
|
129 where @var{im} is the mnemonic of the active input method. You can |
250691f20cec
(Incremental Search): Document C-\ and C-^.
Eli Zaretskii <eliz@gnu.org>
parents:
35876
diff
changeset
|
130 toggle (enable or disable) the input method while you type the search |
250691f20cec
(Incremental Search): Document C-\ and C-^.
Eli Zaretskii <eliz@gnu.org>
parents:
35876
diff
changeset
|
131 string with @kbd{C-\} (@code{isearch-toggle-input-method}). You can |
250691f20cec
(Incremental Search): Document C-\ and C-^.
Eli Zaretskii <eliz@gnu.org>
parents:
35876
diff
changeset
|
132 turn on a certain (non-default) input method with @kbd{C-^} |
250691f20cec
(Incremental Search): Document C-\ and C-^.
Eli Zaretskii <eliz@gnu.org>
parents:
35876
diff
changeset
|
133 (@code{isearch-toggle-specified-input-method}), which prompts for the |
250691f20cec
(Incremental Search): Document C-\ and C-^.
Eli Zaretskii <eliz@gnu.org>
parents:
35876
diff
changeset
|
134 name of the input method. Note that the input method you turn on |
250691f20cec
(Incremental Search): Document C-\ and C-^.
Eli Zaretskii <eliz@gnu.org>
parents:
35876
diff
changeset
|
135 during incremental search is turned on in the current buffer as well. |
250691f20cec
(Incremental Search): Document C-\ and C-^.
Eli Zaretskii <eliz@gnu.org>
parents:
35876
diff
changeset
|
136 |
25829 | 137 If a search is failing and you ask to repeat it by typing another |
138 @kbd{C-s}, it starts again from the beginning of the buffer. Repeating | |
139 a failing reverse search with @kbd{C-r} starts again from the end. This | |
140 is called @dfn{wrapping around}. @samp{Wrapped} appears in the search | |
141 prompt once this has happened. If you keep on going past the original | |
142 starting point of the search, it changes to @samp{Overwrapped}, which | |
143 means that you are revisiting matches that you have already seen. | |
144 | |
145 @cindex quitting (in search) | |
146 The @kbd{C-g} ``quit'' character does special things during searches; | |
147 just what it does depends on the status of the search. If the search has | |
148 found what you specified and is waiting for input, @kbd{C-g} cancels the | |
149 entire search. The cursor moves back to where you started the search. If | |
150 @kbd{C-g} is typed when there are characters in the search string that have | |
151 not been found---because Emacs is still searching for them, or because it | |
152 has failed to find them---then the search string characters which have not | |
153 been found are discarded from the search string. With them gone, the | |
154 search is now successful and waiting for more input, so a second @kbd{C-g} | |
155 will cancel the entire search. | |
156 | |
157 To search for a newline, type @kbd{C-j}. To search for another | |
158 control character, such as control-S or carriage return, you must quote | |
159 it by typing @kbd{C-q} first. This function of @kbd{C-q} is analogous | |
160 to its use for insertion (@pxref{Inserting Text}): it causes the | |
161 following character to be treated the way any ``ordinary'' character is | |
162 treated in the same context. You can also specify a character by its | |
163 octal code: enter @kbd{C-q} followed by a sequence of octal digits. | |
164 | |
165 You can change to searching backwards with @kbd{C-r}. If a search fails | |
166 because the place you started was too late in the file, you should do this. | |
167 Repeated @kbd{C-r} keeps looking for more occurrences backwards. A | |
168 @kbd{C-s} starts going forwards again. @kbd{C-r} in a search can be canceled | |
169 with @key{DEL}. | |
170 | |
171 @kindex C-r | |
172 @findex isearch-backward | |
173 If you know initially that you want to search backwards, you can use | |
174 @kbd{C-r} instead of @kbd{C-s} to start the search, because @kbd{C-r} as | |
175 a key runs a command (@code{isearch-backward}) to search backward. A | |
176 backward search finds matches that are entirely before the starting | |
177 point, just as a forward search finds matches that begin after it. | |
178 | |
179 The characters @kbd{C-y} and @kbd{C-w} can be used in incremental | |
180 search to grab text from the buffer into the search string. This makes | |
181 it convenient to search for another occurrence of text at point. | |
182 @kbd{C-w} copies the word after point as part of the search string, | |
183 advancing point over that word. Another @kbd{C-s} to repeat the search | |
184 will then search for a string including that word. @kbd{C-y} is similar | |
185 to @kbd{C-w} but copies all the rest of the current line into the search | |
186 string. Both @kbd{C-y} and @kbd{C-w} convert the text they copy to | |
187 lower case if the search is currently not case-sensitive; this is so the | |
188 search remains case-insensitive. | |
189 | |
190 The character @kbd{M-y} copies text from the kill ring into the search | |
191 string. It uses the same text that @kbd{C-y} as a command would yank. | |
27217 | 192 @kbd{mouse-2} in the echo area does the same. |
25829 | 193 @xref{Yanking}. |
194 | |
195 When you exit the incremental search, it sets the mark to where point | |
196 @emph{was}, before the search. That is convenient for moving back | |
197 there. In Transient Mark mode, incremental search sets the mark without | |
198 activating it, and does so only if the mark is not already active. | |
199 | |
27217 | 200 @cindex lazy search highlighting |
201 By default, Isearch uses @dfn{lazy highlighting}. All matches for | |
202 the current search string in the buffer after the point where searching | |
203 starts are highlighted. The extra highlighting makes it easier to | |
204 anticipate where the cursor will end up each time you press @kbd{C-s} or | |
205 @kbd{C-r} to repeat a pending search. Highlighting of these additional | |
206 matches happens in a deferred fashion so as not to rob Isearch of its | |
207 usual snappy response. | |
208 @vindex isearch-lazy-highlight-cleanup | |
31062
c503cf38b3e8
More details and index entries for isearch-lazy-highlight.
Eli Zaretskii <eliz@gnu.org>
parents:
31048
diff
changeset
|
209 @findex isearch-lazy-highlight-cleanup |
27217 | 210 By default the highlighting of matches is cleared when you end the |
211 search. Customize the variable @code{isearch-lazy-highlight-cleanup} to | |
212 avoid cleaning up automatically. The command @kbd{M-x | |
213 isearch-lazy-highlight-cleanup} can be used to clean up manually. | |
214 @vindex isearch-lazy-highlight | |
215 Customize the variable @code{isearch-lazy-highlight} to turn off this | |
216 feature. | |
217 | |
31062
c503cf38b3e8
More details and index entries for isearch-lazy-highlight.
Eli Zaretskii <eliz@gnu.org>
parents:
31048
diff
changeset
|
218 @vindex isearch-lazy-highlight-face |
c503cf38b3e8
More details and index entries for isearch-lazy-highlight.
Eli Zaretskii <eliz@gnu.org>
parents:
31048
diff
changeset
|
219 @cindex faces for highlighting search matches |
c503cf38b3e8
More details and index entries for isearch-lazy-highlight.
Eli Zaretskii <eliz@gnu.org>
parents:
31048
diff
changeset
|
220 You can control how does the highlighting of matches look like by |
c503cf38b3e8
More details and index entries for isearch-lazy-highlight.
Eli Zaretskii <eliz@gnu.org>
parents:
31048
diff
changeset
|
221 customizing the faces @code{isearch} (highlights the current match) and |
35876
4581606f2141
Don't say that isearch faces inherit from other faces.
Eli Zaretskii <eliz@gnu.org>
parents:
35827
diff
changeset
|
222 @code{isearch-lazy-highlight-face} (highlights the other matches). |
31062
c503cf38b3e8
More details and index entries for isearch-lazy-highlight.
Eli Zaretskii <eliz@gnu.org>
parents:
31048
diff
changeset
|
223 |
25829 | 224 @vindex isearch-mode-map |
225 To customize the special characters that incremental search understands, | |
226 alter their bindings in the keymap @code{isearch-mode-map}. For a list | |
227 of bindings, look at the documentation of @code{isearch-mode} with | |
228 @kbd{C-h f isearch-mode @key{RET}}. | |
229 | |
230 @subsection Slow Terminal Incremental Search | |
231 | |
232 Incremental search on a slow terminal uses a modified style of display | |
233 that is designed to take less time. Instead of redisplaying the buffer at | |
234 each place the search gets to, it creates a new single-line window and uses | |
235 that to display the line that the search has found. The single-line window | |
236 comes into play as soon as point gets outside of the text that is already | |
237 on the screen. | |
238 | |
239 When you terminate the search, the single-line window is removed. | |
240 Then Emacs redisplays the window in which the search was done, to show | |
241 its new position of point. | |
242 | |
243 @ignore | |
244 The three dots at the end of the search string, normally used to indicate | |
245 that searching is going on, are not displayed in slow style display. | |
246 @end ignore | |
247 | |
248 @vindex search-slow-speed | |
249 The slow terminal style of display is used when the terminal baud rate is | |
250 less than or equal to the value of the variable @code{search-slow-speed}, | |
251 initially 1200. | |
252 | |
253 @vindex search-slow-window-lines | |
254 The number of lines to use in slow terminal search display is controlled | |
255 by the variable @code{search-slow-window-lines}. Its normal value is 1. | |
256 | |
257 @node Nonincremental Search, Word Search, Incremental Search, Search | |
258 @section Nonincremental Search | |
259 @cindex nonincremental search | |
260 | |
261 Emacs also has conventional nonincremental search commands, which require | |
262 you to type the entire search string before searching begins. | |
263 | |
264 @table @kbd | |
265 @item C-s @key{RET} @var{string} @key{RET} | |
266 Search for @var{string}. | |
267 @item C-r @key{RET} @var{string} @key{RET} | |
268 Search backward for @var{string}. | |
269 @end table | |
270 | |
271 To do a nonincremental search, first type @kbd{C-s @key{RET}}. This | |
272 enters the minibuffer to read the search string; terminate the string | |
273 with @key{RET}, and then the search takes place. If the string is not | |
274 found, the search command gets an error. | |
275 | |
276 The way @kbd{C-s @key{RET}} works is that the @kbd{C-s} invokes | |
277 incremental search, which is specially programmed to invoke nonincremental | |
278 search if the argument you give it is empty. (Such an empty argument would | |
279 otherwise be useless.) @kbd{C-r @key{RET}} also works this way. | |
280 | |
281 However, nonincremental searches performed using @kbd{C-s @key{RET}} do | |
282 not call @code{search-forward} right away. The first thing done is to see | |
283 if the next character is @kbd{C-w}, which requests a word search. | |
284 @ifinfo | |
285 @xref{Word Search}. | |
286 @end ifinfo | |
287 | |
288 @findex search-forward | |
289 @findex search-backward | |
290 Forward and backward nonincremental searches are implemented by the | |
291 commands @code{search-forward} and @code{search-backward}. These | |
292 commands may be bound to keys in the usual manner. The feature that you | |
293 can get to them via the incremental search commands exists for | |
294 historical reasons, and to avoid the need to find suitable key sequences | |
295 for them. | |
296 | |
297 @node Word Search, Regexp Search, Nonincremental Search, Search | |
298 @section Word Search | |
299 @cindex word search | |
300 | |
301 Word search searches for a sequence of words without regard to how the | |
302 words are separated. More precisely, you type a string of many words, | |
303 using single spaces to separate them, and the string can be found even if | |
304 there are multiple spaces, newlines or other punctuation between the words. | |
305 | |
306 Word search is useful for editing a printed document made with a text | |
307 formatter. If you edit while looking at the printed, formatted version, | |
308 you can't tell where the line breaks are in the source file. With word | |
309 search, you can search without having to know them. | |
310 | |
311 @table @kbd | |
312 @item C-s @key{RET} C-w @var{words} @key{RET} | |
313 Search for @var{words}, ignoring details of punctuation. | |
314 @item C-r @key{RET} C-w @var{words} @key{RET} | |
315 Search backward for @var{words}, ignoring details of punctuation. | |
316 @end table | |
317 | |
318 Word search is a special case of nonincremental search and is invoked | |
319 with @kbd{C-s @key{RET} C-w}. This is followed by the search string, | |
320 which must always be terminated with @key{RET}. Being nonincremental, | |
321 this search does not start until the argument is terminated. It works | |
322 by constructing a regular expression and searching for that; see | |
323 @ref{Regexp Search}. | |
324 | |
325 Use @kbd{C-r @key{RET} C-w} to do backward word search. | |
326 | |
327 @findex word-search-forward | |
328 @findex word-search-backward | |
329 Forward and backward word searches are implemented by the commands | |
330 @code{word-search-forward} and @code{word-search-backward}. These | |
331 commands may be bound to keys in the usual manner. The feature that you | |
332 can get to them via the incremental search commands exists for historical | |
333 reasons, and to avoid the need to find suitable key sequences for them. | |
334 | |
335 @node Regexp Search, Regexps, Word Search, Search | |
336 @section Regular Expression Search | |
337 @cindex regular expression | |
338 @cindex regexp | |
339 | |
340 A @dfn{regular expression} (@dfn{regexp}, for short) is a pattern that | |
341 denotes a class of alternative strings to match, possibly infinitely | |
342 many. In GNU Emacs, you can search for the next match for a regexp | |
343 either incrementally or not. | |
344 | |
345 @kindex C-M-s | |
346 @findex isearch-forward-regexp | |
347 @kindex C-M-r | |
348 @findex isearch-backward-regexp | |
349 Incremental search for a regexp is done by typing @kbd{C-M-s} | |
350 (@code{isearch-forward-regexp}). This command reads a search string | |
351 incrementally just like @kbd{C-s}, but it treats the search string as a | |
352 regexp rather than looking for an exact match against the text in the | |
353 buffer. Each time you add text to the search string, you make the | |
354 regexp longer, and the new regexp is searched for. Invoking @kbd{C-s} | |
355 with a prefix argument (its value does not matter) is another way to do | |
356 a forward incremental regexp search. To search backward for a regexp, | |
357 use @kbd{C-M-r} (@code{isearch-backward-regexp}), or @kbd{C-r} with a | |
358 prefix argument. | |
359 | |
360 All of the control characters that do special things within an | |
361 ordinary incremental search have the same function in incremental regexp | |
362 search. Typing @kbd{C-s} or @kbd{C-r} immediately after starting the | |
363 search retrieves the last incremental search regexp used; that is to | |
364 say, incremental regexp and non-regexp searches have independent | |
365 defaults. They also have separate search rings that you can access with | |
366 @kbd{M-p} and @kbd{M-n}. | |
367 | |
368 If you type @key{SPC} in incremental regexp search, it matches any | |
369 sequence of whitespace characters, including newlines. If you want | |
370 to match just a space, type @kbd{C-q @key{SPC}}. | |
371 | |
372 Note that adding characters to the regexp in an incremental regexp | |
373 search can make the cursor move back and start again. For example, if | |
374 you have searched for @samp{foo} and you add @samp{\|bar}, the cursor | |
375 backs up in case the first @samp{bar} precedes the first @samp{foo}. | |
376 | |
377 @findex re-search-forward | |
378 @findex re-search-backward | |
379 Nonincremental search for a regexp is done by the functions | |
380 @code{re-search-forward} and @code{re-search-backward}. You can invoke | |
381 these with @kbd{M-x}, or bind them to keys, or invoke them by way of | |
382 incremental regexp search with @kbd{C-M-s @key{RET}} and @kbd{C-M-r | |
383 @key{RET}}. | |
384 | |
385 If you use the incremental regexp search commands with a prefix | |
386 argument, they perform ordinary string search, like | |
387 @code{isearch-forward} and @code{isearch-backward}. @xref{Incremental | |
388 Search}. | |
389 | |
390 @node Regexps, Search Case, Regexp Search, Search | |
391 @section Syntax of Regular Expressions | |
392 @cindex regexp syntax | |
393 | |
394 Regular expressions have a syntax in which a few characters are | |
395 special constructs and the rest are @dfn{ordinary}. An ordinary | |
396 character is a simple regular expression which matches that same | |
397 character and nothing else. The special characters are @samp{$}, | |
398 @samp{^}, @samp{.}, @samp{*}, @samp{+}, @samp{?}, @samp{[}, @samp{]} and | |
399 @samp{\}. Any other character appearing in a regular expression is | |
400 ordinary, unless a @samp{\} precedes it. | |
401 | |
402 For example, @samp{f} is not a special character, so it is ordinary, and | |
403 therefore @samp{f} is a regular expression that matches the string | |
404 @samp{f} and no other string. (It does @emph{not} match the string | |
405 @samp{ff}.) Likewise, @samp{o} is a regular expression that matches | |
406 only @samp{o}. (When case distinctions are being ignored, these regexps | |
407 also match @samp{F} and @samp{O}, but we consider this a generalization | |
408 of ``the same string,'' rather than an exception.) | |
409 | |
410 Any two regular expressions @var{a} and @var{b} can be concatenated. The | |
411 result is a regular expression which matches a string if @var{a} matches | |
412 some amount of the beginning of that string and @var{b} matches the rest of | |
413 the string.@refill | |
414 | |
415 As a simple example, we can concatenate the regular expressions @samp{f} | |
416 and @samp{o} to get the regular expression @samp{fo}, which matches only | |
417 the string @samp{fo}. Still trivial. To do something nontrivial, you | |
418 need to use one of the special characters. Here is a list of them. | |
419 | |
420 @table @kbd | |
421 @item .@: @r{(Period)} | |
422 is a special character that matches any single character except a newline. | |
423 Using concatenation, we can make regular expressions like @samp{a.b}, which | |
424 matches any three-character string that begins with @samp{a} and ends with | |
425 @samp{b}.@refill | |
426 | |
427 @item * | |
428 is not a construct by itself; it is a postfix operator that means to | |
429 match the preceding regular expression repetitively as many times as | |
430 possible. Thus, @samp{o*} matches any number of @samp{o}s (including no | |
431 @samp{o}s). | |
432 | |
433 @samp{*} always applies to the @emph{smallest} possible preceding | |
434 expression. Thus, @samp{fo*} has a repeating @samp{o}, not a repeating | |
435 @samp{fo}. It matches @samp{f}, @samp{fo}, @samp{foo}, and so on. | |
436 | |
437 The matcher processes a @samp{*} construct by matching, immediately, | |
438 as many repetitions as can be found. Then it continues with the rest | |
439 of the pattern. If that fails, backtracking occurs, discarding some | |
440 of the matches of the @samp{*}-modified construct in case that makes | |
441 it possible to match the rest of the pattern. For example, in matching | |
442 @samp{ca*ar} against the string @samp{caaar}, the @samp{a*} first | |
443 tries to match all three @samp{a}s; but the rest of the pattern is | |
444 @samp{ar} and there is only @samp{r} left to match, so this try fails. | |
445 The next alternative is for @samp{a*} to match only two @samp{a}s. | |
446 With this choice, the rest of the regexp matches successfully.@refill | |
447 | |
448 @item + | |
449 is a postfix operator, similar to @samp{*} except that it must match | |
450 the preceding expression at least once. So, for example, @samp{ca+r} | |
451 matches the strings @samp{car} and @samp{caaaar} but not the string | |
452 @samp{cr}, whereas @samp{ca*r} matches all three strings. | |
453 | |
454 @item ? | |
455 is a postfix operator, similar to @samp{*} except that it can match the | |
456 preceding expression either once or not at all. For example, | |
457 @samp{ca?r} matches @samp{car} or @samp{cr}; nothing else. | |
458 | |
27094
6500fd0a7d8e
*** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
25829
diff
changeset
|
459 @item *?, +?, ?? |
27139
a9508422287d
Improve markup for the description of non-greedy operators.
Eli Zaretskii <eliz@gnu.org>
parents:
27094
diff
changeset
|
460 @cindex non-greedy regexp matching |
27094
6500fd0a7d8e
*** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
25829
diff
changeset
|
461 are non-greedy variants of the operators above. The normal operators |
27139
a9508422287d
Improve markup for the description of non-greedy operators.
Eli Zaretskii <eliz@gnu.org>
parents:
27094
diff
changeset
|
462 @samp{*}, @samp{+}, @samp{?} are @dfn{greedy} in that they match as much |
a9508422287d
Improve markup for the description of non-greedy operators.
Eli Zaretskii <eliz@gnu.org>
parents:
27094
diff
changeset
|
463 as they can, while if you append a @samp{?} after them, it makes them |
a9508422287d
Improve markup for the description of non-greedy operators.
Eli Zaretskii <eliz@gnu.org>
parents:
27094
diff
changeset
|
464 non-greedy: they will match as little as possible. |
27094
6500fd0a7d8e
*** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
25829
diff
changeset
|
465 |
28063
f1b33463506d
*** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
27694
diff
changeset
|
466 @item \@{@var{n},@var{m}\@} |
27694
5c14849aee4c
documented \{n,m\} intervals
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
27217
diff
changeset
|
467 is another postfix operator that specifies an interval of iteration: |
28063
f1b33463506d
*** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
27694
diff
changeset
|
468 the preceding regular expression must match between @var{n} and |
f1b33463506d
*** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
27694
diff
changeset
|
469 @var{m} times. If @var{m} is omitted, then there is no upper bound |
28134
60b77d9b88ec
*** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
28126
diff
changeset
|
470 and if @samp{,@var{m}} is omitted, then the regular expression must match |
28063
f1b33463506d
*** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
27694
diff
changeset
|
471 exactly @var{n} times. @* |
27694
5c14849aee4c
documented \{n,m\} intervals
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
27217
diff
changeset
|
472 @samp{\@{0,1\@}} is equivalent to @samp{?}. @* |
5c14849aee4c
documented \{n,m\} intervals
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
27217
diff
changeset
|
473 @samp{\@{0,\@}} is equivalent to @samp{*}. @* |
5c14849aee4c
documented \{n,m\} intervals
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
27217
diff
changeset
|
474 @samp{\@{1,\@}} is equivalent to @samp{+}. @* |
28063
f1b33463506d
*** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
27694
diff
changeset
|
475 @samp{\@{@var{n}\@}} is equivalent to @samp{\@{@var{n},@var{n}\@}}. |
27694
5c14849aee4c
documented \{n,m\} intervals
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
27217
diff
changeset
|
476 |
25829 | 477 @item [ @dots{} ] |
478 is a @dfn{character set}, which begins with @samp{[} and is terminated | |
479 by @samp{]}. In the simplest case, the characters between the two | |
480 brackets are what this set can match. | |
481 | |
482 Thus, @samp{[ad]} matches either one @samp{a} or one @samp{d}, and | |
483 @samp{[ad]*} matches any string composed of just @samp{a}s and @samp{d}s | |
484 (including the empty string), from which it follows that @samp{c[ad]*r} | |
485 matches @samp{cr}, @samp{car}, @samp{cdr}, @samp{caddaar}, etc. | |
486 | |
487 You can also include character ranges in a character set, by writing the | |
488 starting and ending characters with a @samp{-} between them. Thus, | |
489 @samp{[a-z]} matches any lower-case ASCII letter. Ranges may be | |
490 intermixed freely with individual characters, as in @samp{[a-z$%.]}, | |
491 which matches any lower-case ASCII letter or @samp{$}, @samp{%} or | |
492 period. | |
493 | |
494 Note that the usual regexp special characters are not special inside a | |
495 character set. A completely different set of special characters exists | |
496 inside character sets: @samp{]}, @samp{-} and @samp{^}. | |
497 | |
498 To include a @samp{]} in a character set, you must make it the first | |
499 character. For example, @samp{[]a]} matches @samp{]} or @samp{a}. To | |
500 include a @samp{-}, write @samp{-} as the first or last character of the | |
501 set, or put it after a range. Thus, @samp{[]-]} matches both @samp{]} | |
502 and @samp{-}. | |
503 | |
504 To include @samp{^} in a set, put it anywhere but at the beginning of | |
505 the set. | |
506 | |
507 When you use a range in case-insensitive search, you should write both | |
508 ends of the range in upper case, or both in lower case, or both should | |
509 be non-letters. The behavior of a mixed-case range such as @samp{A-z} | |
510 is somewhat ill-defined, and it may change in future Emacs versions. | |
511 | |
512 @item [^ @dots{} ] | |
513 @samp{[^} begins a @dfn{complemented character set}, which matches any | |
514 character except the ones specified. Thus, @samp{[^a-z0-9A-Z]} matches | |
515 all characters @emph{except} letters and digits. | |
516 | |
517 @samp{^} is not special in a character set unless it is the first | |
518 character. The character following the @samp{^} is treated as if it | |
519 were first (in other words, @samp{-} and @samp{]} are not special there). | |
520 | |
521 A complemented character set can match a newline, unless newline is | |
522 mentioned as one of the characters not to match. This is in contrast to | |
523 the handling of regexps in programs such as @code{grep}. | |
524 | |
525 @item ^ | |
526 is a special character that matches the empty string, but only at the | |
527 beginning of a line in the text being matched. Otherwise it fails to | |
528 match anything. Thus, @samp{^foo} matches a @samp{foo} that occurs at | |
529 the beginning of a line. | |
530 | |
531 @item $ | |
532 is similar to @samp{^} but matches only at the end of a line. Thus, | |
533 @samp{x+$} matches a string of one @samp{x} or more at the end of a line. | |
534 | |
535 @item \ | |
536 has two functions: it quotes the special characters (including | |
537 @samp{\}), and it introduces additional special constructs. | |
538 | |
539 Because @samp{\} quotes special characters, @samp{\$} is a regular | |
540 expression that matches only @samp{$}, and @samp{\[} is a regular | |
541 expression that matches only @samp{[}, and so on. | |
542 @end table | |
543 | |
544 Note: for historical compatibility, special characters are treated as | |
545 ordinary ones if they are in contexts where their special meanings make no | |
546 sense. For example, @samp{*foo} treats @samp{*} as ordinary since there is | |
547 no preceding expression on which the @samp{*} can act. It is poor practice | |
548 to depend on this behavior; it is better to quote the special character anyway, | |
549 regardless of where it appears.@refill | |
550 | |
551 For the most part, @samp{\} followed by any character matches only that | |
552 character. However, there are several exceptions: two-character | |
553 sequences starting with @samp{\} that have special meanings. The second | |
554 character in the sequence is always an ordinary character when used on | |
555 its own. Here is a table of @samp{\} constructs. | |
556 | |
557 @table @kbd | |
558 @item \| | |
559 specifies an alternative. Two regular expressions @var{a} and @var{b} | |
560 with @samp{\|} in between form an expression that matches some text if | |
561 either @var{a} matches it or @var{b} matches it. It works by trying to | |
562 match @var{a}, and if that fails, by trying to match @var{b}. | |
563 | |
564 Thus, @samp{foo\|bar} matches either @samp{foo} or @samp{bar} | |
565 but no other string.@refill | |
566 | |
567 @samp{\|} applies to the largest possible surrounding expressions. Only a | |
568 surrounding @samp{\( @dots{} \)} grouping can limit the grouping power of | |
569 @samp{\|}.@refill | |
570 | |
571 Full backtracking capability exists to handle multiple uses of @samp{\|}. | |
572 | |
573 @item \( @dots{} \) | |
574 is a grouping construct that serves three purposes: | |
575 | |
576 @enumerate | |
577 @item | |
578 To enclose a set of @samp{\|} alternatives for other operations. | |
579 Thus, @samp{\(foo\|bar\)x} matches either @samp{foox} or @samp{barx}. | |
580 | |
581 @item | |
582 To enclose a complicated expression for the postfix operators @samp{*}, | |
583 @samp{+} and @samp{?} to operate on. Thus, @samp{ba\(na\)*} matches | |
584 @samp{bananana}, etc., with any (zero or more) number of @samp{na} | |
585 strings.@refill | |
586 | |
587 @item | |
588 To record a matched substring for future reference. | |
589 @end enumerate | |
590 | |
591 This last application is not a consequence of the idea of a | |
592 parenthetical grouping; it is a separate feature that is assigned as a | |
593 second meaning to the same @samp{\( @dots{} \)} construct. In practice | |
28063
f1b33463506d
*** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
27694
diff
changeset
|
594 there is almost no conflict between the two meanings. |
f1b33463506d
*** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
27694
diff
changeset
|
595 |
f1b33463506d
*** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
27694
diff
changeset
|
596 @item \(?: @dots{} \) |
f1b33463506d
*** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
27694
diff
changeset
|
597 is another grouping construct (often called ``shy'') that serves the same |
f1b33463506d
*** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
27694
diff
changeset
|
598 first two purposes, but not the third: |
f1b33463506d
*** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
27694
diff
changeset
|
599 it cannot be referred to later on by number. This is only useful |
f1b33463506d
*** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
27694
diff
changeset
|
600 for mechanically constructed regular expressions where grouping |
f1b33463506d
*** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
27694
diff
changeset
|
601 constructs need to be introduced implicitly and hence risk changing the |
f1b33463506d
*** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
27694
diff
changeset
|
602 numbering of subsequent groups. |
25829 | 603 |
604 @item \@var{d} | |
605 matches the same text that matched the @var{d}th occurrence of a | |
606 @samp{\( @dots{} \)} construct. | |
607 | |
608 After the end of a @samp{\( @dots{} \)} construct, the matcher remembers | |
609 the beginning and end of the text matched by that construct. Then, | |
610 later on in the regular expression, you can use @samp{\} followed by the | |
611 digit @var{d} to mean ``match the same text matched the @var{d}th time | |
612 by the @samp{\( @dots{} \)} construct.'' | |
613 | |
614 The strings matching the first nine @samp{\( @dots{} \)} constructs | |
615 appearing in a regular expression are assigned numbers 1 through 9 in | |
616 the order that the open-parentheses appear in the regular expression. | |
617 So you can use @samp{\1} through @samp{\9} to refer to the text matched | |
618 by the corresponding @samp{\( @dots{} \)} constructs. | |
619 | |
620 For example, @samp{\(.*\)\1} matches any newline-free string that is | |
621 composed of two identical halves. The @samp{\(.*\)} matches the first | |
622 half, which may be anything, but the @samp{\1} that follows must match | |
623 the same exact text. | |
624 | |
625 If a particular @samp{\( @dots{} \)} construct matches more than once | |
626 (which can easily happen if it is followed by @samp{*}), only the last | |
627 match is recorded. | |
628 | |
629 @item \` | |
630 matches the empty string, but only at the beginning | |
631 of the buffer or string being matched against. | |
632 | |
633 @item \' | |
634 matches the empty string, but only at the end of | |
635 the buffer or string being matched against. | |
636 | |
637 @item \= | |
638 matches the empty string, but only at point. | |
639 | |
640 @item \b | |
641 matches the empty string, but only at the beginning or | |
642 end of a word. Thus, @samp{\bfoo\b} matches any occurrence of | |
643 @samp{foo} as a separate word. @samp{\bballs?\b} matches | |
644 @samp{ball} or @samp{balls} as a separate word.@refill | |
645 | |
646 @samp{\b} matches at the beginning or end of the buffer | |
647 regardless of what text appears next to it. | |
648 | |
649 @item \B | |
650 matches the empty string, but @emph{not} at the beginning or | |
651 end of a word. | |
652 | |
653 @item \< | |
654 matches the empty string, but only at the beginning of a word. | |
655 @samp{\<} matches at the beginning of the buffer only if a | |
656 word-constituent character follows. | |
657 | |
658 @item \> | |
659 matches the empty string, but only at the end of a word. @samp{\>} | |
660 matches at the end of the buffer only if the contents end with a | |
661 word-constituent character. | |
662 | |
663 @item \w | |
664 matches any word-constituent character. The syntax table | |
665 determines which characters these are. @xref{Syntax}. | |
666 | |
667 @item \W | |
668 matches any character that is not a word-constituent. | |
669 | |
670 @item \s@var{c} | |
671 matches any character whose syntax is @var{c}. Here @var{c} is a | |
672 character that represents a syntax code: thus, @samp{w} for word | |
673 constituent, @samp{-} for whitespace, @samp{(} for open parenthesis, | |
674 etc. Represent a character of whitespace (which can be a newline) by | |
675 either @samp{-} or a space character. | |
676 | |
677 @item \S@var{c} | |
678 matches any character whose syntax is not @var{c}. | |
35904
250691f20cec
(Incremental Search): Document C-\ and C-^.
Eli Zaretskii <eliz@gnu.org>
parents:
35876
diff
changeset
|
679 |
250691f20cec
(Incremental Search): Document C-\ and C-^.
Eli Zaretskii <eliz@gnu.org>
parents:
35876
diff
changeset
|
680 @cindex categories of characters |
250691f20cec
(Incremental Search): Document C-\ and C-^.
Eli Zaretskii <eliz@gnu.org>
parents:
35876
diff
changeset
|
681 @cindex characters which belong to a specific language |
250691f20cec
(Incremental Search): Document C-\ and C-^.
Eli Zaretskii <eliz@gnu.org>
parents:
35876
diff
changeset
|
682 @findex describe-categories |
250691f20cec
(Incremental Search): Document C-\ and C-^.
Eli Zaretskii <eliz@gnu.org>
parents:
35876
diff
changeset
|
683 @item \c@var{c} |
250691f20cec
(Incremental Search): Document C-\ and C-^.
Eli Zaretskii <eliz@gnu.org>
parents:
35876
diff
changeset
|
684 matches any character that belongs to the category @var{c}. For |
250691f20cec
(Incremental Search): Document C-\ and C-^.
Eli Zaretskii <eliz@gnu.org>
parents:
35876
diff
changeset
|
685 example, @samp{\cc} matches Chinese characters, @samp{\cg} matches |
250691f20cec
(Incremental Search): Document C-\ and C-^.
Eli Zaretskii <eliz@gnu.org>
parents:
35876
diff
changeset
|
686 Greek characters, etc. For the description of the known categories, |
250691f20cec
(Incremental Search): Document C-\ and C-^.
Eli Zaretskii <eliz@gnu.org>
parents:
35876
diff
changeset
|
687 type @kbd{M-x describe-categories @key{RET}}. |
250691f20cec
(Incremental Search): Document C-\ and C-^.
Eli Zaretskii <eliz@gnu.org>
parents:
35876
diff
changeset
|
688 |
250691f20cec
(Incremental Search): Document C-\ and C-^.
Eli Zaretskii <eliz@gnu.org>
parents:
35876
diff
changeset
|
689 @item \C@var{c} |
250691f20cec
(Incremental Search): Document C-\ and C-^.
Eli Zaretskii <eliz@gnu.org>
parents:
35876
diff
changeset
|
690 matches any character that does @emph{not} belong to category |
250691f20cec
(Incremental Search): Document C-\ and C-^.
Eli Zaretskii <eliz@gnu.org>
parents:
35876
diff
changeset
|
691 @var{c}. |
25829 | 692 @end table |
693 | |
694 The constructs that pertain to words and syntax are controlled by the | |
695 setting of the syntax table (@pxref{Syntax}). | |
696 | |
697 Here is a complicated regexp, used by Emacs to recognize the end of a | |
698 sentence together with any whitespace that follows. It is given in Lisp | |
699 syntax to enable you to distinguish the spaces from the tab characters. In | |
700 Lisp syntax, the string constant begins and ends with a double-quote. | |
701 @samp{\"} stands for a double-quote as part of the regexp, @samp{\\} for a | |
702 backslash as part of the regexp, @samp{\t} for a tab and @samp{\n} for a | |
703 newline. | |
704 | |
705 @example | |
706 "[.?!][]\"')]*\\($\\|\t\\| \\)[ \t\n]*" | |
707 @end example | |
708 | |
709 @noindent | |
710 This contains four parts in succession: a character set matching period, | |
711 @samp{?}, or @samp{!}; a character set matching close-brackets, quotes, | |
712 or parentheses, repeated any number of times; an alternative in | |
713 backslash-parentheses that matches end-of-line, a tab, or two spaces; | |
714 and a character set matching whitespace characters, repeated any number | |
715 of times. | |
716 | |
717 To enter the same regexp interactively, you would type @key{TAB} to | |
718 enter a tab, and @kbd{C-j} to enter a newline. You would also type | |
719 single backslashes as themselves, instead of doubling them for Lisp syntax. | |
720 | |
31072 | 721 @findex re-builder |
722 @cindex authoring regular expressions | |
723 For easier authoring of regular expressions, you can use the @kbd{M-x | |
724 re-builder} command. It provides a convenient interface for creating | |
725 regular expressions, by giving immediate visual feedback. The buffer | |
726 from which @code{re-builder} was invoked becomes the target for the | |
727 regexp editor, which pops in a separate window. Text that matches the | |
728 regular expression you typed so far is color marked in the target | |
729 buffer. Each parenthesized sub-expression of the regexp is shown in a | |
730 distinct face, which makes it easier to verify even very complex | |
731 regexps. (On displays that don't support colors, Emacs blinks the | |
732 cursor around the matched text, like it does for matching parens.) | |
733 | |
25829 | 734 @node Search Case, Replace, Regexps, Search |
735 @section Searching and Case | |
736 | |
737 @vindex case-fold-search | |
738 Incremental searches in Emacs normally ignore the case of the text | |
739 they are searching through, if you specify the text in lower case. | |
740 Thus, if you specify searching for @samp{foo}, then @samp{Foo} and | |
741 @samp{foo} are also considered a match. Regexps, and in particular | |
742 character sets, are included: @samp{[ab]} would match @samp{a} or | |
743 @samp{A} or @samp{b} or @samp{B}.@refill | |
744 | |
745 An upper-case letter anywhere in the incremental search string makes | |
746 the search case-sensitive. Thus, searching for @samp{Foo} does not find | |
747 @samp{foo} or @samp{FOO}. This applies to regular expression search as | |
748 well as to string search. The effect ceases if you delete the | |
749 upper-case letter from the search string. | |
750 | |
751 If you set the variable @code{case-fold-search} to @code{nil}, then | |
752 all letters must match exactly, including case. This is a per-buffer | |
753 variable; altering the variable affects only the current buffer, but | |
754 there is a default value which you can change as well. @xref{Locals}. | |
755 This variable applies to nonincremental searches also, including those | |
756 performed by the replace commands (@pxref{Replace}) and the minibuffer | |
757 history matching commands (@pxref{Minibuffer History}). | |
758 | |
759 @node Replace, Other Repeating Search, Search Case, Search | |
760 @section Replacement Commands | |
761 @cindex replacement | |
762 @cindex search-and-replace commands | |
763 @cindex string substitution | |
764 @cindex global substitution | |
765 | |
766 Global search-and-replace operations are not needed as often in Emacs | |
767 as they are in other editors@footnote{In some editors, | |
768 search-and-replace operations are the only convenient way to make a | |
769 single change in the text.}, but they are available. In addition to the | |
770 simple @kbd{M-x replace-string} command which is like that found in most | |
771 editors, there is a @kbd{M-x query-replace} command which asks you, for | |
772 each occurrence of the pattern, whether to replace it. | |
773 | |
774 The replace commands normally operate on the text from point to the | |
775 end of the buffer; however, in Transient Mark mode, when the mark is | |
776 active, they operate on the region. The replace commands all replace | |
777 one string (or regexp) with one replacement string. It is possible to | |
778 perform several replacements in parallel using the command | |
779 @code{expand-region-abbrevs} (@pxref{Expanding Abbrevs}). | |
780 | |
781 @menu | |
782 * Unconditional Replace:: Replacing all matches for a string. | |
783 * Regexp Replace:: Replacing all matches for a regexp. | |
784 * Replacement and Case:: How replacements preserve case of letters. | |
785 * Query Replace:: How to use querying. | |
786 @end menu | |
787 | |
788 @node Unconditional Replace, Regexp Replace, Replace, Replace | |
789 @subsection Unconditional Replacement | |
790 @findex replace-string | |
791 @findex replace-regexp | |
792 | |
793 @table @kbd | |
794 @item M-x replace-string @key{RET} @var{string} @key{RET} @var{newstring} @key{RET} | |
795 Replace every occurrence of @var{string} with @var{newstring}. | |
796 @item M-x replace-regexp @key{RET} @var{regexp} @key{RET} @var{newstring} @key{RET} | |
797 Replace every match for @var{regexp} with @var{newstring}. | |
798 @end table | |
799 | |
800 To replace every instance of @samp{foo} after point with @samp{bar}, | |
801 use the command @kbd{M-x replace-string} with the two arguments | |
802 @samp{foo} and @samp{bar}. Replacement happens only in the text after | |
803 point, so if you want to cover the whole buffer you must go to the | |
804 beginning first. All occurrences up to the end of the buffer are | |
805 replaced; to limit replacement to part of the buffer, narrow to that | |
806 part of the buffer before doing the replacement (@pxref{Narrowing}). | |
807 In Transient Mark mode, when the region is active, replacement is | |
808 limited to the region (@pxref{Transient Mark}). | |
809 | |
810 When @code{replace-string} exits, it leaves point at the last | |
811 occurrence replaced. It sets the mark to the prior position of point | |
812 (where the @code{replace-string} command was issued); use @kbd{C-u | |
813 C-@key{SPC}} to move back there. | |
814 | |
815 A numeric argument restricts replacement to matches that are surrounded | |
816 by word boundaries. The argument's value doesn't matter. | |
817 | |
818 @node Regexp Replace, Replacement and Case, Unconditional Replace, Replace | |
819 @subsection Regexp Replacement | |
820 | |
821 The @kbd{M-x replace-string} command replaces exact matches for a | |
822 single string. The similar command @kbd{M-x replace-regexp} replaces | |
823 any match for a specified pattern. | |
824 | |
825 In @code{replace-regexp}, the @var{newstring} need not be constant: it | |
826 can refer to all or part of what is matched by the @var{regexp}. | |
827 @samp{\&} in @var{newstring} stands for the entire match being replaced. | |
828 @samp{\@var{d}} in @var{newstring}, where @var{d} is a digit, stands for | |
829 whatever matched the @var{d}th parenthesized grouping in @var{regexp}. | |
830 To include a @samp{\} in the text to replace with, you must enter | |
831 @samp{\\}. For example, | |
832 | |
833 @example | |
834 M-x replace-regexp @key{RET} c[ad]+r @key{RET} \&-safe @key{RET} | |
835 @end example | |
836 | |
837 @noindent | |
838 replaces (for example) @samp{cadr} with @samp{cadr-safe} and @samp{cddr} | |
839 with @samp{cddr-safe}. | |
840 | |
841 @example | |
842 M-x replace-regexp @key{RET} \(c[ad]+r\)-safe @key{RET} \1 @key{RET} | |
843 @end example | |
844 | |
845 @noindent | |
846 performs the inverse transformation. | |
847 | |
848 @node Replacement and Case, Query Replace, Regexp Replace, Replace | |
849 @subsection Replace Commands and Case | |
850 | |
851 If the first argument of a replace command is all lower case, the | |
852 commands ignores case while searching for occurrences to | |
853 replace---provided @code{case-fold-search} is non-@code{nil}. If | |
854 @code{case-fold-search} is set to @code{nil}, case is always significant | |
855 in all searches. | |
856 | |
857 @vindex case-replace | |
858 In addition, when the @var{newstring} argument is all or partly lower | |
859 case, replacement commands try to preserve the case pattern of each | |
860 occurrence. Thus, the command | |
861 | |
862 @example | |
863 M-x replace-string @key{RET} foo @key{RET} bar @key{RET} | |
864 @end example | |
865 | |
866 @noindent | |
867 replaces a lower case @samp{foo} with a lower case @samp{bar}, an | |
868 all-caps @samp{FOO} with @samp{BAR}, and a capitalized @samp{Foo} with | |
869 @samp{Bar}. (These three alternatives---lower case, all caps, and | |
870 capitalized, are the only ones that @code{replace-string} can | |
871 distinguish.) | |
872 | |
873 If upper-case letters are used in the replacement string, they remain | |
874 upper case every time that text is inserted. If upper-case letters are | |
875 used in the first argument, the second argument is always substituted | |
876 exactly as given, with no case conversion. Likewise, if either | |
877 @code{case-replace} or @code{case-fold-search} is set to @code{nil}, | |
878 replacement is done without case conversion. | |
879 | |
880 @node Query Replace,, Replacement and Case, Replace | |
881 @subsection Query Replace | |
882 @cindex query replace | |
883 | |
884 @table @kbd | |
885 @item M-% @var{string} @key{RET} @var{newstring} @key{RET} | |
886 @itemx M-x query-replace @key{RET} @var{string} @key{RET} @var{newstring} @key{RET} | |
887 Replace some occurrences of @var{string} with @var{newstring}. | |
888 @item C-M-% @var{regexp} @key{RET} @var{newstring} @key{RET} | |
889 @itemx M-x query-replace-regexp @key{RET} @var{regexp} @key{RET} @var{newstring} @key{RET} | |
890 Replace some matches for @var{regexp} with @var{newstring}. | |
891 @end table | |
892 | |
893 @kindex M-% | |
894 @findex query-replace | |
895 If you want to change only some of the occurrences of @samp{foo} to | |
896 @samp{bar}, not all of them, then you cannot use an ordinary | |
897 @code{replace-string}. Instead, use @kbd{M-%} (@code{query-replace}). | |
898 This command finds occurrences of @samp{foo} one by one, displays each | |
899 occurrence and asks you whether to replace it. A numeric argument to | |
900 @code{query-replace} tells it to consider only occurrences that are | |
901 bounded by word-delimiter characters. This preserves case, just like | |
902 @code{replace-string}, provided @code{case-replace} is non-@code{nil}, | |
903 as it normally is. | |
904 | |
905 @kindex C-M-% | |
906 @findex query-replace-regexp | |
907 Aside from querying, @code{query-replace} works just like | |
908 @code{replace-string}, and @code{query-replace-regexp} works just like | |
909 @code{replace-regexp}. This command is run by @kbd{C-M-%}. | |
910 | |
911 The things you can type when you are shown an occurrence of @var{string} | |
912 or a match for @var{regexp} are: | |
913 | |
914 @ignore @c Not worth it. | |
915 @kindex SPC @r{(query-replace)} | |
916 @kindex DEL @r{(query-replace)} | |
917 @kindex , @r{(query-replace)} | |
918 @kindex RET @r{(query-replace)} | |
919 @kindex . @r{(query-replace)} | |
920 @kindex ! @r{(query-replace)} | |
921 @kindex ^ @r{(query-replace)} | |
922 @kindex C-r @r{(query-replace)} | |
923 @kindex C-w @r{(query-replace)} | |
924 @kindex C-l @r{(query-replace)} | |
925 @end ignore | |
926 | |
927 @c WideCommands | |
928 @table @kbd | |
929 @item @key{SPC} | |
930 to replace the occurrence with @var{newstring}. | |
931 | |
932 @item @key{DEL} | |
933 to skip to the next occurrence without replacing this one. | |
934 | |
935 @item , @r{(Comma)} | |
936 to replace this occurrence and display the result. You are then asked | |
937 for another input character to say what to do next. Since the | |
938 replacement has already been made, @key{DEL} and @key{SPC} are | |
939 equivalent in this situation; both move to the next occurrence. | |
940 | |
941 You can type @kbd{C-r} at this point (see below) to alter the replaced | |
942 text. You can also type @kbd{C-x u} to undo the replacement; this exits | |
943 the @code{query-replace}, so if you want to do further replacement you | |
944 must use @kbd{C-x @key{ESC} @key{ESC} @key{RET}} to restart | |
945 (@pxref{Repetition}). | |
946 | |
947 @item @key{RET} | |
948 to exit without doing any more replacements. | |
949 | |
950 @item .@: @r{(Period)} | |
951 to replace this occurrence and then exit without searching for more | |
952 occurrences. | |
953 | |
954 @item ! | |
955 to replace all remaining occurrences without asking again. | |
956 | |
957 @item ^ | |
958 to go back to the position of the previous occurrence (or what used to | |
959 be an occurrence), in case you changed it by mistake. This works by | |
960 popping the mark ring. Only one @kbd{^} in a row is meaningful, because | |
961 only one previous replacement position is kept during @code{query-replace}. | |
962 | |
963 @item C-r | |
964 to enter a recursive editing level, in case the occurrence needs to be | |
965 edited rather than just replaced with @var{newstring}. When you are | |
966 done, exit the recursive editing level with @kbd{C-M-c} to proceed to | |
967 the next occurrence. @xref{Recursive Edit}. | |
968 | |
969 @item C-w | |
970 to delete the occurrence, and then enter a recursive editing level as in | |
971 @kbd{C-r}. Use the recursive edit to insert text to replace the deleted | |
972 occurrence of @var{string}. When done, exit the recursive editing level | |
973 with @kbd{C-M-c} to proceed to the next occurrence. | |
974 | |
975 @item C-l | |
976 to redisplay the screen. Then you must type another character to | |
977 specify what to do with this occurrence. | |
978 | |
31048
65af0f27a892
Document the new `e' command inside query-replace.
Eli Zaretskii <eliz@gnu.org>
parents:
28447
diff
changeset
|
979 @item e |
65af0f27a892
Document the new `e' command inside query-replace.
Eli Zaretskii <eliz@gnu.org>
parents:
28447
diff
changeset
|
980 to let you edit the replacement string. |
65af0f27a892
Document the new `e' command inside query-replace.
Eli Zaretskii <eliz@gnu.org>
parents:
28447
diff
changeset
|
981 |
25829 | 982 @item C-h |
983 to display a message summarizing these options. Then you must type | |
984 another character to specify what to do with this occurrence. | |
985 @end table | |
986 | |
987 Some other characters are aliases for the ones listed above: @kbd{y}, | |
988 @kbd{n} and @kbd{q} are equivalent to @key{SPC}, @key{DEL} and | |
989 @key{RET}. | |
990 | |
991 Aside from this, any other character exits the @code{query-replace}, | |
992 and is then reread as part of a key sequence. Thus, if you type | |
993 @kbd{C-k}, it exits the @code{query-replace} and then kills to end of | |
994 line. | |
995 | |
996 To restart a @code{query-replace} once it is exited, use @kbd{C-x | |
997 @key{ESC} @key{ESC}}, which repeats the @code{query-replace} because it | |
998 used the minibuffer to read its arguments. @xref{Repetition, C-x ESC | |
999 ESC}. | |
1000 | |
1001 See also @ref{Transforming File Names}, for Dired commands to rename, | |
1002 copy, or link files by replacing regexp matches in file names. | |
1003 | |
1004 @node Other Repeating Search,, Replace, Search | |
1005 @section Other Search-and-Loop Commands | |
1006 | |
1007 Here are some other commands that find matches for a regular | |
1008 expression. They all operate from point to the end of the buffer, and | |
1009 all ignore case in matching, if the pattern contains no upper-case | |
1010 letters and @code{case-fold-search} is non-@code{nil}. | |
1011 | |
1012 @findex list-matching-lines | |
1013 @findex occur | |
32035
396b07cf1395
(Other Repeating Search): Describe `how-many'
Gerd Moellmann <gerd@gnu.org>
parents:
31072
diff
changeset
|
1014 @findex how-many |
25829 | 1015 @findex delete-non-matching-lines |
1016 @findex delete-matching-lines | |
1017 @findex flush-lines | |
1018 @findex keep-lines | |
1019 | |
1020 @table @kbd | |
1021 @item M-x occur @key{RET} @var{regexp} @key{RET} | |
1022 Display a list showing each line in the buffer that contains a match for | |
1023 @var{regexp}. A numeric argument specifies the number of context lines | |
1024 to print before and after each matching line; the default is none. | |
1025 To limit the search to part of the buffer, narrow to that part | |
1026 (@pxref{Narrowing}). | |
1027 | |
1028 @kindex RET @r{(Occur mode)} | |
1029 The buffer @samp{*Occur*} containing the output serves as a menu for | |
1030 finding the occurrences in their original context. Click @kbd{Mouse-2} | |
1031 on an occurrence listed in @samp{*Occur*}, or position point there and | |
1032 type @key{RET}; this switches to the buffer that was searched and | |
1033 moves point to the original of the chosen occurrence. | |
1034 | |
1035 @item M-x list-matching-lines | |
1036 Synonym for @kbd{M-x occur}. | |
1037 | |
32035
396b07cf1395
(Other Repeating Search): Describe `how-many'
Gerd Moellmann <gerd@gnu.org>
parents:
31072
diff
changeset
|
1038 @item M-x how-many @key{RET} @var{regexp} @key{RET} |
396b07cf1395
(Other Repeating Search): Describe `how-many'
Gerd Moellmann <gerd@gnu.org>
parents:
31072
diff
changeset
|
1039 Print the number of matches for @var{regexp} after point, or in the |
396b07cf1395
(Other Repeating Search): Describe `how-many'
Gerd Moellmann <gerd@gnu.org>
parents:
31072
diff
changeset
|
1040 active region in Transient Mark mode. |
25829 | 1041 |
1042 @item M-x flush-lines @key{RET} @var{regexp} @key{RET} | |
32035
396b07cf1395
(Other Repeating Search): Describe `how-many'
Gerd Moellmann <gerd@gnu.org>
parents:
31072
diff
changeset
|
1043 Delete each line after point, or in the active region in Transient Mark |
396b07cf1395
(Other Repeating Search): Describe `how-many'
Gerd Moellmann <gerd@gnu.org>
parents:
31072
diff
changeset
|
1044 mode, that contains a match for @var{regexp}. |
25829 | 1045 |
1046 @item M-x keep-lines @key{RET} @var{regexp} @key{RET} | |
32035
396b07cf1395
(Other Repeating Search): Describe `how-many'
Gerd Moellmann <gerd@gnu.org>
parents:
31072
diff
changeset
|
1047 Delete each line that follows point, or is in the active region in |
396b07cf1395
(Other Repeating Search): Describe `how-many'
Gerd Moellmann <gerd@gnu.org>
parents:
31072
diff
changeset
|
1048 Transient Mark mode, and @emph{does not} contain a match for |
396b07cf1395
(Other Repeating Search): Describe `how-many'
Gerd Moellmann <gerd@gnu.org>
parents:
31072
diff
changeset
|
1049 @var{regexp}. |
25829 | 1050 @end table |
1051 | |
28447
ec699636f83a
(Other Repeating Search): Mention tags-based search.
Dave Love <fx@gnu.org>
parents:
28134
diff
changeset
|
1052 Searching and replacing can be performed under the control of tags |
ec699636f83a
(Other Repeating Search): Mention tags-based search.
Dave Love <fx@gnu.org>
parents:
28134
diff
changeset
|
1053 files (@pxref{Tags Search}) and Dired (@pxref{Operating on Files}). |
ec699636f83a
(Other Repeating Search): Mention tags-based search.
Dave Love <fx@gnu.org>
parents:
28134
diff
changeset
|
1054 |
25829 | 1055 In addition, you can use @code{grep} from Emacs to search a collection |
1056 of files for matches for a regular expression, then visit the matches | |
1057 either sequentially or in arbitrary order. @xref{Grep Searching}. |