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