Mercurial > emacs
annotate man/search.texi @ 59493:0b8e17ea69db
(Beeping): Fix Texinfo usage.
author | Richard M. Stallman <rms@gnu.org> |
---|---|
date | Wed, 12 Jan 2005 05:11:56 +0000 |
parents | 856e8ee31fcb |
children | c218b809efea cb67264d6096 |
rev | line source |
---|---|
25829 | 1 @c This is part of the Emacs manual. |
58434
b458d6bca4fe
*** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
57382
diff
changeset
|
2 @c Copyright (C) 1985, 1986, 1987, 1993, 1994, 1995, 1997, 2000, 2001, 2004 |
28126 | 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 | |
38127
eb0f8509d107
Rewrite the texts that explain basic incremental search,
Richard M. Stallman <rms@gnu.org>
parents:
38049
diff
changeset
|
17 occurrences of one string and replaces them with another, Emacs has a |
eb0f8509d107
Rewrite the texts that explain basic incremental search,
Richard M. Stallman <rms@gnu.org>
parents:
38049
diff
changeset
|
18 more flexible replacement command called @code{query-replace}, which |
eb0f8509d107
Rewrite the texts that explain basic incremental search,
Richard M. Stallman <rms@gnu.org>
parents:
38049
diff
changeset
|
19 asks interactively which occurrences to replace. |
25829 | 20 |
21 @menu | |
52968
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
22 * Incremental Search:: Search happens as you type the string. |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
23 * Nonincremental Search:: Specify entire string and then search. |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
24 * Word Search:: Search for sequence of words. |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
25 * Regexp Search:: Search for match for a regexp. |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
26 * Regexps:: Syntax of regular expressions. |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
27 * Search Case:: To ignore case while searching, or not. |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
28 * Configuring Scrolling:: Scrolling within incremental search. |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
29 * Replace:: Search, and replace some or all matches. |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
30 * Other Repeating Search:: Operating on all matches for some regexp. |
25829 | 31 @end menu |
32 | |
33 @node Incremental Search, Nonincremental Search, Search, Search | |
34 @section Incremental Search | |
35 | |
36 @cindex incremental search | |
37 An incremental search begins searching as soon as you type the first | |
38 character of the search string. As you type in the search string, Emacs | |
39 shows you where the string (as you have typed it so far) would be | |
40 found. When you have typed enough characters to identify the place you | |
41 want, you can stop. Depending on what you plan to do next, you may or | |
42 may not need to terminate the search explicitly with @key{RET}. | |
43 | |
44 @c WideCommands | |
45 @table @kbd | |
46 @item C-s | |
47 Incremental search forward (@code{isearch-forward}). | |
48 @item C-r | |
49 Incremental search backward (@code{isearch-backward}). | |
50 @end table | |
51 | |
52 @kindex C-s | |
53 @findex isearch-forward | |
38127
eb0f8509d107
Rewrite the texts that explain basic incremental search,
Richard M. Stallman <rms@gnu.org>
parents:
38049
diff
changeset
|
54 @kbd{C-s} starts a forward incremental search. It reads characters |
eb0f8509d107
Rewrite the texts that explain basic incremental search,
Richard M. Stallman <rms@gnu.org>
parents:
38049
diff
changeset
|
55 from the keyboard, and moves point past the next occurrence of those |
eb0f8509d107
Rewrite the texts that explain basic incremental search,
Richard M. Stallman <rms@gnu.org>
parents:
38049
diff
changeset
|
56 characters. If you type @kbd{C-s} and then @kbd{F}, that puts the |
38880 | 57 cursor after the first @samp{F} (the first following the starting point, since |
38127
eb0f8509d107
Rewrite the texts that explain basic incremental search,
Richard M. Stallman <rms@gnu.org>
parents:
38049
diff
changeset
|
58 this is a forward search). Then if you type an @kbd{O}, you will see |
eb0f8509d107
Rewrite the texts that explain basic incremental search,
Richard M. Stallman <rms@gnu.org>
parents:
38049
diff
changeset
|
59 the cursor move just after the first @samp{FO} (the @samp{F} in that |
eb0f8509d107
Rewrite the texts that explain basic incremental search,
Richard M. Stallman <rms@gnu.org>
parents:
38049
diff
changeset
|
60 @samp{FO} may or may not be the first @samp{F}). After another |
eb0f8509d107
Rewrite the texts that explain basic incremental search,
Richard M. Stallman <rms@gnu.org>
parents:
38049
diff
changeset
|
61 @kbd{O}, the cursor moves after the first @samp{FOO} after the place |
eb0f8509d107
Rewrite the texts that explain basic incremental search,
Richard M. Stallman <rms@gnu.org>
parents:
38049
diff
changeset
|
62 where you started the search. At each step, the buffer text that |
eb0f8509d107
Rewrite the texts that explain basic incremental search,
Richard M. Stallman <rms@gnu.org>
parents:
38049
diff
changeset
|
63 matches the search string is highlighted, if the terminal can do that; |
eb0f8509d107
Rewrite the texts that explain basic incremental search,
Richard M. Stallman <rms@gnu.org>
parents:
38049
diff
changeset
|
64 the current search string is always displayed in the echo area. |
25829 | 65 |
66 If you make a mistake in typing the search string, you can cancel | |
67 characters with @key{DEL}. Each @key{DEL} cancels the last character of | |
68 search string. This does not happen until Emacs is ready to read another | |
69 input character; first it must either find, or fail to find, the character | |
70 you want to erase. If you do not want to wait for this to happen, use | |
71 @kbd{C-g} as described below. | |
72 | |
73 When you are satisfied with the place you have reached, you can type | |
74 @key{RET}, which stops searching, leaving the cursor where the search | |
75 brought it. Also, any command not specially meaningful in searches | |
37235
a60e4b9d5ba3
Mention there are other search-terminating Meta chars.
Richard M. Stallman <rms@gnu.org>
parents:
37069
diff
changeset
|
76 stops the searching and is then executed. Thus, typing @kbd{C-a} |
a60e4b9d5ba3
Mention there are other search-terminating Meta chars.
Richard M. Stallman <rms@gnu.org>
parents:
37069
diff
changeset
|
77 would exit the search and then move to the beginning of the line. |
a60e4b9d5ba3
Mention there are other search-terminating Meta chars.
Richard M. Stallman <rms@gnu.org>
parents:
37069
diff
changeset
|
78 @key{RET} is necessary only if the next command you want to type is a |
a60e4b9d5ba3
Mention there are other search-terminating Meta chars.
Richard M. Stallman <rms@gnu.org>
parents:
37069
diff
changeset
|
79 printing character, @key{DEL}, @key{RET}, or another character that is |
25829 | 80 special within searches (@kbd{C-q}, @kbd{C-w}, @kbd{C-r}, @kbd{C-s}, |
56306
f8704be4375b
(Incremental Search): Add C-M-w, C-M-y, M-%, C-M-%, M-e.
Juri Linkov <juri@jurta.org>
parents:
56279
diff
changeset
|
81 @kbd{C-y}, @kbd{M-y}, @kbd{M-r}, @kbd{M-c}, @kbd{M-e}, and some other |
37235
a60e4b9d5ba3
Mention there are other search-terminating Meta chars.
Richard M. Stallman <rms@gnu.org>
parents:
37069
diff
changeset
|
82 meta-characters). |
25829 | 83 |
38127
eb0f8509d107
Rewrite the texts that explain basic incremental search,
Richard M. Stallman <rms@gnu.org>
parents:
38049
diff
changeset
|
84 Sometimes you search for @samp{FOO} and find one, but not the one you |
36177
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
85 expected to find. There was a second @samp{FOO} that you forgot |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
86 about, before the one you were aiming for. In this event, type |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
87 another @kbd{C-s} to move to the next occurrence of the search string. |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
88 You can repeat this any number of times. If you overshoot, you can |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
89 cancel some @kbd{C-s} characters with @key{DEL}. |
25829 | 90 |
91 After you exit a search, you can search for the same string again by | |
92 typing just @kbd{C-s C-s}: the first @kbd{C-s} is the key that invokes | |
93 incremental search, and the second @kbd{C-s} means ``search again.'' | |
94 | |
95 To reuse earlier search strings, use the @dfn{search ring}. The | |
96 commands @kbd{M-p} and @kbd{M-n} move through the ring to pick a search | |
97 string to reuse. These commands leave the selected search ring element | |
56306
f8704be4375b
(Incremental Search): Add C-M-w, C-M-y, M-%, C-M-%, M-e.
Juri Linkov <juri@jurta.org>
parents:
56279
diff
changeset
|
98 in the minibuffer, where you can edit it. To edit the current search |
f8704be4375b
(Incremental Search): Add C-M-w, C-M-y, M-%, C-M-%, M-e.
Juri Linkov <juri@jurta.org>
parents:
56279
diff
changeset
|
99 string in the minibuffer without replacing it with items from the |
f8704be4375b
(Incremental Search): Add C-M-w, C-M-y, M-%, C-M-%, M-e.
Juri Linkov <juri@jurta.org>
parents:
56279
diff
changeset
|
100 search ring, type @kbd{M-e}. Type @kbd{C-s} or @kbd{C-r} |
25829 | 101 to terminate editing the string and search for it. |
102 | |
103 If your string is not found at all, the echo area says @samp{Failing | |
104 I-Search}. The cursor is after the place where Emacs found as much of your | |
105 string as it could. Thus, if you search for @samp{FOOT}, and there is no | |
106 @samp{FOOT}, you might see the cursor after the @samp{FOO} in @samp{FOOL}. | |
107 At this point there are several things you can do. If your string was | |
108 mistyped, you can rub some of it out and correct it. If you like the place | |
109 you have found, you can type @key{RET} or some other Emacs command to | |
38127
eb0f8509d107
Rewrite the texts that explain basic incremental search,
Richard M. Stallman <rms@gnu.org>
parents:
38049
diff
changeset
|
110 remain there. Or you can type @kbd{C-g}, which |
25829 | 111 removes from the search string the characters that could not be found (the |
112 @samp{T} in @samp{FOOT}), leaving those that were found (the @samp{FOO} in | |
113 @samp{FOOT}). A second @kbd{C-g} at that point cancels the search | |
114 entirely, returning point to where it was when the search started. | |
115 | |
116 An upper-case letter in the search string makes the search | |
117 case-sensitive. If you delete the upper-case character from the search | |
118 string, it ceases to have this effect. @xref{Search Case}. | |
119 | |
36177
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
120 To search for a newline, type @kbd{C-j}. To search for another |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
121 control character, such as control-S or carriage return, you must quote |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
122 it by typing @kbd{C-q} first. This function of @kbd{C-q} is analogous |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
123 to its use for insertion (@pxref{Inserting Text}): it causes the |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
124 following character to be treated the way any ``ordinary'' character is |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
125 treated in the same context. You can also specify a character by its |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
126 octal code: enter @kbd{C-q} followed by a sequence of octal digits. |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
127 |
52979
3649390c0f91
Replace @sc{ascii} and ASCII with @acronym{ASCII}.
Eli Zaretskii <eliz@gnu.org>
parents:
52968
diff
changeset
|
128 @cindex searching for non-@acronym{ASCII} characters |
35904
250691f20cec
(Incremental Search): Document C-\ and C-^.
Eli Zaretskii <eliz@gnu.org>
parents:
35876
diff
changeset
|
129 @cindex input method, during incremental search |
52979
3649390c0f91
Replace @sc{ascii} and ASCII with @acronym{ASCII}.
Eli Zaretskii <eliz@gnu.org>
parents:
52968
diff
changeset
|
130 To search for non-@acronym{ASCII} characters, you must use an input method |
38880 | 131 (@pxref{Input Methods}). If an input method is enabled in the |
36177
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
132 current buffer when you start the search, you can use it while you |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
133 type the search string also. Emacs indicates that by including the |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
134 input method mnemonic in its prompt, like this: |
35904
250691f20cec
(Incremental Search): Document C-\ and C-^.
Eli Zaretskii <eliz@gnu.org>
parents:
35876
diff
changeset
|
135 |
250691f20cec
(Incremental Search): Document C-\ and C-^.
Eli Zaretskii <eliz@gnu.org>
parents:
35876
diff
changeset
|
136 @example |
36177
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
137 I-search [@var{im}]: |
35904
250691f20cec
(Incremental Search): Document C-\ and C-^.
Eli Zaretskii <eliz@gnu.org>
parents:
35876
diff
changeset
|
138 @end example |
250691f20cec
(Incremental Search): Document C-\ and C-^.
Eli Zaretskii <eliz@gnu.org>
parents:
35876
diff
changeset
|
139 |
250691f20cec
(Incremental Search): Document C-\ and C-^.
Eli Zaretskii <eliz@gnu.org>
parents:
35876
diff
changeset
|
140 @noindent |
250691f20cec
(Incremental Search): Document C-\ and C-^.
Eli Zaretskii <eliz@gnu.org>
parents:
35876
diff
changeset
|
141 @findex isearch-toggle-input-method |
250691f20cec
(Incremental Search): Document C-\ and C-^.
Eli Zaretskii <eliz@gnu.org>
parents:
35876
diff
changeset
|
142 @findex isearch-toggle-specified-input-method |
250691f20cec
(Incremental Search): Document C-\ and C-^.
Eli Zaretskii <eliz@gnu.org>
parents:
35876
diff
changeset
|
143 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
|
144 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
|
145 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
|
146 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
|
147 (@code{isearch-toggle-specified-input-method}), which prompts for the |
38880 | 148 name of the input method. The input method you enable during |
149 incremental search remains enabled in the current buffer afterwards. | |
35904
250691f20cec
(Incremental Search): Document C-\ and C-^.
Eli Zaretskii <eliz@gnu.org>
parents:
35876
diff
changeset
|
150 |
25829 | 151 If a search is failing and you ask to repeat it by typing another |
36177
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
152 @kbd{C-s}, it starts again from the beginning of the buffer. |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
153 Repeating a failing reverse search with @kbd{C-r} starts again from |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
154 the end. This is called @dfn{wrapping around}, and @samp{Wrapped} |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
155 appears in the search prompt once this has happened. If you keep on |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
156 going past the original starting point of the search, it changes to |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
157 @samp{Overwrapped}, which means that you are revisiting matches that |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
158 you have already seen. |
25829 | 159 |
160 @cindex quitting (in search) | |
161 The @kbd{C-g} ``quit'' character does special things during searches; | |
162 just what it does depends on the status of the search. If the search has | |
163 found what you specified and is waiting for input, @kbd{C-g} cancels the | |
164 entire search. The cursor moves back to where you started the search. If | |
165 @kbd{C-g} is typed when there are characters in the search string that have | |
166 not been found---because Emacs is still searching for them, or because it | |
167 has failed to find them---then the search string characters which have not | |
168 been found are discarded from the search string. With them gone, the | |
169 search is now successful and waiting for more input, so a second @kbd{C-g} | |
170 will cancel the entire search. | |
171 | |
172 You can change to searching backwards with @kbd{C-r}. If a search fails | |
173 because the place you started was too late in the file, you should do this. | |
174 Repeated @kbd{C-r} keeps looking for more occurrences backwards. A | |
175 @kbd{C-s} starts going forwards again. @kbd{C-r} in a search can be canceled | |
176 with @key{DEL}. | |
177 | |
178 @kindex C-r | |
179 @findex isearch-backward | |
180 If you know initially that you want to search backwards, you can use | |
181 @kbd{C-r} instead of @kbd{C-s} to start the search, because @kbd{C-r} as | |
182 a key runs a command (@code{isearch-backward}) to search backward. A | |
183 backward search finds matches that are entirely before the starting | |
184 point, just as a forward search finds matches that begin after it. | |
185 | |
56306
f8704be4375b
(Incremental Search): Add C-M-w, C-M-y, M-%, C-M-%, M-e.
Juri Linkov <juri@jurta.org>
parents:
56279
diff
changeset
|
186 The characters @kbd{C-w} and @kbd{C-y} can be used in incremental |
46242
5681198aa760
C-w sometimes grabs just one character.
Richard M. Stallman <rms@gnu.org>
parents:
46213
diff
changeset
|
187 search to grab text from the buffer into the search string. This |
5681198aa760
C-w sometimes grabs just one character.
Richard M. Stallman <rms@gnu.org>
parents:
46213
diff
changeset
|
188 makes it convenient to search for another occurrence of text at point. |
5681198aa760
C-w sometimes grabs just one character.
Richard M. Stallman <rms@gnu.org>
parents:
46213
diff
changeset
|
189 @kbd{C-w} copies the character or word after point as part of the |
5681198aa760
C-w sometimes grabs just one character.
Richard M. Stallman <rms@gnu.org>
parents:
46213
diff
changeset
|
190 search string, advancing point over it. (The decision, whether to |
5681198aa760
C-w sometimes grabs just one character.
Richard M. Stallman <rms@gnu.org>
parents:
46213
diff
changeset
|
191 copy a character or a word, is heuristic.) Another @kbd{C-s} to |
5681198aa760
C-w sometimes grabs just one character.
Richard M. Stallman <rms@gnu.org>
parents:
46213
diff
changeset
|
192 repeat the search will then search for a string including that |
5681198aa760
C-w sometimes grabs just one character.
Richard M. Stallman <rms@gnu.org>
parents:
46213
diff
changeset
|
193 character or word. |
5681198aa760
C-w sometimes grabs just one character.
Richard M. Stallman <rms@gnu.org>
parents:
46213
diff
changeset
|
194 |
5681198aa760
C-w sometimes grabs just one character.
Richard M. Stallman <rms@gnu.org>
parents:
46213
diff
changeset
|
195 @kbd{C-y} is similar to @kbd{C-w} but copies all the rest of the |
57382
2ad6f5610930
Update the documentation of C-y in the case that point is already at the
Eli Zaretskii <eliz@gnu.org>
parents:
57374
diff
changeset
|
196 current line into the search string. If point is already at the end |
2ad6f5610930
Update the documentation of C-y in the case that point is already at the
Eli Zaretskii <eliz@gnu.org>
parents:
57374
diff
changeset
|
197 of a line, it grabs the entire next line. Both @kbd{C-y} and |
2ad6f5610930
Update the documentation of C-y in the case that point is already at the
Eli Zaretskii <eliz@gnu.org>
parents:
57374
diff
changeset
|
198 @kbd{C-w} convert the text they copy to lower case if the search is |
2ad6f5610930
Update the documentation of C-y in the case that point is already at the
Eli Zaretskii <eliz@gnu.org>
parents:
57374
diff
changeset
|
199 currently not case-sensitive; this is so the search remains |
2ad6f5610930
Update the documentation of C-y in the case that point is already at the
Eli Zaretskii <eliz@gnu.org>
parents:
57374
diff
changeset
|
200 case-insensitive. |
25829 | 201 |
56306
f8704be4375b
(Incremental Search): Add C-M-w, C-M-y, M-%, C-M-%, M-e.
Juri Linkov <juri@jurta.org>
parents:
56279
diff
changeset
|
202 @kbd{C-M-w} and @kbd{C-M-y} modify the search string by only one |
f8704be4375b
(Incremental Search): Add C-M-w, C-M-y, M-%, C-M-%, M-e.
Juri Linkov <juri@jurta.org>
parents:
56279
diff
changeset
|
203 character at a time: @kbd{C-M-w} deletes the last character from the |
f8704be4375b
(Incremental Search): Add C-M-w, C-M-y, M-%, C-M-%, M-e.
Juri Linkov <juri@jurta.org>
parents:
56279
diff
changeset
|
204 search string and @kbd{C-M-y} copies the character after point to the |
f8704be4375b
(Incremental Search): Add C-M-w, C-M-y, M-%, C-M-%, M-e.
Juri Linkov <juri@jurta.org>
parents:
56279
diff
changeset
|
205 end of the search string. An alternative method to add the character |
f8704be4375b
(Incremental Search): Add C-M-w, C-M-y, M-%, C-M-%, M-e.
Juri Linkov <juri@jurta.org>
parents:
56279
diff
changeset
|
206 after point into the search string is to enter the minibuffer by |
f8704be4375b
(Incremental Search): Add C-M-w, C-M-y, M-%, C-M-%, M-e.
Juri Linkov <juri@jurta.org>
parents:
56279
diff
changeset
|
207 @kbd{M-e} and to type @kbd{C-f} at the end of the search string in the |
f8704be4375b
(Incremental Search): Add C-M-w, C-M-y, M-%, C-M-%, M-e.
Juri Linkov <juri@jurta.org>
parents:
56279
diff
changeset
|
208 minibuffer. |
f8704be4375b
(Incremental Search): Add C-M-w, C-M-y, M-%, C-M-%, M-e.
Juri Linkov <juri@jurta.org>
parents:
56279
diff
changeset
|
209 |
25829 | 210 The character @kbd{M-y} copies text from the kill ring into the search |
211 string. It uses the same text that @kbd{C-y} as a command would yank. | |
36177
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
212 @kbd{Mouse-2} in the echo area does the same. |
25829 | 213 @xref{Yanking}. |
214 | |
215 When you exit the incremental search, it sets the mark to where point | |
216 @emph{was}, before the search. That is convenient for moving back | |
217 there. In Transient Mark mode, incremental search sets the mark without | |
218 activating it, and does so only if the mark is not already active. | |
219 | |
56908
a139f4d21416
(Incremental Search): Update wording for M-%.
Juri Linkov <juri@jurta.org>
parents:
56874
diff
changeset
|
220 @kbd{M-%} typed in incremental search invokes @code{query-replace} |
a139f4d21416
(Incremental Search): Update wording for M-%.
Juri Linkov <juri@jurta.org>
parents:
56874
diff
changeset
|
221 or @code{query-replace-regexp} (depending on search mode) with the |
59428
856e8ee31fcb
(Query Replace): Mention faces query-replace and lazy-highlight.
Richard M. Stallman <rms@gnu.org>
parents:
58436
diff
changeset
|
222 current search string used as the string to replace. @xref{Query |
856e8ee31fcb
(Query Replace): Mention faces query-replace and lazy-highlight.
Richard M. Stallman <rms@gnu.org>
parents:
58436
diff
changeset
|
223 Replace}. |
56306
f8704be4375b
(Incremental Search): Add C-M-w, C-M-y, M-%, C-M-%, M-e.
Juri Linkov <juri@jurta.org>
parents:
56279
diff
changeset
|
224 |
27217 | 225 @cindex lazy search highlighting |
226 @vindex isearch-lazy-highlight | |
36177
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
227 When you pause for a little while during incremental search, it |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
228 highlights all other possible matches for the search string. This |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
229 makes it easier to anticipate where you can get to by typing @kbd{C-s} |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
230 or @kbd{C-r} to repeat the search. The short delay before highlighting |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
231 other matches helps indicate which match is the current one. |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
232 If you don't like this feature, you can turn it off by setting |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
233 @code{isearch-lazy-highlight} to @code{nil}. |
27217 | 234 |
31062
c503cf38b3e8
More details and index entries for isearch-lazy-highlight.
Eli Zaretskii <eliz@gnu.org>
parents:
31048
diff
changeset
|
235 @cindex faces for highlighting search matches |
38049
0ee6a3d3764e
Proofreading fixes friom Danny Colascione <qtmstr@optonline.net>.
Eli Zaretskii <eliz@gnu.org>
parents:
38016
diff
changeset
|
236 You can control how this highlighting looks by customizing the faces |
59428
856e8ee31fcb
(Query Replace): Mention faces query-replace and lazy-highlight.
Richard M. Stallman <rms@gnu.org>
parents:
58436
diff
changeset
|
237 @code{isearch} (used for the current match) and @code{lazy-highlight} |
856e8ee31fcb
(Query Replace): Mention faces query-replace and lazy-highlight.
Richard M. Stallman <rms@gnu.org>
parents:
58436
diff
changeset
|
238 (for all the other matches). The latter is also used for other matches |
856e8ee31fcb
(Query Replace): Mention faces query-replace and lazy-highlight.
Richard M. Stallman <rms@gnu.org>
parents:
58436
diff
changeset
|
239 inside @code{query-replace}. |
31062
c503cf38b3e8
More details and index entries for isearch-lazy-highlight.
Eli Zaretskii <eliz@gnu.org>
parents:
31048
diff
changeset
|
240 |
25829 | 241 @vindex isearch-mode-map |
242 To customize the special characters that incremental search understands, | |
243 alter their bindings in the keymap @code{isearch-mode-map}. For a list | |
244 of bindings, look at the documentation of @code{isearch-mode} with | |
245 @kbd{C-h f isearch-mode @key{RET}}. | |
246 | |
52968
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
247 @subsection Scrolling During Incremental Search |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
248 |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
249 Vertical scrolling during incremental search can be enabled by |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
250 setting the customizable variable @code{isearch-allow-scroll} to a |
56279
b1ae5333057a
* ses.texi, viper.texi, search.texi, flymake.texi, faq.texi:
Jesper Harder <harder@ifa.au.dk>
parents:
56251
diff
changeset
|
251 non-@code{nil} value. |
52968
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
252 |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
253 You can then use the vertical scroll-bar or certain keyboard |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
254 commands such as @kbd{@key{PRIOR}} (@code{scroll-down}), |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
255 @kbd{@key{NEXT}} (@code{scroll-up}) and @kbd{C-l} (@code{recenter}) |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
256 within the search, thus letting you see more of the text near the |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
257 current match. You must run these commands via their key sequences to |
56279
b1ae5333057a
* ses.texi, viper.texi, search.texi, flymake.texi, faq.texi:
Jesper Harder <harder@ifa.au.dk>
parents:
56251
diff
changeset
|
258 stay in the search---typing M-x @var{comand-name} will always |
52968
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
259 terminate a search. |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
260 |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
261 You can give prefix arguments to these commands in the usual way. |
56279
b1ae5333057a
* ses.texi, viper.texi, search.texi, flymake.texi, faq.texi:
Jesper Harder <harder@ifa.au.dk>
parents:
56251
diff
changeset
|
262 The current match cannot be scrolled out of the window---this is |
52968
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
263 intentional. |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
264 |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
265 Several other commands, such as @kbd{C-x 2} |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
266 (@code{split-window-vertically}) and @kbd{C-x ^} |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
267 (@code{enlarge-window}) which don't scroll the window, are |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
268 nevertheless made available under this rubric, since they are likewise |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
269 handy during a search. |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
270 |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
271 For a list of commands which are configured as scrolling commands by |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
272 default and instructions on how thus to configure other commands, see |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
273 @ref{Configuring Scrolling}. |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
274 |
25829 | 275 @subsection Slow Terminal Incremental Search |
276 | |
277 Incremental search on a slow terminal uses a modified style of display | |
278 that is designed to take less time. Instead of redisplaying the buffer at | |
279 each place the search gets to, it creates a new single-line window and uses | |
280 that to display the line that the search has found. The single-line window | |
38049
0ee6a3d3764e
Proofreading fixes friom Danny Colascione <qtmstr@optonline.net>.
Eli Zaretskii <eliz@gnu.org>
parents:
38016
diff
changeset
|
281 comes into play as soon as point moves outside of the text that is already |
25829 | 282 on the screen. |
283 | |
284 When you terminate the search, the single-line window is removed. | |
38049
0ee6a3d3764e
Proofreading fixes friom Danny Colascione <qtmstr@optonline.net>.
Eli Zaretskii <eliz@gnu.org>
parents:
38016
diff
changeset
|
285 Emacs then redisplays the window in which the search was done, to show |
25829 | 286 its new position of point. |
287 | |
288 @vindex search-slow-speed | |
289 The slow terminal style of display is used when the terminal baud rate is | |
290 less than or equal to the value of the variable @code{search-slow-speed}, | |
37235
a60e4b9d5ba3
Mention there are other search-terminating Meta chars.
Richard M. Stallman <rms@gnu.org>
parents:
37069
diff
changeset
|
291 initially 1200. See @code{baud-rate} in @ref{Display Custom}. |
25829 | 292 |
293 @vindex search-slow-window-lines | |
294 The number of lines to use in slow terminal search display is controlled | |
295 by the variable @code{search-slow-window-lines}. Its normal value is 1. | |
296 | |
297 @node Nonincremental Search, Word Search, Incremental Search, Search | |
298 @section Nonincremental Search | |
299 @cindex nonincremental search | |
300 | |
301 Emacs also has conventional nonincremental search commands, which require | |
302 you to type the entire search string before searching begins. | |
303 | |
304 @table @kbd | |
305 @item C-s @key{RET} @var{string} @key{RET} | |
306 Search for @var{string}. | |
307 @item C-r @key{RET} @var{string} @key{RET} | |
308 Search backward for @var{string}. | |
309 @end table | |
310 | |
311 To do a nonincremental search, first type @kbd{C-s @key{RET}}. This | |
312 enters the minibuffer to read the search string; terminate the string | |
313 with @key{RET}, and then the search takes place. If the string is not | |
38127
eb0f8509d107
Rewrite the texts that explain basic incremental search,
Richard M. Stallman <rms@gnu.org>
parents:
38049
diff
changeset
|
314 found, the search command signals an error. |
25829 | 315 |
38127
eb0f8509d107
Rewrite the texts that explain basic incremental search,
Richard M. Stallman <rms@gnu.org>
parents:
38049
diff
changeset
|
316 When you type @kbd{C-s @key{RET}}, the @kbd{C-s} invokes incremental |
eb0f8509d107
Rewrite the texts that explain basic incremental search,
Richard M. Stallman <rms@gnu.org>
parents:
38049
diff
changeset
|
317 search as usual. That command is specially programmed to invoke |
eb0f8509d107
Rewrite the texts that explain basic incremental search,
Richard M. Stallman <rms@gnu.org>
parents:
38049
diff
changeset
|
318 nonincremental search, @code{search-forward}, if the string you |
eb0f8509d107
Rewrite the texts that explain basic incremental search,
Richard M. Stallman <rms@gnu.org>
parents:
38049
diff
changeset
|
319 specify is empty. (Such an empty argument would otherwise be |
eb0f8509d107
Rewrite the texts that explain basic incremental search,
Richard M. Stallman <rms@gnu.org>
parents:
38049
diff
changeset
|
320 useless.) But it does not call @code{search-forward} right away. First |
eb0f8509d107
Rewrite the texts that explain basic incremental search,
Richard M. Stallman <rms@gnu.org>
parents:
38049
diff
changeset
|
321 it checks the next input character to see if is @kbd{C-w}, |
eb0f8509d107
Rewrite the texts that explain basic incremental search,
Richard M. Stallman <rms@gnu.org>
parents:
38049
diff
changeset
|
322 which specifies a word search. |
25829 | 323 @ifinfo |
324 @xref{Word Search}. | |
325 @end ifinfo | |
38127
eb0f8509d107
Rewrite the texts that explain basic incremental search,
Richard M. Stallman <rms@gnu.org>
parents:
38049
diff
changeset
|
326 @kbd{C-r @key{RET}} does likewise, for a reverse incremental search. |
25829 | 327 |
328 @findex search-forward | |
329 @findex search-backward | |
330 Forward and backward nonincremental searches are implemented by the | |
331 commands @code{search-forward} and @code{search-backward}. These | |
332 commands may be bound to keys in the usual manner. The feature that you | |
333 can get to them via the incremental search commands exists for | |
38127
eb0f8509d107
Rewrite the texts that explain basic incremental search,
Richard M. Stallman <rms@gnu.org>
parents:
38049
diff
changeset
|
334 historical reasons, and to avoid the need to find key sequences |
25829 | 335 for them. |
336 | |
337 @node Word Search, Regexp Search, Nonincremental Search, Search | |
338 @section Word Search | |
339 @cindex word search | |
340 | |
341 Word search searches for a sequence of words without regard to how the | |
342 words are separated. More precisely, you type a string of many words, | |
38049
0ee6a3d3764e
Proofreading fixes friom Danny Colascione <qtmstr@optonline.net>.
Eli Zaretskii <eliz@gnu.org>
parents:
38016
diff
changeset
|
343 using single spaces to separate them, and the string can be found even |
0ee6a3d3764e
Proofreading fixes friom Danny Colascione <qtmstr@optonline.net>.
Eli Zaretskii <eliz@gnu.org>
parents:
38016
diff
changeset
|
344 if there are multiple spaces, newlines, or other punctuation characters |
0ee6a3d3764e
Proofreading fixes friom Danny Colascione <qtmstr@optonline.net>.
Eli Zaretskii <eliz@gnu.org>
parents:
38016
diff
changeset
|
345 between these words. |
25829 | 346 |
347 Word search is useful for editing a printed document made with a text | |
348 formatter. If you edit while looking at the printed, formatted version, | |
349 you can't tell where the line breaks are in the source file. With word | |
350 search, you can search without having to know them. | |
351 | |
352 @table @kbd | |
353 @item C-s @key{RET} C-w @var{words} @key{RET} | |
354 Search for @var{words}, ignoring details of punctuation. | |
355 @item C-r @key{RET} C-w @var{words} @key{RET} | |
356 Search backward for @var{words}, ignoring details of punctuation. | |
357 @end table | |
358 | |
359 Word search is a special case of nonincremental search and is invoked | |
360 with @kbd{C-s @key{RET} C-w}. This is followed by the search string, | |
361 which must always be terminated with @key{RET}. Being nonincremental, | |
362 this search does not start until the argument is terminated. It works | |
363 by constructing a regular expression and searching for that; see | |
364 @ref{Regexp Search}. | |
365 | |
366 Use @kbd{C-r @key{RET} C-w} to do backward word search. | |
367 | |
368 @findex word-search-forward | |
369 @findex word-search-backward | |
370 Forward and backward word searches are implemented by the commands | |
371 @code{word-search-forward} and @code{word-search-backward}. These | |
38127
eb0f8509d107
Rewrite the texts that explain basic incremental search,
Richard M. Stallman <rms@gnu.org>
parents:
38049
diff
changeset
|
372 commands may be bound to keys in the usual manner. They are available |
eb0f8509d107
Rewrite the texts that explain basic incremental search,
Richard M. Stallman <rms@gnu.org>
parents:
38049
diff
changeset
|
373 via the incremental search commands both for historical reasons and |
eb0f8509d107
Rewrite the texts that explain basic incremental search,
Richard M. Stallman <rms@gnu.org>
parents:
38049
diff
changeset
|
374 to avoid the need to find suitable key sequences for them. |
25829 | 375 |
376 @node Regexp Search, Regexps, Word Search, Search | |
377 @section Regular Expression Search | |
378 @cindex regular expression | |
379 @cindex regexp | |
380 | |
38127
eb0f8509d107
Rewrite the texts that explain basic incremental search,
Richard M. Stallman <rms@gnu.org>
parents:
38049
diff
changeset
|
381 A @dfn{regular expression} (@dfn{regexp}, for short) is a pattern |
eb0f8509d107
Rewrite the texts that explain basic incremental search,
Richard M. Stallman <rms@gnu.org>
parents:
38049
diff
changeset
|
382 that denotes a class of alternative strings to match, possibly |
eb0f8509d107
Rewrite the texts that explain basic incremental search,
Richard M. Stallman <rms@gnu.org>
parents:
38049
diff
changeset
|
383 infinitely many. GNU Emacs provides both incremental and |
eb0f8509d107
Rewrite the texts that explain basic incremental search,
Richard M. Stallman <rms@gnu.org>
parents:
38049
diff
changeset
|
384 nonincremental ways to search for a match for a regexp. |
25829 | 385 |
386 @kindex C-M-s | |
387 @findex isearch-forward-regexp | |
388 @kindex C-M-r | |
389 @findex isearch-backward-regexp | |
390 Incremental search for a regexp is done by typing @kbd{C-M-s} | |
56306
f8704be4375b
(Incremental Search): Add C-M-w, C-M-y, M-%, C-M-%, M-e.
Juri Linkov <juri@jurta.org>
parents:
56279
diff
changeset
|
391 (@code{isearch-forward-regexp}), by invoking @kbd{C-s} with a |
f8704be4375b
(Incremental Search): Add C-M-w, C-M-y, M-%, C-M-%, M-e.
Juri Linkov <juri@jurta.org>
parents:
56279
diff
changeset
|
392 prefix argument (whose value does not matter), or by typing @kbd{M-r} |
f8704be4375b
(Incremental Search): Add C-M-w, C-M-y, M-%, C-M-%, M-e.
Juri Linkov <juri@jurta.org>
parents:
56279
diff
changeset
|
393 within a forward incremental search. This command reads a |
38127
eb0f8509d107
Rewrite the texts that explain basic incremental search,
Richard M. Stallman <rms@gnu.org>
parents:
38049
diff
changeset
|
394 search string incrementally just like @kbd{C-s}, but it treats the |
eb0f8509d107
Rewrite the texts that explain basic incremental search,
Richard M. Stallman <rms@gnu.org>
parents:
38049
diff
changeset
|
395 search string as a regexp rather than looking for an exact match |
eb0f8509d107
Rewrite the texts that explain basic incremental search,
Richard M. Stallman <rms@gnu.org>
parents:
38049
diff
changeset
|
396 against the text in the buffer. Each time you add text to the search |
eb0f8509d107
Rewrite the texts that explain basic incremental search,
Richard M. Stallman <rms@gnu.org>
parents:
38049
diff
changeset
|
397 string, you make the regexp longer, and the new regexp is searched |
eb0f8509d107
Rewrite the texts that explain basic incremental search,
Richard M. Stallman <rms@gnu.org>
parents:
38049
diff
changeset
|
398 for. To search backward for a regexp, use @kbd{C-M-r} |
56306
f8704be4375b
(Incremental Search): Add C-M-w, C-M-y, M-%, C-M-%, M-e.
Juri Linkov <juri@jurta.org>
parents:
56279
diff
changeset
|
399 (@code{isearch-backward-regexp}), @kbd{C-r} with a prefix argument, |
f8704be4375b
(Incremental Search): Add C-M-w, C-M-y, M-%, C-M-%, M-e.
Juri Linkov <juri@jurta.org>
parents:
56279
diff
changeset
|
400 or @kbd{M-r} within a backward incremental search. |
25829 | 401 |
402 All of the control characters that do special things within an | |
403 ordinary incremental search have the same function in incremental regexp | |
404 search. Typing @kbd{C-s} or @kbd{C-r} immediately after starting the | |
405 search retrieves the last incremental search regexp used; that is to | |
406 say, incremental regexp and non-regexp searches have independent | |
407 defaults. They also have separate search rings that you can access with | |
408 @kbd{M-p} and @kbd{M-n}. | |
409 | |
410 If you type @key{SPC} in incremental regexp search, it matches any | |
411 sequence of whitespace characters, including newlines. If you want | |
412 to match just a space, type @kbd{C-q @key{SPC}}. | |
413 | |
414 Note that adding characters to the regexp in an incremental regexp | |
415 search can make the cursor move back and start again. For example, if | |
416 you have searched for @samp{foo} and you add @samp{\|bar}, the cursor | |
417 backs up in case the first @samp{bar} precedes the first @samp{foo}. | |
418 | |
419 @findex re-search-forward | |
420 @findex re-search-backward | |
421 Nonincremental search for a regexp is done by the functions | |
422 @code{re-search-forward} and @code{re-search-backward}. You can invoke | |
423 these with @kbd{M-x}, or bind them to keys, or invoke them by way of | |
424 incremental regexp search with @kbd{C-M-s @key{RET}} and @kbd{C-M-r | |
425 @key{RET}}. | |
426 | |
427 If you use the incremental regexp search commands with a prefix | |
428 argument, they perform ordinary string search, like | |
429 @code{isearch-forward} and @code{isearch-backward}. @xref{Incremental | |
430 Search}. | |
431 | |
432 @node Regexps, Search Case, Regexp Search, Search | |
433 @section Syntax of Regular Expressions | |
36263
11db0318031d
Remove redundant index entries.
Eli Zaretskii <eliz@gnu.org>
parents:
36177
diff
changeset
|
434 @cindex syntax of regexps |
25829 | 435 |
50604
f37984f93151
(Regexps): Ref to Lisp manual for more regexp features.
Richard M. Stallman <rms@gnu.org>
parents:
49984
diff
changeset
|
436 This manual describes regular expression features that users |
f37984f93151
(Regexps): Ref to Lisp manual for more regexp features.
Richard M. Stallman <rms@gnu.org>
parents:
49984
diff
changeset
|
437 typically want to use. There are additional features that are |
f37984f93151
(Regexps): Ref to Lisp manual for more regexp features.
Richard M. Stallman <rms@gnu.org>
parents:
49984
diff
changeset
|
438 mainly used in Lisp programs; see @ref{Regular Expressions,,, |
56778
aeee9d21eb4a
(Regexps): Correct cryptic @ref.
Luc Teirlinck <teirllm@auburn.edu>
parents:
56527
diff
changeset
|
439 elisp, The Emacs Lisp Reference Manual}. |
50604
f37984f93151
(Regexps): Ref to Lisp manual for more regexp features.
Richard M. Stallman <rms@gnu.org>
parents:
49984
diff
changeset
|
440 |
25829 | 441 Regular expressions have a syntax in which a few characters are |
442 special constructs and the rest are @dfn{ordinary}. An ordinary | |
443 character is a simple regular expression which matches that same | |
444 character and nothing else. The special characters are @samp{$}, | |
445 @samp{^}, @samp{.}, @samp{*}, @samp{+}, @samp{?}, @samp{[}, @samp{]} and | |
446 @samp{\}. Any other character appearing in a regular expression is | |
37069
6dee6cc113a5
(Regexps): Say up front that backslashes must be doubled in a Lisp program.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
447 ordinary, unless a @samp{\} precedes it. (When you use regular |
6dee6cc113a5
(Regexps): Say up front that backslashes must be doubled in a Lisp program.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
448 expressions in a Lisp program, each @samp{\} must be doubled, see the |
6dee6cc113a5
(Regexps): Say up front that backslashes must be doubled in a Lisp program.
Eli Zaretskii <eliz@gnu.org>
parents:
36383
diff
changeset
|
449 example near the end of this section.) |
25829 | 450 |
451 For example, @samp{f} is not a special character, so it is ordinary, and | |
452 therefore @samp{f} is a regular expression that matches the string | |
453 @samp{f} and no other string. (It does @emph{not} match the string | |
454 @samp{ff}.) Likewise, @samp{o} is a regular expression that matches | |
455 only @samp{o}. (When case distinctions are being ignored, these regexps | |
456 also match @samp{F} and @samp{O}, but we consider this a generalization | |
457 of ``the same string,'' rather than an exception.) | |
458 | |
459 Any two regular expressions @var{a} and @var{b} can be concatenated. The | |
460 result is a regular expression which matches a string if @var{a} matches | |
461 some amount of the beginning of that string and @var{b} matches the rest of | |
462 the string.@refill | |
463 | |
464 As a simple example, we can concatenate the regular expressions @samp{f} | |
465 and @samp{o} to get the regular expression @samp{fo}, which matches only | |
466 the string @samp{fo}. Still trivial. To do something nontrivial, you | |
467 need to use one of the special characters. Here is a list of them. | |
468 | |
49984
632746dc04e4
(Regexps): Convert the main table into @table @asis.
Richard M. Stallman <rms@gnu.org>
parents:
48533
diff
changeset
|
469 @table @asis |
632746dc04e4
(Regexps): Convert the main table into @table @asis.
Richard M. Stallman <rms@gnu.org>
parents:
48533
diff
changeset
|
470 @item @kbd{.}@: @r{(Period)} |
25829 | 471 is a special character that matches any single character except a newline. |
472 Using concatenation, we can make regular expressions like @samp{a.b}, which | |
473 matches any three-character string that begins with @samp{a} and ends with | |
474 @samp{b}.@refill | |
475 | |
49984
632746dc04e4
(Regexps): Convert the main table into @table @asis.
Richard M. Stallman <rms@gnu.org>
parents:
48533
diff
changeset
|
476 @item @kbd{*} |
25829 | 477 is not a construct by itself; it is a postfix operator that means to |
478 match the preceding regular expression repetitively as many times as | |
479 possible. Thus, @samp{o*} matches any number of @samp{o}s (including no | |
480 @samp{o}s). | |
481 | |
482 @samp{*} always applies to the @emph{smallest} possible preceding | |
483 expression. Thus, @samp{fo*} has a repeating @samp{o}, not a repeating | |
484 @samp{fo}. It matches @samp{f}, @samp{fo}, @samp{foo}, and so on. | |
485 | |
486 The matcher processes a @samp{*} construct by matching, immediately, | |
487 as many repetitions as can be found. Then it continues with the rest | |
488 of the pattern. If that fails, backtracking occurs, discarding some | |
489 of the matches of the @samp{*}-modified construct in case that makes | |
490 it possible to match the rest of the pattern. For example, in matching | |
491 @samp{ca*ar} against the string @samp{caaar}, the @samp{a*} first | |
492 tries to match all three @samp{a}s; but the rest of the pattern is | |
493 @samp{ar} and there is only @samp{r} left to match, so this try fails. | |
494 The next alternative is for @samp{a*} to match only two @samp{a}s. | |
495 With this choice, the rest of the regexp matches successfully.@refill | |
496 | |
49984
632746dc04e4
(Regexps): Convert the main table into @table @asis.
Richard M. Stallman <rms@gnu.org>
parents:
48533
diff
changeset
|
497 @item @kbd{+} |
25829 | 498 is a postfix operator, similar to @samp{*} except that it must match |
499 the preceding expression at least once. So, for example, @samp{ca+r} | |
500 matches the strings @samp{car} and @samp{caaaar} but not the string | |
501 @samp{cr}, whereas @samp{ca*r} matches all three strings. | |
502 | |
49984
632746dc04e4
(Regexps): Convert the main table into @table @asis.
Richard M. Stallman <rms@gnu.org>
parents:
48533
diff
changeset
|
503 @item @kbd{?} |
25829 | 504 is a postfix operator, similar to @samp{*} except that it can match the |
505 preceding expression either once or not at all. For example, | |
506 @samp{ca?r} matches @samp{car} or @samp{cr}; nothing else. | |
507 | |
49984
632746dc04e4
(Regexps): Convert the main table into @table @asis.
Richard M. Stallman <rms@gnu.org>
parents:
48533
diff
changeset
|
508 @item @kbd{*?}, @kbd{+?}, @kbd{??} |
27139
a9508422287d
Improve markup for the description of non-greedy operators.
Eli Zaretskii <eliz@gnu.org>
parents:
27094
diff
changeset
|
509 @cindex non-greedy regexp matching |
27094
6500fd0a7d8e
*** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
25829
diff
changeset
|
510 are non-greedy variants of the operators above. The normal operators |
36177
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
511 @samp{*}, @samp{+}, @samp{?} are @dfn{greedy} in that they match as |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
512 much as they can, as long as the overall regexp can still match. With |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
513 a following @samp{?}, they are non-greedy: they will match as little |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
514 as possible. |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
515 |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
516 Thus, both @samp{ab*} and @samp{ab*?} can match the string @samp{a} |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
517 and the string @samp{abbbb}; but if you try to match them both against |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
518 the text @samp{abbb}, @samp{ab*} will match it all (the longest valid |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
519 match), while @samp{ab*?} will match just @samp{a} (the shortest |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
520 valid match). |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
521 |
44062
32211007711c
Clarify non-greedy repetition in searching.
Richard M. Stallman <rms@gnu.org>
parents:
40929
diff
changeset
|
522 Non-greedy operators match the shortest possible string starting at a |
32211007711c
Clarify non-greedy repetition in searching.
Richard M. Stallman <rms@gnu.org>
parents:
40929
diff
changeset
|
523 given starting point; in a forward search, though, the earliest |
32211007711c
Clarify non-greedy repetition in searching.
Richard M. Stallman <rms@gnu.org>
parents:
40929
diff
changeset
|
524 possible starting point for match is always the one chosen. Thus, if |
32211007711c
Clarify non-greedy repetition in searching.
Richard M. Stallman <rms@gnu.org>
parents:
40929
diff
changeset
|
525 you search for @samp{a.*?$} against the text @samp{abbab} followed by |
32211007711c
Clarify non-greedy repetition in searching.
Richard M. Stallman <rms@gnu.org>
parents:
40929
diff
changeset
|
526 a newline, it matches the whole string. Since it @emph{can} match |
32211007711c
Clarify non-greedy repetition in searching.
Richard M. Stallman <rms@gnu.org>
parents:
40929
diff
changeset
|
527 starting at the first @samp{a}, it does. |
32211007711c
Clarify non-greedy repetition in searching.
Richard M. Stallman <rms@gnu.org>
parents:
40929
diff
changeset
|
528 |
49984
632746dc04e4
(Regexps): Convert the main table into @table @asis.
Richard M. Stallman <rms@gnu.org>
parents:
48533
diff
changeset
|
529 @item @kbd{\@{@var{n}\@}} |
36177
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
530 is a postfix operator that specifies repetition @var{n} times---that |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
531 is, the preceding regular expression must match exactly @var{n} times |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
532 in a row. For example, @samp{x\@{4\@}} matches the string @samp{xxxx} |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
533 and nothing else. |
27094
6500fd0a7d8e
*** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
25829
diff
changeset
|
534 |
49984
632746dc04e4
(Regexps): Convert the main table into @table @asis.
Richard M. Stallman <rms@gnu.org>
parents:
48533
diff
changeset
|
535 @item @kbd{\@{@var{n},@var{m}\@}} |
36177
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
536 is a postfix operator that specifies repetition between @var{n} and |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
537 @var{m} times---that is, the preceding regular expression must match |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
538 at least @var{n} times, but no more than @var{m} times. If @var{m} is |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
539 omitted, then there is no upper limit, but the preceding regular |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
540 expression must match at least @var{n} times.@* @samp{\@{0,1\@}} is |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
541 equivalent to @samp{?}. @* @samp{\@{0,\@}} is equivalent to |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
542 @samp{*}. @* @samp{\@{1,\@}} is equivalent to @samp{+}. |
27694
5c14849aee4c
documented \{n,m\} intervals
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
27217
diff
changeset
|
543 |
49984
632746dc04e4
(Regexps): Convert the main table into @table @asis.
Richard M. Stallman <rms@gnu.org>
parents:
48533
diff
changeset
|
544 @item @kbd{[ @dots{} ]} |
25829 | 545 is a @dfn{character set}, which begins with @samp{[} and is terminated |
546 by @samp{]}. In the simplest case, the characters between the two | |
547 brackets are what this set can match. | |
548 | |
549 Thus, @samp{[ad]} matches either one @samp{a} or one @samp{d}, and | |
550 @samp{[ad]*} matches any string composed of just @samp{a}s and @samp{d}s | |
551 (including the empty string), from which it follows that @samp{c[ad]*r} | |
552 matches @samp{cr}, @samp{car}, @samp{cdr}, @samp{caddaar}, etc. | |
553 | |
554 You can also include character ranges in a character set, by writing the | |
555 starting and ending characters with a @samp{-} between them. Thus, | |
52979
3649390c0f91
Replace @sc{ascii} and ASCII with @acronym{ASCII}.
Eli Zaretskii <eliz@gnu.org>
parents:
52968
diff
changeset
|
556 @samp{[a-z]} matches any lower-case @acronym{ASCII} letter. Ranges may be |
25829 | 557 intermixed freely with individual characters, as in @samp{[a-z$%.]}, |
52979
3649390c0f91
Replace @sc{ascii} and ASCII with @acronym{ASCII}.
Eli Zaretskii <eliz@gnu.org>
parents:
52968
diff
changeset
|
558 which matches any lower-case @acronym{ASCII} letter or @samp{$}, @samp{%} or |
25829 | 559 period. |
560 | |
561 Note that the usual regexp special characters are not special inside a | |
562 character set. A completely different set of special characters exists | |
563 inside character sets: @samp{]}, @samp{-} and @samp{^}. | |
564 | |
565 To include a @samp{]} in a character set, you must make it the first | |
566 character. For example, @samp{[]a]} matches @samp{]} or @samp{a}. To | |
567 include a @samp{-}, write @samp{-} as the first or last character of the | |
568 set, or put it after a range. Thus, @samp{[]-]} matches both @samp{]} | |
569 and @samp{-}. | |
570 | |
571 To include @samp{^} in a set, put it anywhere but at the beginning of | |
37235
a60e4b9d5ba3
Mention there are other search-terminating Meta chars.
Richard M. Stallman <rms@gnu.org>
parents:
37069
diff
changeset
|
572 the set. (At the beginning, it complements the set---see below.) |
25829 | 573 |
574 When you use a range in case-insensitive search, you should write both | |
575 ends of the range in upper case, or both in lower case, or both should | |
576 be non-letters. The behavior of a mixed-case range such as @samp{A-z} | |
577 is somewhat ill-defined, and it may change in future Emacs versions. | |
578 | |
49984
632746dc04e4
(Regexps): Convert the main table into @table @asis.
Richard M. Stallman <rms@gnu.org>
parents:
48533
diff
changeset
|
579 @item @kbd{[^ @dots{} ]} |
25829 | 580 @samp{[^} begins a @dfn{complemented character set}, which matches any |
581 character except the ones specified. Thus, @samp{[^a-z0-9A-Z]} matches | |
52979
3649390c0f91
Replace @sc{ascii} and ASCII with @acronym{ASCII}.
Eli Zaretskii <eliz@gnu.org>
parents:
52968
diff
changeset
|
582 all characters @emph{except} @acronym{ASCII} letters and digits. |
25829 | 583 |
584 @samp{^} is not special in a character set unless it is the first | |
585 character. The character following the @samp{^} is treated as if it | |
586 were first (in other words, @samp{-} and @samp{]} are not special there). | |
587 | |
588 A complemented character set can match a newline, unless newline is | |
589 mentioned as one of the characters not to match. This is in contrast to | |
590 the handling of regexps in programs such as @code{grep}. | |
591 | |
49984
632746dc04e4
(Regexps): Convert the main table into @table @asis.
Richard M. Stallman <rms@gnu.org>
parents:
48533
diff
changeset
|
592 @item @kbd{^} |
25829 | 593 is a special character that matches the empty string, but only at the |
594 beginning of a line in the text being matched. Otherwise it fails to | |
595 match anything. Thus, @samp{^foo} matches a @samp{foo} that occurs at | |
596 the beginning of a line. | |
597 | |
54273
d46dec533480
(Regexps): Explain that ^ and $ have their
Richard M. Stallman <rms@gnu.org>
parents:
52979
diff
changeset
|
598 For historical compatibility reasons, @samp{^} can be used with this |
d46dec533480
(Regexps): Explain that ^ and $ have their
Richard M. Stallman <rms@gnu.org>
parents:
52979
diff
changeset
|
599 meaning only at the beginning of the regular expression, or after |
d46dec533480
(Regexps): Explain that ^ and $ have their
Richard M. Stallman <rms@gnu.org>
parents:
52979
diff
changeset
|
600 @samp{\(} or @samp{\|}. |
d46dec533480
(Regexps): Explain that ^ and $ have their
Richard M. Stallman <rms@gnu.org>
parents:
52979
diff
changeset
|
601 |
49984
632746dc04e4
(Regexps): Convert the main table into @table @asis.
Richard M. Stallman <rms@gnu.org>
parents:
48533
diff
changeset
|
602 @item @kbd{$} |
25829 | 603 is similar to @samp{^} but matches only at the end of a line. Thus, |
604 @samp{x+$} matches a string of one @samp{x} or more at the end of a line. | |
605 | |
54273
d46dec533480
(Regexps): Explain that ^ and $ have their
Richard M. Stallman <rms@gnu.org>
parents:
52979
diff
changeset
|
606 For historical compatibility reasons, @samp{$} can be used with this |
d46dec533480
(Regexps): Explain that ^ and $ have their
Richard M. Stallman <rms@gnu.org>
parents:
52979
diff
changeset
|
607 meaning only at the end of the regular expression, or before @samp{\)} |
d46dec533480
(Regexps): Explain that ^ and $ have their
Richard M. Stallman <rms@gnu.org>
parents:
52979
diff
changeset
|
608 or @samp{\|}. |
d46dec533480
(Regexps): Explain that ^ and $ have their
Richard M. Stallman <rms@gnu.org>
parents:
52979
diff
changeset
|
609 |
49984
632746dc04e4
(Regexps): Convert the main table into @table @asis.
Richard M. Stallman <rms@gnu.org>
parents:
48533
diff
changeset
|
610 @item @kbd{\} |
25829 | 611 has two functions: it quotes the special characters (including |
612 @samp{\}), and it introduces additional special constructs. | |
613 | |
614 Because @samp{\} quotes special characters, @samp{\$} is a regular | |
615 expression that matches only @samp{$}, and @samp{\[} is a regular | |
616 expression that matches only @samp{[}, and so on. | |
617 @end table | |
618 | |
619 Note: for historical compatibility, special characters are treated as | |
620 ordinary ones if they are in contexts where their special meanings make no | |
621 sense. For example, @samp{*foo} treats @samp{*} as ordinary since there is | |
622 no preceding expression on which the @samp{*} can act. It is poor practice | |
623 to depend on this behavior; it is better to quote the special character anyway, | |
624 regardless of where it appears.@refill | |
625 | |
626 For the most part, @samp{\} followed by any character matches only that | |
627 character. However, there are several exceptions: two-character | |
628 sequences starting with @samp{\} that have special meanings. The second | |
629 character in the sequence is always an ordinary character when used on | |
630 its own. Here is a table of @samp{\} constructs. | |
631 | |
632 @table @kbd | |
633 @item \| | |
634 specifies an alternative. Two regular expressions @var{a} and @var{b} | |
635 with @samp{\|} in between form an expression that matches some text if | |
636 either @var{a} matches it or @var{b} matches it. It works by trying to | |
637 match @var{a}, and if that fails, by trying to match @var{b}. | |
638 | |
639 Thus, @samp{foo\|bar} matches either @samp{foo} or @samp{bar} | |
640 but no other string.@refill | |
641 | |
642 @samp{\|} applies to the largest possible surrounding expressions. Only a | |
643 surrounding @samp{\( @dots{} \)} grouping can limit the grouping power of | |
644 @samp{\|}.@refill | |
645 | |
646 Full backtracking capability exists to handle multiple uses of @samp{\|}. | |
647 | |
648 @item \( @dots{} \) | |
649 is a grouping construct that serves three purposes: | |
650 | |
651 @enumerate | |
652 @item | |
653 To enclose a set of @samp{\|} alternatives for other operations. | |
654 Thus, @samp{\(foo\|bar\)x} matches either @samp{foox} or @samp{barx}. | |
655 | |
656 @item | |
657 To enclose a complicated expression for the postfix operators @samp{*}, | |
658 @samp{+} and @samp{?} to operate on. Thus, @samp{ba\(na\)*} matches | |
659 @samp{bananana}, etc., with any (zero or more) number of @samp{na} | |
660 strings.@refill | |
661 | |
662 @item | |
663 To record a matched substring for future reference. | |
664 @end enumerate | |
665 | |
666 This last application is not a consequence of the idea of a | |
667 parenthetical grouping; it is a separate feature that is assigned as a | |
668 second meaning to the same @samp{\( @dots{} \)} construct. In practice | |
36177
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
669 there is usually no conflict between the two meanings; when there is |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
670 a conflict, you can use a ``shy'' group. |
28063
f1b33463506d
*** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
27694
diff
changeset
|
671 |
f1b33463506d
*** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
27694
diff
changeset
|
672 @item \(?: @dots{} \) |
36177
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
673 @cindex shy group, in regexp |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
674 specifies a ``shy'' group that does not record the matched substring; |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
675 you can't refer back to it with @samp{\@var{d}}. This is useful |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
676 in mechanically combining regular expressions, so that you |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
677 can add groups for syntactic purposes without interfering with |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
678 the numbering of the groups that were written by the user. |
25829 | 679 |
680 @item \@var{d} | |
681 matches the same text that matched the @var{d}th occurrence of a | |
682 @samp{\( @dots{} \)} construct. | |
683 | |
684 After the end of a @samp{\( @dots{} \)} construct, the matcher remembers | |
685 the beginning and end of the text matched by that construct. Then, | |
686 later on in the regular expression, you can use @samp{\} followed by the | |
687 digit @var{d} to mean ``match the same text matched the @var{d}th time | |
688 by the @samp{\( @dots{} \)} construct.'' | |
689 | |
690 The strings matching the first nine @samp{\( @dots{} \)} constructs | |
691 appearing in a regular expression are assigned numbers 1 through 9 in | |
692 the order that the open-parentheses appear in the regular expression. | |
693 So you can use @samp{\1} through @samp{\9} to refer to the text matched | |
694 by the corresponding @samp{\( @dots{} \)} constructs. | |
695 | |
696 For example, @samp{\(.*\)\1} matches any newline-free string that is | |
697 composed of two identical halves. The @samp{\(.*\)} matches the first | |
698 half, which may be anything, but the @samp{\1} that follows must match | |
699 the same exact text. | |
700 | |
701 If a particular @samp{\( @dots{} \)} construct matches more than once | |
702 (which can easily happen if it is followed by @samp{*}), only the last | |
703 match is recorded. | |
704 | |
705 @item \` | |
40929 | 706 matches the empty string, but only at the beginning of the string or |
707 buffer (or its accessible portion) being matched against. | |
25829 | 708 |
709 @item \' | |
40929 | 710 matches the empty string, but only at the end of the string or buffer |
711 (or its accessible portion) being matched against. | |
25829 | 712 |
713 @item \= | |
714 matches the empty string, but only at point. | |
715 | |
716 @item \b | |
717 matches the empty string, but only at the beginning or | |
718 end of a word. Thus, @samp{\bfoo\b} matches any occurrence of | |
719 @samp{foo} as a separate word. @samp{\bballs?\b} matches | |
720 @samp{ball} or @samp{balls} as a separate word.@refill | |
721 | |
722 @samp{\b} matches at the beginning or end of the buffer | |
723 regardless of what text appears next to it. | |
724 | |
725 @item \B | |
726 matches the empty string, but @emph{not} at the beginning or | |
727 end of a word. | |
728 | |
729 @item \< | |
730 matches the empty string, but only at the beginning of a word. | |
731 @samp{\<} matches at the beginning of the buffer only if a | |
732 word-constituent character follows. | |
733 | |
734 @item \> | |
735 matches the empty string, but only at the end of a word. @samp{\>} | |
736 matches at the end of the buffer only if the contents end with a | |
737 word-constituent character. | |
738 | |
739 @item \w | |
740 matches any word-constituent character. The syntax table | |
741 determines which characters these are. @xref{Syntax}. | |
742 | |
743 @item \W | |
744 matches any character that is not a word-constituent. | |
745 | |
55693
1420f008c89b
Describe the new \_< and \_> operators.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
54273
diff
changeset
|
746 @item \_< |
58434
b458d6bca4fe
*** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
57382
diff
changeset
|
747 matches the empty string, but only at the beginning of a symbol. |
b458d6bca4fe
*** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
57382
diff
changeset
|
748 A symbol is a sequence of one or more symbol-constituent characters. |
b458d6bca4fe
*** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
57382
diff
changeset
|
749 A symbol-constituent character is a character whose syntax is either |
58436 | 750 @samp{w} or @samp{_}. @samp{\_<} matches at the beginning of the |
58434
b458d6bca4fe
*** empty log message ***
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
57382
diff
changeset
|
751 buffer only if a symbol-constituent character follows. |
55693
1420f008c89b
Describe the new \_< and \_> operators.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
54273
diff
changeset
|
752 |
1420f008c89b
Describe the new \_< and \_> operators.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
54273
diff
changeset
|
753 @item \_> |
56467
e2448fa3dca4
(Regexps): Delete redundant definition of `symbol' in description of
Luc Teirlinck <teirllm@auburn.edu>
parents:
56306
diff
changeset
|
754 matches the empty string, but only at the end of a symbol. @samp{\_>} |
e2448fa3dca4
(Regexps): Delete redundant definition of `symbol' in description of
Luc Teirlinck <teirllm@auburn.edu>
parents:
56306
diff
changeset
|
755 matches at the end of the buffer only if the contents end with a |
e2448fa3dca4
(Regexps): Delete redundant definition of `symbol' in description of
Luc Teirlinck <teirllm@auburn.edu>
parents:
56306
diff
changeset
|
756 symbol-constituent character. |
55693
1420f008c89b
Describe the new \_< and \_> operators.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
54273
diff
changeset
|
757 |
25829 | 758 @item \s@var{c} |
759 matches any character whose syntax is @var{c}. Here @var{c} is a | |
37235
a60e4b9d5ba3
Mention there are other search-terminating Meta chars.
Richard M. Stallman <rms@gnu.org>
parents:
37069
diff
changeset
|
760 character that designates a particular syntax class: thus, @samp{w} |
a60e4b9d5ba3
Mention there are other search-terminating Meta chars.
Richard M. Stallman <rms@gnu.org>
parents:
37069
diff
changeset
|
761 for word constituent, @samp{-} or @samp{ } for whitespace, @samp{.} |
a60e4b9d5ba3
Mention there are other search-terminating Meta chars.
Richard M. Stallman <rms@gnu.org>
parents:
37069
diff
changeset
|
762 for ordinary punctuation, etc. @xref{Syntax}. |
25829 | 763 |
764 @item \S@var{c} | |
765 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
|
766 |
250691f20cec
(Incremental Search): Document C-\ and C-^.
Eli Zaretskii <eliz@gnu.org>
parents:
35876
diff
changeset
|
767 @cindex categories of characters |
250691f20cec
(Incremental Search): Document C-\ and C-^.
Eli Zaretskii <eliz@gnu.org>
parents:
35876
diff
changeset
|
768 @cindex characters which belong to a specific language |
250691f20cec
(Incremental Search): Document C-\ and C-^.
Eli Zaretskii <eliz@gnu.org>
parents:
35876
diff
changeset
|
769 @findex describe-categories |
250691f20cec
(Incremental Search): Document C-\ and C-^.
Eli Zaretskii <eliz@gnu.org>
parents:
35876
diff
changeset
|
770 @item \c@var{c} |
250691f20cec
(Incremental Search): Document C-\ and C-^.
Eli Zaretskii <eliz@gnu.org>
parents:
35876
diff
changeset
|
771 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
|
772 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
|
773 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
|
774 type @kbd{M-x describe-categories @key{RET}}. |
250691f20cec
(Incremental Search): Document C-\ and C-^.
Eli Zaretskii <eliz@gnu.org>
parents:
35876
diff
changeset
|
775 |
250691f20cec
(Incremental Search): Document C-\ and C-^.
Eli Zaretskii <eliz@gnu.org>
parents:
35876
diff
changeset
|
776 @item \C@var{c} |
250691f20cec
(Incremental Search): Document C-\ and C-^.
Eli Zaretskii <eliz@gnu.org>
parents:
35876
diff
changeset
|
777 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
|
778 @var{c}. |
25829 | 779 @end table |
780 | |
781 The constructs that pertain to words and syntax are controlled by the | |
782 setting of the syntax table (@pxref{Syntax}). | |
783 | |
57374
384212f1e3a5
(Regexps): The regexp described in the example is no longer stored in
Luc Teirlinck <teirllm@auburn.edu>
parents:
56908
diff
changeset
|
784 Here is a complicated regexp. It is a simplified version of the |
384212f1e3a5
(Regexps): The regexp described in the example is no longer stored in
Luc Teirlinck <teirllm@auburn.edu>
parents:
56908
diff
changeset
|
785 regexp that Emacs uses, by default, to recognize the end of a sentence |
384212f1e3a5
(Regexps): The regexp described in the example is no longer stored in
Luc Teirlinck <teirllm@auburn.edu>
parents:
56908
diff
changeset
|
786 together with any whitespace that follows. We show its Lisp syntax to |
384212f1e3a5
(Regexps): The regexp described in the example is no longer stored in
Luc Teirlinck <teirllm@auburn.edu>
parents:
56908
diff
changeset
|
787 distinguish the spaces from the tab characters. In Lisp syntax, the |
384212f1e3a5
(Regexps): The regexp described in the example is no longer stored in
Luc Teirlinck <teirllm@auburn.edu>
parents:
56908
diff
changeset
|
788 string constant begins and ends with a double-quote. @samp{\"} stands |
384212f1e3a5
(Regexps): The regexp described in the example is no longer stored in
Luc Teirlinck <teirllm@auburn.edu>
parents:
56908
diff
changeset
|
789 for a double-quote as part of the regexp, @samp{\\} for a backslash as |
384212f1e3a5
(Regexps): The regexp described in the example is no longer stored in
Luc Teirlinck <teirllm@auburn.edu>
parents:
56908
diff
changeset
|
790 part of the regexp, @samp{\t} for a tab, and @samp{\n} for a newline. |
25829 | 791 |
792 @example | |
37235
a60e4b9d5ba3
Mention there are other search-terminating Meta chars.
Richard M. Stallman <rms@gnu.org>
parents:
37069
diff
changeset
|
793 "[.?!][]\"')]*\\($\\| $\\|\t\\| \\)[ \t\n]*" |
25829 | 794 @end example |
795 | |
796 @noindent | |
37235
a60e4b9d5ba3
Mention there are other search-terminating Meta chars.
Richard M. Stallman <rms@gnu.org>
parents:
37069
diff
changeset
|
797 This contains four parts in succession: a character set matching |
a60e4b9d5ba3
Mention there are other search-terminating Meta chars.
Richard M. Stallman <rms@gnu.org>
parents:
37069
diff
changeset
|
798 period, @samp{?}, or @samp{!}; a character set matching |
a60e4b9d5ba3
Mention there are other search-terminating Meta chars.
Richard M. Stallman <rms@gnu.org>
parents:
37069
diff
changeset
|
799 close-brackets, quotes, or parentheses, repeated zero or more times; a |
a60e4b9d5ba3
Mention there are other search-terminating Meta chars.
Richard M. Stallman <rms@gnu.org>
parents:
37069
diff
changeset
|
800 set of alternatives within backslash-parentheses that matches either |
a60e4b9d5ba3
Mention there are other search-terminating Meta chars.
Richard M. Stallman <rms@gnu.org>
parents:
37069
diff
changeset
|
801 end-of-line, a space at the end of a line, a tab, or two spaces; and a |
a60e4b9d5ba3
Mention there are other search-terminating Meta chars.
Richard M. Stallman <rms@gnu.org>
parents:
37069
diff
changeset
|
802 character set matching whitespace characters, repeated any number of |
a60e4b9d5ba3
Mention there are other search-terminating Meta chars.
Richard M. Stallman <rms@gnu.org>
parents:
37069
diff
changeset
|
803 times. |
25829 | 804 |
40521
549e09fb7907
Clarify how to enter regexps in isearch and in the miniubuffer.
Richard M. Stallman <rms@gnu.org>
parents:
40302
diff
changeset
|
805 To enter the same regexp in incremental search, you would type |
549e09fb7907
Clarify how to enter regexps in isearch and in the miniubuffer.
Richard M. Stallman <rms@gnu.org>
parents:
40302
diff
changeset
|
806 @key{TAB} to enter a tab, and @kbd{C-j} to enter a newline. You would |
549e09fb7907
Clarify how to enter regexps in isearch and in the miniubuffer.
Richard M. Stallman <rms@gnu.org>
parents:
40302
diff
changeset
|
807 also type single backslashes as themselves, instead of doubling them |
549e09fb7907
Clarify how to enter regexps in isearch and in the miniubuffer.
Richard M. Stallman <rms@gnu.org>
parents:
40302
diff
changeset
|
808 for Lisp syntax. In commands that use ordinary minibuffer input to |
549e09fb7907
Clarify how to enter regexps in isearch and in the miniubuffer.
Richard M. Stallman <rms@gnu.org>
parents:
40302
diff
changeset
|
809 read a regexp, you would quote the @kbd{C-j} by preceding it with a |
549e09fb7907
Clarify how to enter regexps in isearch and in the miniubuffer.
Richard M. Stallman <rms@gnu.org>
parents:
40302
diff
changeset
|
810 @kbd{C-q} to prevent @kbd{C-j} from exiting the minibuffer. |
25829 | 811 |
36177
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
812 @ignore |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
813 @c I commented this out because it is missing vital information |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
814 @c and therefore useless. For instance, what do you do to *use* the |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
815 @c regular expression when it is finished? What jobs is this good for? |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
816 @c -- rms |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
817 |
31072 | 818 @findex re-builder |
819 @cindex authoring regular expressions | |
36177
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
820 For convenient interactive development of regular expressions, you |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
821 can use the @kbd{M-x re-builder} command. It provides a convenient |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
822 interface for creating regular expressions, by giving immediate visual |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
823 feedback. The buffer from which @code{re-builder} was invoked becomes |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
824 the target for the regexp editor, which pops in a separate window. At |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
825 all times, all the matches in the target buffer for the current |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
826 regular expression are highlighted. Each parenthesized sub-expression |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
827 of the regexp is shown in a distinct face, which makes it easier to |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
828 verify even very complex regexps. (On displays that don't support |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
829 colors, Emacs blinks the cursor around the matched text, as it does |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
830 for matching parens.) |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
831 @end ignore |
31072 | 832 |
52968
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
833 @node Search Case, Configuring Scrolling, Regexps, Search |
25829 | 834 @section Searching and Case |
835 | |
836 Incremental searches in Emacs normally ignore the case of the text | |
837 they are searching through, if you specify the text in lower case. | |
838 Thus, if you specify searching for @samp{foo}, then @samp{Foo} and | |
839 @samp{foo} are also considered a match. Regexps, and in particular | |
840 character sets, are included: @samp{[ab]} would match @samp{a} or | |
841 @samp{A} or @samp{b} or @samp{B}.@refill | |
842 | |
843 An upper-case letter anywhere in the incremental search string makes | |
844 the search case-sensitive. Thus, searching for @samp{Foo} does not find | |
845 @samp{foo} or @samp{FOO}. This applies to regular expression search as | |
846 well as to string search. The effect ceases if you delete the | |
847 upper-case letter from the search string. | |
848 | |
37235
a60e4b9d5ba3
Mention there are other search-terminating Meta chars.
Richard M. Stallman <rms@gnu.org>
parents:
37069
diff
changeset
|
849 Typing @kbd{M-c} within an incremental search toggles the case |
a60e4b9d5ba3
Mention there are other search-terminating Meta chars.
Richard M. Stallman <rms@gnu.org>
parents:
37069
diff
changeset
|
850 sensitivity of that search. The effect does not extend beyond the |
a60e4b9d5ba3
Mention there are other search-terminating Meta chars.
Richard M. Stallman <rms@gnu.org>
parents:
37069
diff
changeset
|
851 current incremental search to the next one, but it does override the |
a60e4b9d5ba3
Mention there are other search-terminating Meta chars.
Richard M. Stallman <rms@gnu.org>
parents:
37069
diff
changeset
|
852 effect of including an upper-case letter in the current search. |
a60e4b9d5ba3
Mention there are other search-terminating Meta chars.
Richard M. Stallman <rms@gnu.org>
parents:
37069
diff
changeset
|
853 |
a60e4b9d5ba3
Mention there are other search-terminating Meta chars.
Richard M. Stallman <rms@gnu.org>
parents:
37069
diff
changeset
|
854 @vindex case-fold-search |
25829 | 855 If you set the variable @code{case-fold-search} to @code{nil}, then |
856 all letters must match exactly, including case. This is a per-buffer | |
857 variable; altering the variable affects only the current buffer, but | |
858 there is a default value which you can change as well. @xref{Locals}. | |
859 This variable applies to nonincremental searches also, including those | |
860 performed by the replace commands (@pxref{Replace}) and the minibuffer | |
861 history matching commands (@pxref{Minibuffer History}). | |
862 | |
52968
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
863 @node Configuring Scrolling, Replace, Search Case, Search |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
864 @section Configuring Scrolling |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
865 @cindex scrolling in incremental search |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
866 @vindex isearch-allow-scroll |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
867 |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
868 Scrolling, etc., during incremental search is enabled by setting the |
56279
b1ae5333057a
* ses.texi, viper.texi, search.texi, flymake.texi, faq.texi:
Jesper Harder <harder@ifa.au.dk>
parents:
56251
diff
changeset
|
869 customizable variable @code{isearch-allow-scroll} to a non-@code{nil} value. |
52968
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
870 |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
871 @c See Subject: Info file: How do I get an itemized list without blank lines? |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
872 @c Date: Sat, 12 Apr 2003 09:45:31 +0000 in gnu.emacs.help |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
873 @subsection Standard scrolling commands |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
874 Here is the list of commands which are configured by default to be |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
875 ``scrolling'' commands in an incremental search, together with their |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
876 usual bindings: |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
877 @subsubsection Commands which scroll the window: |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
878 @table @asis |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
879 @item @code{scroll-bar-toolkit-scroll} (@kbd{@key{vertical-scroll-bar}@key{mouse-1}} in X-Windows) |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
880 @itemx @code{mac-handle-scroll-bar-event} (@kbd{@key{vertical-scroll-bar}@key{mouse-1}} on a Mac) |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
881 @itemx @code{w32-handle-scroll-bar-event} (@kbd{@key{vertical-scroll-bar}@key{mouse-1}} in MS-Windows) |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
882 @item @code{recenter} (@kbd{C-l}) @xref{Scrolling}. |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
883 @itemx @code{reposition-window} (@kbd{C-M-l}) @xref{Scrolling}. |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
884 @itemx @code{scroll-up} (@kbd{@key{NEXT}}) @xref{Scrolling}. |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
885 @itemx @code{scroll-down} (@kbd{@key{PRIOR}}) @xref{Scrolling}. |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
886 @end table |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
887 |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
888 @subsubsection Commands which act on the other window: |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
889 @table @asis |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
890 @item @code{list-buffers} (@kbd{C-x C-b}) @xref{List Buffers}. |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
891 @itemx @code{scroll-other-window} (@kbd{C-M-v}) @xref{Other Window}. |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
892 @itemx @code{scroll-other-window-down} (@kbd{C-M-S-v}) @xref{Other Window}. |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
893 @itemx @code{beginning-of-buffer-other-window} (@kbd{M-@key{home}}) |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
894 @itemx @code{end-of-buffer-other-window} (@kbd{M-@key{end}}) |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
895 @end table |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
896 |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
897 @subsubsection Commands which change the window layout: |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
898 @table @asis |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
899 @item @code{delete-other-windows} (@kbd{C-x 1}) @xref{Change Window}. |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
900 @itemx @code{balance-windows} (@kbd{C-x +}) @xref{Change Window}. |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
901 @itemx @code{split-window-vertically} (@kbd{C-x 2}) @xref{Split Window}. |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
902 @itemx @code{enlarge-window} (@kbd{C-x ^}) @xref{Change Window}. |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
903 @end table |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
904 |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
905 @subsection Configuring other commands as scrolling commands |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
906 To do this, set a command's isearch-scroll property to the value t. |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
907 For example: |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
908 |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
909 @example |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
910 @code{(put 'my-command 'isearch-scroll t)} |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
911 @end example |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
912 |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
913 You should only thus configure commands which are ``safe'': i.e., they |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
914 won't leave emacs in an inconsistent state when executed within a |
56279
b1ae5333057a
* ses.texi, viper.texi, search.texi, flymake.texi, faq.texi:
Jesper Harder <harder@ifa.au.dk>
parents:
56251
diff
changeset
|
915 search---that is to say, the following things may be changed by a |
52968
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
916 command only temporarily, and must be restored before the command |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
917 finishes: |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
918 |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
919 @enumerate |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
920 @item |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
921 Point. |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
922 @item |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
923 The buffer contents. |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
924 @item |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
925 The selected window and selected frame. |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
926 @item |
56778
aeee9d21eb4a
(Regexps): Correct cryptic @ref.
Luc Teirlinck <teirllm@auburn.edu>
parents:
56527
diff
changeset
|
927 The current match-data. @xref{Match Data,,, elisp, The Emacs Lisp |
aeee9d21eb4a
(Regexps): Correct cryptic @ref.
Luc Teirlinck <teirllm@auburn.edu>
parents:
56527
diff
changeset
|
928 Reference Manual}. |
52968
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
929 @end enumerate |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
930 |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
931 Additionally, the command must not delete the current window and must |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
932 not itself attempt an incremental search. It may, however, change the |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
933 window's size, or create or delete other windows and frames. |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
934 |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
935 Note that an attempt by a command to scroll the text |
56279
b1ae5333057a
* ses.texi, viper.texi, search.texi, flymake.texi, faq.texi:
Jesper Harder <harder@ifa.au.dk>
parents:
56251
diff
changeset
|
936 @emph{horizontally} won't work, although it will do no harm---any such |
56778
aeee9d21eb4a
(Regexps): Correct cryptic @ref.
Luc Teirlinck <teirllm@auburn.edu>
parents:
56527
diff
changeset
|
937 scrolling will be overridden and nullified by the display code. |
52968
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
938 |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
939 @node Replace, Other Repeating Search, Configuring Scrolling, Search |
25829 | 940 @section Replacement Commands |
941 @cindex replacement | |
942 @cindex search-and-replace commands | |
943 @cindex string substitution | |
944 @cindex global substitution | |
945 | |
38127
eb0f8509d107
Rewrite the texts that explain basic incremental search,
Richard M. Stallman <rms@gnu.org>
parents:
38049
diff
changeset
|
946 Global search-and-replace operations are not needed often in Emacs, |
eb0f8509d107
Rewrite the texts that explain basic incremental search,
Richard M. Stallman <rms@gnu.org>
parents:
38049
diff
changeset
|
947 but they are available. In addition to the simple @kbd{M-x |
56306
f8704be4375b
(Incremental Search): Add C-M-w, C-M-y, M-%, C-M-%, M-e.
Juri Linkov <juri@jurta.org>
parents:
56279
diff
changeset
|
948 replace-string} command which replaces all occurrences, |
38127
eb0f8509d107
Rewrite the texts that explain basic incremental search,
Richard M. Stallman <rms@gnu.org>
parents:
38049
diff
changeset
|
949 there is a @kbd{M-x query-replace} command which finds each occurrence |
eb0f8509d107
Rewrite the texts that explain basic incremental search,
Richard M. Stallman <rms@gnu.org>
parents:
38049
diff
changeset
|
950 of the pattern and asks you whether to replace it. |
25829 | 951 |
952 The replace commands normally operate on the text from point to the | |
46193
d76b60f898fc
(Replace): Add a cross-reference to Transient Mark mode.
Eli Zaretskii <eliz@gnu.org>
parents:
44858
diff
changeset
|
953 end of the buffer; however, in Transient Mark mode (@pxref{Transient |
d76b60f898fc
(Replace): Add a cross-reference to Transient Mark mode.
Eli Zaretskii <eliz@gnu.org>
parents:
44858
diff
changeset
|
954 Mark}), when the mark is active, they operate on the region. The |
d76b60f898fc
(Replace): Add a cross-reference to Transient Mark mode.
Eli Zaretskii <eliz@gnu.org>
parents:
44858
diff
changeset
|
955 replace commands all replace one string (or regexp) with one |
d76b60f898fc
(Replace): Add a cross-reference to Transient Mark mode.
Eli Zaretskii <eliz@gnu.org>
parents:
44858
diff
changeset
|
956 replacement string. It is possible to perform several replacements in |
d76b60f898fc
(Replace): Add a cross-reference to Transient Mark mode.
Eli Zaretskii <eliz@gnu.org>
parents:
44858
diff
changeset
|
957 parallel using the command @code{expand-region-abbrevs} |
d76b60f898fc
(Replace): Add a cross-reference to Transient Mark mode.
Eli Zaretskii <eliz@gnu.org>
parents:
44858
diff
changeset
|
958 (@pxref{Expanding Abbrevs}). |
25829 | 959 |
960 @menu | |
52968
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
961 * Unconditional Replace:: Replacing all matches for a string. |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
962 * Regexp Replace:: Replacing all matches for a regexp. |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
963 * Replacement and Case:: How replacements preserve case of letters. |
f785910734e8
(Scrolling During Incremental Search): Document a
Eli Zaretskii <eliz@gnu.org>
parents:
52401
diff
changeset
|
964 * Query Replace:: How to use querying. |
25829 | 965 @end menu |
966 | |
967 @node Unconditional Replace, Regexp Replace, Replace, Replace | |
968 @subsection Unconditional Replacement | |
969 @findex replace-string | |
970 @findex replace-regexp | |
971 | |
972 @table @kbd | |
973 @item M-x replace-string @key{RET} @var{string} @key{RET} @var{newstring} @key{RET} | |
974 Replace every occurrence of @var{string} with @var{newstring}. | |
975 @item M-x replace-regexp @key{RET} @var{regexp} @key{RET} @var{newstring} @key{RET} | |
976 Replace every match for @var{regexp} with @var{newstring}. | |
977 @end table | |
978 | |
979 To replace every instance of @samp{foo} after point with @samp{bar}, | |
980 use the command @kbd{M-x replace-string} with the two arguments | |
981 @samp{foo} and @samp{bar}. Replacement happens only in the text after | |
982 point, so if you want to cover the whole buffer you must go to the | |
983 beginning first. All occurrences up to the end of the buffer are | |
984 replaced; to limit replacement to part of the buffer, narrow to that | |
985 part of the buffer before doing the replacement (@pxref{Narrowing}). | |
986 In Transient Mark mode, when the region is active, replacement is | |
987 limited to the region (@pxref{Transient Mark}). | |
988 | |
989 When @code{replace-string} exits, it leaves point at the last | |
990 occurrence replaced. It sets the mark to the prior position of point | |
991 (where the @code{replace-string} command was issued); use @kbd{C-u | |
992 C-@key{SPC}} to move back there. | |
993 | |
994 A numeric argument restricts replacement to matches that are surrounded | |
995 by word boundaries. The argument's value doesn't matter. | |
996 | |
48533
2eca4c95c2bf
(Unconditional Replace): Explain how to replace two strings
Richard M. Stallman <rms@gnu.org>
parents:
46242
diff
changeset
|
997 What if you want to exchange @samp{x} and @samp{y}: replace every @samp{x} with a @samp{y} and vice versa? You can do it this way: |
2eca4c95c2bf
(Unconditional Replace): Explain how to replace two strings
Richard M. Stallman <rms@gnu.org>
parents:
46242
diff
changeset
|
998 |
2eca4c95c2bf
(Unconditional Replace): Explain how to replace two strings
Richard M. Stallman <rms@gnu.org>
parents:
46242
diff
changeset
|
999 @example |
56230
fe184d71d3cb
(Unconditional Replace): Use replace-string instead
David Kastrup <dak@gnu.org>
parents:
55693
diff
changeset
|
1000 M-x replace-string @key{RET} x @key{RET} @@TEMP@@ @key{RET} |
fe184d71d3cb
(Unconditional Replace): Use replace-string instead
David Kastrup <dak@gnu.org>
parents:
55693
diff
changeset
|
1001 M-< M-x replace-string @key{RET} y @key{RET} x @key{RET} |
fe184d71d3cb
(Unconditional Replace): Use replace-string instead
David Kastrup <dak@gnu.org>
parents:
55693
diff
changeset
|
1002 M-< M-x replace-string @key{RET} @@TEMP@@ @key{RET} y @key{RET} |
48533
2eca4c95c2bf
(Unconditional Replace): Explain how to replace two strings
Richard M. Stallman <rms@gnu.org>
parents:
46242
diff
changeset
|
1003 @end example |
2eca4c95c2bf
(Unconditional Replace): Explain how to replace two strings
Richard M. Stallman <rms@gnu.org>
parents:
46242
diff
changeset
|
1004 |
2eca4c95c2bf
(Unconditional Replace): Explain how to replace two strings
Richard M. Stallman <rms@gnu.org>
parents:
46242
diff
changeset
|
1005 @noindent |
2eca4c95c2bf
(Unconditional Replace): Explain how to replace two strings
Richard M. Stallman <rms@gnu.org>
parents:
46242
diff
changeset
|
1006 This works provided the string @samp{@@TEMP@@} does not appear |
2eca4c95c2bf
(Unconditional Replace): Explain how to replace two strings
Richard M. Stallman <rms@gnu.org>
parents:
46242
diff
changeset
|
1007 in your text. |
2eca4c95c2bf
(Unconditional Replace): Explain how to replace two strings
Richard M. Stallman <rms@gnu.org>
parents:
46242
diff
changeset
|
1008 |
25829 | 1009 @node Regexp Replace, Replacement and Case, Unconditional Replace, Replace |
1010 @subsection Regexp Replacement | |
1011 | |
1012 The @kbd{M-x replace-string} command replaces exact matches for a | |
1013 single string. The similar command @kbd{M-x replace-regexp} replaces | |
1014 any match for a specified pattern. | |
1015 | |
56251
651f09f1cac0
(Regexp Replace): Rewrite description of \# \, and \?.
Richard M. Stallman <rms@gnu.org>
parents:
56247
diff
changeset
|
1016 In @code{replace-regexp}, the @var{newstring} need not be constant: |
651f09f1cac0
(Regexp Replace): Rewrite description of \# \, and \?.
Richard M. Stallman <rms@gnu.org>
parents:
56247
diff
changeset
|
1017 it can refer to all or part of what is matched by the @var{regexp}. |
651f09f1cac0
(Regexp Replace): Rewrite description of \# \, and \?.
Richard M. Stallman <rms@gnu.org>
parents:
56247
diff
changeset
|
1018 @samp{\&} in @var{newstring} stands for the entire match being |
651f09f1cac0
(Regexp Replace): Rewrite description of \# \, and \?.
Richard M. Stallman <rms@gnu.org>
parents:
56247
diff
changeset
|
1019 replaced. @samp{\@var{d}} in @var{newstring}, where @var{d} is a |
651f09f1cac0
(Regexp Replace): Rewrite description of \# \, and \?.
Richard M. Stallman <rms@gnu.org>
parents:
56247
diff
changeset
|
1020 digit, stands for whatever matched the @var{d}th parenthesized |
651f09f1cac0
(Regexp Replace): Rewrite description of \# \, and \?.
Richard M. Stallman <rms@gnu.org>
parents:
56247
diff
changeset
|
1021 grouping in @var{regexp}. @samp{\#} refers to the count of |
651f09f1cac0
(Regexp Replace): Rewrite description of \# \, and \?.
Richard M. Stallman <rms@gnu.org>
parents:
56247
diff
changeset
|
1022 replacements already made in this command, as a decimal number. In |
651f09f1cac0
(Regexp Replace): Rewrite description of \# \, and \?.
Richard M. Stallman <rms@gnu.org>
parents:
56247
diff
changeset
|
1023 the first replacement, @samp{\#} stands for @samp{0}; in the second, |
651f09f1cac0
(Regexp Replace): Rewrite description of \# \, and \?.
Richard M. Stallman <rms@gnu.org>
parents:
56247
diff
changeset
|
1024 for @samp{1}; and so on. For example, |
25829 | 1025 |
1026 @example | |
1027 M-x replace-regexp @key{RET} c[ad]+r @key{RET} \&-safe @key{RET} | |
1028 @end example | |
1029 | |
1030 @noindent | |
1031 replaces (for example) @samp{cadr} with @samp{cadr-safe} and @samp{cddr} | |
1032 with @samp{cddr-safe}. | |
1033 | |
1034 @example | |
1035 M-x replace-regexp @key{RET} \(c[ad]+r\)-safe @key{RET} \1 @key{RET} | |
1036 @end example | |
1037 | |
1038 @noindent | |
56251
651f09f1cac0
(Regexp Replace): Rewrite description of \# \, and \?.
Richard M. Stallman <rms@gnu.org>
parents:
56247
diff
changeset
|
1039 performs the inverse transformation. To include a @samp{\} in the |
651f09f1cac0
(Regexp Replace): Rewrite description of \# \, and \?.
Richard M. Stallman <rms@gnu.org>
parents:
56247
diff
changeset
|
1040 text to replace with, you must enter @samp{\\}. |
25829 | 1041 |
56251
651f09f1cac0
(Regexp Replace): Rewrite description of \# \, and \?.
Richard M. Stallman <rms@gnu.org>
parents:
56247
diff
changeset
|
1042 You can also use Lisp expressions to calculate parts of the |
651f09f1cac0
(Regexp Replace): Rewrite description of \# \, and \?.
Richard M. Stallman <rms@gnu.org>
parents:
56247
diff
changeset
|
1043 replacement string. To do this, write @samp{\,} followed by the |
651f09f1cac0
(Regexp Replace): Rewrite description of \# \, and \?.
Richard M. Stallman <rms@gnu.org>
parents:
56247
diff
changeset
|
1044 expression in the replacement string. Each replacement calculates the |
56527
1e634b993162
(Regexp Replace): Further update text for new replacement operators.
Richard M. Stallman <rms@gnu.org>
parents:
56467
diff
changeset
|
1045 value of the expression and converts it to text without quoting (if |
1e634b993162
(Regexp Replace): Further update text for new replacement operators.
Richard M. Stallman <rms@gnu.org>
parents:
56467
diff
changeset
|
1046 it's a string, this means using the string's contents), and uses it in |
56251
651f09f1cac0
(Regexp Replace): Rewrite description of \# \, and \?.
Richard M. Stallman <rms@gnu.org>
parents:
56247
diff
changeset
|
1047 the replacement string in place of the expression itself. If the |
651f09f1cac0
(Regexp Replace): Rewrite description of \# \, and \?.
Richard M. Stallman <rms@gnu.org>
parents:
56247
diff
changeset
|
1048 expression is a symbol, one space in the replacement string after the |
56527
1e634b993162
(Regexp Replace): Further update text for new replacement operators.
Richard M. Stallman <rms@gnu.org>
parents:
56467
diff
changeset
|
1049 symbol name goes with the symbol name, so the value replaces them |
1e634b993162
(Regexp Replace): Further update text for new replacement operators.
Richard M. Stallman <rms@gnu.org>
parents:
56467
diff
changeset
|
1050 both. |
56251
651f09f1cac0
(Regexp Replace): Rewrite description of \# \, and \?.
Richard M. Stallman <rms@gnu.org>
parents:
56247
diff
changeset
|
1051 |
56527
1e634b993162
(Regexp Replace): Further update text for new replacement operators.
Richard M. Stallman <rms@gnu.org>
parents:
56467
diff
changeset
|
1052 Inside such an expression, you can use some special sequences. |
1e634b993162
(Regexp Replace): Further update text for new replacement operators.
Richard M. Stallman <rms@gnu.org>
parents:
56467
diff
changeset
|
1053 @samp{\&} and @samp{\@var{n}} refer here, as usual, to the entire |
1e634b993162
(Regexp Replace): Further update text for new replacement operators.
Richard M. Stallman <rms@gnu.org>
parents:
56467
diff
changeset
|
1054 match as a string, and to a submatch as a string. @var{n} may be |
1e634b993162
(Regexp Replace): Further update text for new replacement operators.
Richard M. Stallman <rms@gnu.org>
parents:
56467
diff
changeset
|
1055 multiple digits, and the value of @samp{\@var{n}} is @code{nil} if |
1e634b993162
(Regexp Replace): Further update text for new replacement operators.
Richard M. Stallman <rms@gnu.org>
parents:
56467
diff
changeset
|
1056 subexpression @var{n} did not match. You can also use @samp{\#&} and |
1e634b993162
(Regexp Replace): Further update text for new replacement operators.
Richard M. Stallman <rms@gnu.org>
parents:
56467
diff
changeset
|
1057 @samp{\#@var{n}} to refer to those matches as numbers (this is valid |
1e634b993162
(Regexp Replace): Further update text for new replacement operators.
Richard M. Stallman <rms@gnu.org>
parents:
56467
diff
changeset
|
1058 when the match or submatch has the form of a numeral). @samp{\#} here |
1e634b993162
(Regexp Replace): Further update text for new replacement operators.
Richard M. Stallman <rms@gnu.org>
parents:
56467
diff
changeset
|
1059 too stands for the number of already-completed replacements. |
56230
fe184d71d3cb
(Unconditional Replace): Use replace-string instead
David Kastrup <dak@gnu.org>
parents:
55693
diff
changeset
|
1060 |
fe184d71d3cb
(Unconditional Replace): Use replace-string instead
David Kastrup <dak@gnu.org>
parents:
55693
diff
changeset
|
1061 Repeating our example to exchange @samp{x} and @samp{y}, we can thus |
fe184d71d3cb
(Unconditional Replace): Use replace-string instead
David Kastrup <dak@gnu.org>
parents:
55693
diff
changeset
|
1062 do it also this way: |
fe184d71d3cb
(Unconditional Replace): Use replace-string instead
David Kastrup <dak@gnu.org>
parents:
55693
diff
changeset
|
1063 |
fe184d71d3cb
(Unconditional Replace): Use replace-string instead
David Kastrup <dak@gnu.org>
parents:
55693
diff
changeset
|
1064 @example |
fe184d71d3cb
(Unconditional Replace): Use replace-string instead
David Kastrup <dak@gnu.org>
parents:
55693
diff
changeset
|
1065 M-x replace-regexp @key{RET} \(x\)\|y @key{RET} |
fe184d71d3cb
(Unconditional Replace): Use replace-string instead
David Kastrup <dak@gnu.org>
parents:
55693
diff
changeset
|
1066 \,(if \1 "y" "x") @key{RET} |
fe184d71d3cb
(Unconditional Replace): Use replace-string instead
David Kastrup <dak@gnu.org>
parents:
55693
diff
changeset
|
1067 @end example |
fe184d71d3cb
(Unconditional Replace): Use replace-string instead
David Kastrup <dak@gnu.org>
parents:
55693
diff
changeset
|
1068 |
56527
1e634b993162
(Regexp Replace): Further update text for new replacement operators.
Richard M. Stallman <rms@gnu.org>
parents:
56467
diff
changeset
|
1069 For computing replacement strings for @samp{\,}, the @code{format} |
56778
aeee9d21eb4a
(Regexps): Correct cryptic @ref.
Luc Teirlinck <teirllm@auburn.edu>
parents:
56527
diff
changeset
|
1070 function is often useful (@pxref{Formatting Strings,,, elisp, The Emacs |
56527
1e634b993162
(Regexp Replace): Further update text for new replacement operators.
Richard M. Stallman <rms@gnu.org>
parents:
56467
diff
changeset
|
1071 Lisp Reference Manual}). For example, to add consecutively numbered |
56251
651f09f1cac0
(Regexp Replace): Rewrite description of \# \, and \?.
Richard M. Stallman <rms@gnu.org>
parents:
56247
diff
changeset
|
1072 strings like @samp{ABC00042} to columns 73 @w{to 80} (unless they are |
651f09f1cac0
(Regexp Replace): Rewrite description of \# \, and \?.
Richard M. Stallman <rms@gnu.org>
parents:
56247
diff
changeset
|
1073 already occupied), you can use |
56247
09f1db905d2e
(Regexp Replace): Some typo corrections and
David Kastrup <dak@gnu.org>
parents:
56230
diff
changeset
|
1074 |
09f1db905d2e
(Regexp Replace): Some typo corrections and
David Kastrup <dak@gnu.org>
parents:
56230
diff
changeset
|
1075 @example |
09f1db905d2e
(Regexp Replace): Some typo corrections and
David Kastrup <dak@gnu.org>
parents:
56230
diff
changeset
|
1076 M-x replace-regexp @key{RET} ^.\@{0,72\@}$ @key{RET} |
09f1db905d2e
(Regexp Replace): Some typo corrections and
David Kastrup <dak@gnu.org>
parents:
56230
diff
changeset
|
1077 \,(format "%-72sABC%05d" \& \#) @key{RET} |
09f1db905d2e
(Regexp Replace): Some typo corrections and
David Kastrup <dak@gnu.org>
parents:
56230
diff
changeset
|
1078 @end example |
09f1db905d2e
(Regexp Replace): Some typo corrections and
David Kastrup <dak@gnu.org>
parents:
56230
diff
changeset
|
1079 |
56251
651f09f1cac0
(Regexp Replace): Rewrite description of \# \, and \?.
Richard M. Stallman <rms@gnu.org>
parents:
56247
diff
changeset
|
1080 If you want to enter part of the replacement string by hand each |
651f09f1cac0
(Regexp Replace): Rewrite description of \# \, and \?.
Richard M. Stallman <rms@gnu.org>
parents:
56247
diff
changeset
|
1081 time, use @samp{\?} in the replacement string. Each replacement will |
56527
1e634b993162
(Regexp Replace): Further update text for new replacement operators.
Richard M. Stallman <rms@gnu.org>
parents:
56467
diff
changeset
|
1082 ask you to edit the replacement string in the minibuffer, putting |
1e634b993162
(Regexp Replace): Further update text for new replacement operators.
Richard M. Stallman <rms@gnu.org>
parents:
56467
diff
changeset
|
1083 point where the @samp{\?} was. For example, |
56230
fe184d71d3cb
(Unconditional Replace): Use replace-string instead
David Kastrup <dak@gnu.org>
parents:
55693
diff
changeset
|
1084 |
fe184d71d3cb
(Unconditional Replace): Use replace-string instead
David Kastrup <dak@gnu.org>
parents:
55693
diff
changeset
|
1085 @example |
56871
cd2d19602e50
(Regexp Replace): Add missing backslash to \footnote.
Juri Linkov <juri@jurta.org>
parents:
56778
diff
changeset
|
1086 M-x replace-regexp @key{RET} \\footnote@{ @key{RET} |
56230
fe184d71d3cb
(Unconditional Replace): Use replace-string instead
David Kastrup <dak@gnu.org>
parents:
55693
diff
changeset
|
1087 \&\\label@{fn:\#\?@} @key{RET} |
fe184d71d3cb
(Unconditional Replace): Use replace-string instead
David Kastrup <dak@gnu.org>
parents:
55693
diff
changeset
|
1088 @end example |
fe184d71d3cb
(Unconditional Replace): Use replace-string instead
David Kastrup <dak@gnu.org>
parents:
55693
diff
changeset
|
1089 |
fe184d71d3cb
(Unconditional Replace): Use replace-string instead
David Kastrup <dak@gnu.org>
parents:
55693
diff
changeset
|
1090 @noindent |
56778
aeee9d21eb4a
(Regexps): Correct cryptic @ref.
Luc Teirlinck <teirllm@auburn.edu>
parents:
56527
diff
changeset
|
1091 will add labels starting with @samp{\label@{fn:0@}} to occurrences of |
56230
fe184d71d3cb
(Unconditional Replace): Use replace-string instead
David Kastrup <dak@gnu.org>
parents:
55693
diff
changeset
|
1092 @samp{\footnote@{}, but letting you edit each replacement before |
56251
651f09f1cac0
(Regexp Replace): Rewrite description of \# \, and \?.
Richard M. Stallman <rms@gnu.org>
parents:
56247
diff
changeset
|
1093 performing it. To number the labels starting at 1, use @samp{\,(1+ |
651f09f1cac0
(Regexp Replace): Rewrite description of \# \, and \?.
Richard M. Stallman <rms@gnu.org>
parents:
56247
diff
changeset
|
1094 \#)} instead of @samp{\#}. |
56230
fe184d71d3cb
(Unconditional Replace): Use replace-string instead
David Kastrup <dak@gnu.org>
parents:
55693
diff
changeset
|
1095 |
25829 | 1096 @node Replacement and Case, Query Replace, Regexp Replace, Replace |
1097 @subsection Replace Commands and Case | |
1098 | |
1099 If the first argument of a replace command is all lower case, the | |
38016 | 1100 command ignores case while searching for occurrences to |
25829 | 1101 replace---provided @code{case-fold-search} is non-@code{nil}. If |
1102 @code{case-fold-search} is set to @code{nil}, case is always significant | |
1103 in all searches. | |
1104 | |
1105 @vindex case-replace | |
1106 In addition, when the @var{newstring} argument is all or partly lower | |
1107 case, replacement commands try to preserve the case pattern of each | |
1108 occurrence. Thus, the command | |
1109 | |
1110 @example | |
1111 M-x replace-string @key{RET} foo @key{RET} bar @key{RET} | |
1112 @end example | |
1113 | |
1114 @noindent | |
1115 replaces a lower case @samp{foo} with a lower case @samp{bar}, an | |
1116 all-caps @samp{FOO} with @samp{BAR}, and a capitalized @samp{Foo} with | |
1117 @samp{Bar}. (These three alternatives---lower case, all caps, and | |
1118 capitalized, are the only ones that @code{replace-string} can | |
1119 distinguish.) | |
1120 | |
1121 If upper-case letters are used in the replacement string, they remain | |
1122 upper case every time that text is inserted. If upper-case letters are | |
1123 used in the first argument, the second argument is always substituted | |
1124 exactly as given, with no case conversion. Likewise, if either | |
1125 @code{case-replace} or @code{case-fold-search} is set to @code{nil}, | |
1126 replacement is done without case conversion. | |
1127 | |
1128 @node Query Replace,, Replacement and Case, Replace | |
1129 @subsection Query Replace | |
1130 @cindex query replace | |
1131 | |
1132 @table @kbd | |
1133 @item M-% @var{string} @key{RET} @var{newstring} @key{RET} | |
1134 @itemx M-x query-replace @key{RET} @var{string} @key{RET} @var{newstring} @key{RET} | |
1135 Replace some occurrences of @var{string} with @var{newstring}. | |
1136 @item C-M-% @var{regexp} @key{RET} @var{newstring} @key{RET} | |
1137 @itemx M-x query-replace-regexp @key{RET} @var{regexp} @key{RET} @var{newstring} @key{RET} | |
1138 Replace some matches for @var{regexp} with @var{newstring}. | |
1139 @end table | |
1140 | |
1141 @kindex M-% | |
1142 @findex query-replace | |
1143 If you want to change only some of the occurrences of @samp{foo} to | |
1144 @samp{bar}, not all of them, then you cannot use an ordinary | |
1145 @code{replace-string}. Instead, use @kbd{M-%} (@code{query-replace}). | |
1146 This command finds occurrences of @samp{foo} one by one, displays each | |
37235
a60e4b9d5ba3
Mention there are other search-terminating Meta chars.
Richard M. Stallman <rms@gnu.org>
parents:
37069
diff
changeset
|
1147 occurrence and asks you whether to replace it. Aside from querying, |
a60e4b9d5ba3
Mention there are other search-terminating Meta chars.
Richard M. Stallman <rms@gnu.org>
parents:
37069
diff
changeset
|
1148 @code{query-replace} works just like @code{replace-string}. It |
a60e4b9d5ba3
Mention there are other search-terminating Meta chars.
Richard M. Stallman <rms@gnu.org>
parents:
37069
diff
changeset
|
1149 preserves case, like @code{replace-string}, provided |
a60e4b9d5ba3
Mention there are other search-terminating Meta chars.
Richard M. Stallman <rms@gnu.org>
parents:
37069
diff
changeset
|
1150 @code{case-replace} is non-@code{nil}, as it normally is. A numeric |
a60e4b9d5ba3
Mention there are other search-terminating Meta chars.
Richard M. Stallman <rms@gnu.org>
parents:
37069
diff
changeset
|
1151 argument means consider only occurrences that are bounded by |
a60e4b9d5ba3
Mention there are other search-terminating Meta chars.
Richard M. Stallman <rms@gnu.org>
parents:
37069
diff
changeset
|
1152 word-delimiter characters. |
25829 | 1153 |
1154 @kindex C-M-% | |
1155 @findex query-replace-regexp | |
37235
a60e4b9d5ba3
Mention there are other search-terminating Meta chars.
Richard M. Stallman <rms@gnu.org>
parents:
37069
diff
changeset
|
1156 @kbd{C-M-%} performs regexp search and replace (@code{query-replace-regexp}). |
59428
856e8ee31fcb
(Query Replace): Mention faces query-replace and lazy-highlight.
Richard M. Stallman <rms@gnu.org>
parents:
58436
diff
changeset
|
1157 It works like @code{replace-regexp} except that it queries |
856e8ee31fcb
(Query Replace): Mention faces query-replace and lazy-highlight.
Richard M. Stallman <rms@gnu.org>
parents:
58436
diff
changeset
|
1158 like @code{query-replace}. |
856e8ee31fcb
(Query Replace): Mention faces query-replace and lazy-highlight.
Richard M. Stallman <rms@gnu.org>
parents:
58436
diff
changeset
|
1159 |
856e8ee31fcb
(Query Replace): Mention faces query-replace and lazy-highlight.
Richard M. Stallman <rms@gnu.org>
parents:
58436
diff
changeset
|
1160 @cindex faces for highlighting query replace |
856e8ee31fcb
(Query Replace): Mention faces query-replace and lazy-highlight.
Richard M. Stallman <rms@gnu.org>
parents:
58436
diff
changeset
|
1161 These commands highlight the current match using the face |
856e8ee31fcb
(Query Replace): Mention faces query-replace and lazy-highlight.
Richard M. Stallman <rms@gnu.org>
parents:
58436
diff
changeset
|
1162 @code{query-replace}. They highlight other matches using |
856e8ee31fcb
(Query Replace): Mention faces query-replace and lazy-highlight.
Richard M. Stallman <rms@gnu.org>
parents:
58436
diff
changeset
|
1163 @code{lazy-highlight} just like incremental search (@pxref{Incremental |
856e8ee31fcb
(Query Replace): Mention faces query-replace and lazy-highlight.
Richard M. Stallman <rms@gnu.org>
parents:
58436
diff
changeset
|
1164 Search}). |
25829 | 1165 |
37235
a60e4b9d5ba3
Mention there are other search-terminating Meta chars.
Richard M. Stallman <rms@gnu.org>
parents:
37069
diff
changeset
|
1166 The characters you can type when you are shown a match for the string |
a60e4b9d5ba3
Mention there are other search-terminating Meta chars.
Richard M. Stallman <rms@gnu.org>
parents:
37069
diff
changeset
|
1167 or regexp are: |
25829 | 1168 |
1169 @ignore @c Not worth it. | |
1170 @kindex SPC @r{(query-replace)} | |
1171 @kindex DEL @r{(query-replace)} | |
1172 @kindex , @r{(query-replace)} | |
1173 @kindex RET @r{(query-replace)} | |
1174 @kindex . @r{(query-replace)} | |
1175 @kindex ! @r{(query-replace)} | |
1176 @kindex ^ @r{(query-replace)} | |
1177 @kindex C-r @r{(query-replace)} | |
1178 @kindex C-w @r{(query-replace)} | |
1179 @kindex C-l @r{(query-replace)} | |
1180 @end ignore | |
1181 | |
1182 @c WideCommands | |
1183 @table @kbd | |
1184 @item @key{SPC} | |
1185 to replace the occurrence with @var{newstring}. | |
1186 | |
1187 @item @key{DEL} | |
1188 to skip to the next occurrence without replacing this one. | |
1189 | |
1190 @item , @r{(Comma)} | |
1191 to replace this occurrence and display the result. You are then asked | |
1192 for another input character to say what to do next. Since the | |
1193 replacement has already been made, @key{DEL} and @key{SPC} are | |
1194 equivalent in this situation; both move to the next occurrence. | |
1195 | |
1196 You can type @kbd{C-r} at this point (see below) to alter the replaced | |
1197 text. You can also type @kbd{C-x u} to undo the replacement; this exits | |
1198 the @code{query-replace}, so if you want to do further replacement you | |
1199 must use @kbd{C-x @key{ESC} @key{ESC} @key{RET}} to restart | |
1200 (@pxref{Repetition}). | |
1201 | |
1202 @item @key{RET} | |
1203 to exit without doing any more replacements. | |
1204 | |
1205 @item .@: @r{(Period)} | |
1206 to replace this occurrence and then exit without searching for more | |
1207 occurrences. | |
1208 | |
1209 @item ! | |
1210 to replace all remaining occurrences without asking again. | |
1211 | |
1212 @item ^ | |
1213 to go back to the position of the previous occurrence (or what used to | |
56230
fe184d71d3cb
(Unconditional Replace): Use replace-string instead
David Kastrup <dak@gnu.org>
parents:
55693
diff
changeset
|
1214 be an occurrence), in case you changed it by mistake or want to |
fe184d71d3cb
(Unconditional Replace): Use replace-string instead
David Kastrup <dak@gnu.org>
parents:
55693
diff
changeset
|
1215 reexamine it. |
25829 | 1216 |
1217 @item C-r | |
1218 to enter a recursive editing level, in case the occurrence needs to be | |
1219 edited rather than just replaced with @var{newstring}. When you are | |
1220 done, exit the recursive editing level with @kbd{C-M-c} to proceed to | |
1221 the next occurrence. @xref{Recursive Edit}. | |
1222 | |
1223 @item C-w | |
1224 to delete the occurrence, and then enter a recursive editing level as in | |
1225 @kbd{C-r}. Use the recursive edit to insert text to replace the deleted | |
1226 occurrence of @var{string}. When done, exit the recursive editing level | |
1227 with @kbd{C-M-c} to proceed to the next occurrence. | |
1228 | |
36177
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
1229 @item e |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
1230 to edit the replacement string in the minibuffer. When you exit the |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
1231 minibuffer by typing @key{RET}, the minibuffer contents replace the |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
1232 current occurrence of the pattern. They also become the new |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
1233 replacement string for any further occurrences. |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
1234 |
25829 | 1235 @item C-l |
1236 to redisplay the screen. Then you must type another character to | |
1237 specify what to do with this occurrence. | |
1238 | |
1239 @item C-h | |
1240 to display a message summarizing these options. Then you must type | |
1241 another character to specify what to do with this occurrence. | |
1242 @end table | |
1243 | |
1244 Some other characters are aliases for the ones listed above: @kbd{y}, | |
1245 @kbd{n} and @kbd{q} are equivalent to @key{SPC}, @key{DEL} and | |
1246 @key{RET}. | |
1247 | |
1248 Aside from this, any other character exits the @code{query-replace}, | |
1249 and is then reread as part of a key sequence. Thus, if you type | |
1250 @kbd{C-k}, it exits the @code{query-replace} and then kills to end of | |
1251 line. | |
1252 | |
1253 To restart a @code{query-replace} once it is exited, use @kbd{C-x | |
1254 @key{ESC} @key{ESC}}, which repeats the @code{query-replace} because it | |
1255 used the minibuffer to read its arguments. @xref{Repetition, C-x ESC | |
1256 ESC}. | |
1257 | |
1258 See also @ref{Transforming File Names}, for Dired commands to rename, | |
1259 copy, or link files by replacing regexp matches in file names. | |
1260 | |
1261 @node Other Repeating Search,, Replace, Search | |
1262 @section Other Search-and-Loop Commands | |
1263 | |
1264 Here are some other commands that find matches for a regular | |
36177
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
1265 expression. They all ignore case in matching, if the pattern contains |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
1266 no upper-case letters and @code{case-fold-search} is non-@code{nil}. |
44823
230b150398fa
Document `multi-occur' and `multi-occur-by-filename-regexp'.
Colin Walters <walters@gnu.org>
parents:
44062
diff
changeset
|
1267 Aside from @code{occur} and its variants, all operate on the text from |
230b150398fa
Document `multi-occur' and `multi-occur-by-filename-regexp'.
Colin Walters <walters@gnu.org>
parents:
44062
diff
changeset
|
1268 point to the end of the buffer, or on the active region in Transient |
230b150398fa
Document `multi-occur' and `multi-occur-by-filename-regexp'.
Colin Walters <walters@gnu.org>
parents:
44062
diff
changeset
|
1269 Mark mode. |
25829 | 1270 |
1271 @findex list-matching-lines | |
1272 @findex occur | |
44823
230b150398fa
Document `multi-occur' and `multi-occur-by-filename-regexp'.
Colin Walters <walters@gnu.org>
parents:
44062
diff
changeset
|
1273 @findex multi-occur |
230b150398fa
Document `multi-occur' and `multi-occur-by-filename-regexp'.
Colin Walters <walters@gnu.org>
parents:
44062
diff
changeset
|
1274 @findex multi-occur-by-filename-regexp |
32035
396b07cf1395
(Other Repeating Search): Describe `how-many'
Gerd Moellmann <gerd@gnu.org>
parents:
31072
diff
changeset
|
1275 @findex how-many |
25829 | 1276 @findex delete-non-matching-lines |
1277 @findex delete-matching-lines | |
1278 @findex flush-lines | |
1279 @findex keep-lines | |
1280 | |
1281 @table @kbd | |
1282 @item M-x occur @key{RET} @var{regexp} @key{RET} | |
36177
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
1283 Display a list showing each line in the buffer that contains a match |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
1284 for @var{regexp}. To limit the search to part of the buffer, narrow |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
1285 to that part (@pxref{Narrowing}). A numeric argument @var{n} |
36383
d26ad6e1f13f
Change "filename" to "file name" or "file-name".
Eli Zaretskii <eliz@gnu.org>
parents:
36263
diff
changeset
|
1286 specifies that @var{n} lines of context are to be displayed before and |
d26ad6e1f13f
Change "filename" to "file name" or "file-name".
Eli Zaretskii <eliz@gnu.org>
parents:
36263
diff
changeset
|
1287 after each matching line. |
25829 | 1288 |
1289 @kindex RET @r{(Occur mode)} | |
46213
cb646c9b4af6
Document o and C-o in Occur mode.
Richard M. Stallman <rms@gnu.org>
parents:
46193
diff
changeset
|
1290 @kindex o @r{(Occur mode)} |
cb646c9b4af6
Document o and C-o in Occur mode.
Richard M. Stallman <rms@gnu.org>
parents:
46193
diff
changeset
|
1291 @kindex C-o @r{(Occur mode)} |
25829 | 1292 The buffer @samp{*Occur*} containing the output serves as a menu for |
46213
cb646c9b4af6
Document o and C-o in Occur mode.
Richard M. Stallman <rms@gnu.org>
parents:
46193
diff
changeset
|
1293 finding the occurrences in their original context. Click |
cb646c9b4af6
Document o and C-o in Occur mode.
Richard M. Stallman <rms@gnu.org>
parents:
46193
diff
changeset
|
1294 @kbd{Mouse-2} on an occurrence listed in @samp{*Occur*}, or position |
cb646c9b4af6
Document o and C-o in Occur mode.
Richard M. Stallman <rms@gnu.org>
parents:
46193
diff
changeset
|
1295 point there and type @key{RET}; this switches to the buffer that was |
cb646c9b4af6
Document o and C-o in Occur mode.
Richard M. Stallman <rms@gnu.org>
parents:
46193
diff
changeset
|
1296 searched and moves point to the original of the chosen occurrence. |
cb646c9b4af6
Document o and C-o in Occur mode.
Richard M. Stallman <rms@gnu.org>
parents:
46193
diff
changeset
|
1297 @kbd{o} and @kbd{C-o} display the match in another window; @kbd{C-o} |
cb646c9b4af6
Document o and C-o in Occur mode.
Richard M. Stallman <rms@gnu.org>
parents:
46193
diff
changeset
|
1298 does not select it. |
25829 | 1299 |
56874
78f410cd4bda
(Other Repeating Search): Mention that Occur mode
Juri Linkov <juri@jurta.org>
parents:
56871
diff
changeset
|
1300 Occur mode supports the @code{next-error} functionality described in |
78f410cd4bda
(Other Repeating Search): Mention that Occur mode
Juri Linkov <juri@jurta.org>
parents:
56871
diff
changeset
|
1301 in @ref{Compilation Mode}. |
78f410cd4bda
(Other Repeating Search): Mention that Occur mode
Juri Linkov <juri@jurta.org>
parents:
56871
diff
changeset
|
1302 |
25829 | 1303 @item M-x list-matching-lines |
1304 Synonym for @kbd{M-x occur}. | |
1305 | |
44823
230b150398fa
Document `multi-occur' and `multi-occur-by-filename-regexp'.
Colin Walters <walters@gnu.org>
parents:
44062
diff
changeset
|
1306 @item M-x multi-occur @key{RET} @var{buffers} @key{RET} @var{regexp} @key{RET} |
44858
b0768ec46559
Fix Texinfo usage in previous change.
Richard M. Stallman <rms@gnu.org>
parents:
44823
diff
changeset
|
1307 This function is just like @code{occur}, except it is able to search |
44823
230b150398fa
Document `multi-occur' and `multi-occur-by-filename-regexp'.
Colin Walters <walters@gnu.org>
parents:
44062
diff
changeset
|
1308 through multiple buffers. |
230b150398fa
Document `multi-occur' and `multi-occur-by-filename-regexp'.
Colin Walters <walters@gnu.org>
parents:
44062
diff
changeset
|
1309 |
230b150398fa
Document `multi-occur' and `multi-occur-by-filename-regexp'.
Colin Walters <walters@gnu.org>
parents:
44062
diff
changeset
|
1310 @item M-x multi-occur-by-filename-regexp @key{RET} @var{bufregexp} @key{RET} @var{regexp} @key{RET} |
44858
b0768ec46559
Fix Texinfo usage in previous change.
Richard M. Stallman <rms@gnu.org>
parents:
44823
diff
changeset
|
1311 This function is similar to @code{multi-occur}, except the buffers to |
44823
230b150398fa
Document `multi-occur' and `multi-occur-by-filename-regexp'.
Colin Walters <walters@gnu.org>
parents:
44062
diff
changeset
|
1312 search are specified by a regexp on their filename. |
230b150398fa
Document `multi-occur' and `multi-occur-by-filename-regexp'.
Colin Walters <walters@gnu.org>
parents:
44062
diff
changeset
|
1313 |
32035
396b07cf1395
(Other Repeating Search): Describe `how-many'
Gerd Moellmann <gerd@gnu.org>
parents:
31072
diff
changeset
|
1314 @item M-x how-many @key{RET} @var{regexp} @key{RET} |
36177
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
1315 Print the number of matches for @var{regexp} that exist in the buffer |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
1316 after point. In Transient Mark mode, if the region is active, the |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
1317 command operates on the region instead. |
25829 | 1318 |
1319 @item M-x flush-lines @key{RET} @var{regexp} @key{RET} | |
36177
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
1320 Delete each line that contains a match for @var{regexp}, operating on |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
1321 the text after point. In Transient Mark mode, if the region is |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
1322 active, the command operates on the region instead. |
25829 | 1323 |
1324 @item M-x keep-lines @key{RET} @var{regexp} @key{RET} | |
36177
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
1325 Delete each line that @emph{does not} contain a match for |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
1326 @var{regexp}, operating on the text after point. In Transient Mark |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
1327 mode, if the region is active, the command operates on the region |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
1328 instead. |
25829 | 1329 @end table |
1330 | |
36177
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
1331 You can also search multiple files under control of a tags table |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
1332 (@pxref{Tags Search}) or through Dired @kbd{A} command |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
1333 (@pxref{Operating on Files}), or ask the @code{grep} program to do it |
548a3aac5d5d
Comment out description of re-builder.
Richard M. Stallman <rms@gnu.org>
parents:
36058
diff
changeset
|
1334 (@pxref{Grep Searching}). |
52401 | 1335 |
1336 @ignore | |
1337 arch-tag: fd9d8e77-66af-491c-b212-d80999613e3e | |
1338 @end ignore |