summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCharles A. Roelli <charles@aurox.ch>2018-10-28 18:07:01 +0100
committerCharles A. Roelli <charles@aurox.ch>2018-10-28 18:07:01 +0100
commit10e0fd8ca955070682d5f09231a7a386ef185fa5 (patch)
treee629b1a32b1b2947ab014141c99ccb911c6133d7
parentde2818432acacea4eec35d5a92f240856de7b765 (diff)
downloademacs-10e0fd8ca955070682d5f09231a7a386ef185fa5.tar.gz
Add index entries for more isearch commands/bindings (Bug#32990)
* doc/emacs/search.texi (Basic Isearch): Index isearch-exit, isearch-abort, isearch-cancel, isearch-repeat-forward, isearch-repeat-backward and their bindings. (Repeat Isearch): Index isearch-ring-advance, isearch-ring-retreat and isearch-edit-string. (Special Isearch): Index isearch-quote-char, isearch-char-by-name and their bindings. Index isearch-query-replace and isearch-query-replace-regexp, and the latter's binding. Explain what isearch-query-replace-regexp does. Index isearch-complete. (Word Search): Index isearch-toggle-word.
-rw-r--r--doc/emacs/search.texi117
1 files changed, 74 insertions, 43 deletions
diff --git a/doc/emacs/search.texi b/doc/emacs/search.texi
index 58a76580d76..33aa0dd1c7b 100644
--- a/doc/emacs/search.texi
+++ b/doc/emacs/search.texi
@@ -114,24 +114,30 @@ Isearch}, for more about dealing with unsuccessful search.
@cindex exit incremental search
@cindex incremental search, exiting
+@findex isearch-exit
+@kindex RET @r{(Incremental search)}
When you are satisfied with the place you have reached, type
-@key{RET}. This stops searching, leaving the cursor where the search
-brought it. Also, any command not specially meaningful in searches
-stops the searching and is then executed. Thus, typing @kbd{C-a}
-exits the search and then moves to the beginning of the line; typing
-one of the arrow keys exits the search and performs the respective
-movement command; etc. @key{RET} is necessary only if the next
-command you want to type is a printing character, @key{DEL},
-@key{RET}, or another character that is special within searches
-(@kbd{C-q}, @kbd{C-w}, @kbd{C-r}, @kbd{C-s}, @kbd{C-y}, @kbd{M-y},
-@kbd{M-r}, @kbd{M-c}, @kbd{M-e}, and some others described below).
-You can fine-tune the commands that exit the search; see @ref{Not
-Exiting Isearch}.
+@key{RET} (@code{isearch-exit}). This stops searching, leaving the
+cursor where the search brought it. Also, any command not specially
+meaningful in searches stops the searching and is then executed.
+Thus, typing @kbd{C-a} exits the search and then moves to the
+beginning of the line; typing one of the arrow keys exits the search
+and performs the respective movement command; etc. @key{RET} is
+necessary only if the next command you want to type is a printing
+character, @key{DEL}, @key{RET}, or another character that is special
+within searches (@kbd{C-q}, @kbd{C-w}, @kbd{C-r}, @kbd{C-s},
+@kbd{C-y}, @kbd{M-y}, @kbd{M-r}, @kbd{M-c}, @kbd{M-e}, and some others
+described below). You can fine-tune the commands that exit the
+search; see @ref{Not Exiting Isearch}.
As a special exception, entering @key{RET} when the search string is
empty launches nonincremental search (@pxref{Nonincremental Search}).
(This can be customized; see @ref{Search Customizations}.)
+@findex isearch-abort
+@findex isearch-cancel
+@kindex C-g C-g @r{(Incremental Search)}
+@kindex ESC ESC ESC @r{(Incremental Search)}
To abandon the search and return to the place where you started,
type @kbd{@key{ESC} @key{ESC} @key{ESC}} (@code{isearch-cancel}) or
@kbd{C-g C-g} (@code{isearch-abort}).
@@ -154,13 +160,18 @@ matches that begin after it.
@node Repeat Isearch
@subsection Repeating Incremental Search
+@kindex C-s @r{(Incremental Search)}
+@kindex C-r @r{(Incremental Search)}
+@findex isearch-repeat-forward
+@findex isearch-repeat-backward
Suppose you search forward for @samp{FOO} and find a match, but not
the one you expected to find: the @samp{FOO} you were aiming for
-occurs later in the buffer. In this event, type another @kbd{C-s} to
-move to the next occurrence of the search string. You can repeat this
-any number of times. If you overshoot, you can cancel some @kbd{C-s}
-characters with @key{DEL}. Similarly, each @kbd{C-r} in a backward
-incremental search repeats the backward search.
+occurs later in the buffer. In this event, type another @kbd{C-s}
+(@code{isearch-repeat-forward}) to move to the next occurrence of the
+search string. You can repeat this any number of times. If you
+overshoot, you can cancel some @kbd{C-s} commands with @key{DEL}.
+Similarly, each @kbd{C-r} (@code{isearch-repeat-backward}) in a
+backward incremental search repeats the backward search.
@cindex lazy search highlighting
If you pause for a little while during incremental search, Emacs
@@ -200,12 +211,15 @@ going past the original starting point of the search, it changes to
you have already seen.
@cindex search ring
+@findex isearch-ring-advance
+@findex isearch-ring-retreat
@kindex M-n @r{(Incremental search)}
@kindex M-p @r{(Incremental search)}
@vindex search-ring-max
To reuse earlier search strings, use the @dfn{search ring}. The
-commands @kbd{M-p} and @kbd{M-n} move through the ring to pick a
-search string to reuse. These commands leave the selected search ring
+commands @kbd{M-p} (@code{isearch-ring-retreat}) and @kbd{M-n}
+(@code{isearch-ring-advance}) move through the ring to pick a search
+string to reuse. These commands leave the selected search ring
element in the minibuffer, where you can edit it. Type
@kbd{C-s}/@kbd{C-r} or @key{RET} to accept the string and start
searching for it. The number of most recently used search strings
@@ -214,14 +228,16 @@ saved in the search ring is specified by the variable
@cindex incremental search, edit search string
@cindex interactively edit search string
+@findex isearch-edit-string
@kindex M-e @r{(Incremental search)}
@kindex mouse-1 @r{in the minibuffer (Incremental Search)}
To edit the current search string in the minibuffer without
-replacing it with items from the search ring, type @kbd{M-e} or click
-@kbd{mouse-1} in the minibuffer. Type @key{RET}, @kbd{C-s} or
-@kbd{C-r} to finish editing the string and search for it. Type
-@kbd{C-f} or @kbd{@key{RIGHT}} to add to the search string characters
-following point from the buffer from which you started the search.
+replacing it with items from the search ring, type @kbd{M-e}
+(@code{isearch-edit-string}) or click @kbd{mouse-1} in the minibuffer.
+Type @key{RET}, @kbd{C-s} or @kbd{C-r} to finish editing the string
+and search for it. Type @kbd{C-f} or @kbd{@key{RIGHT}} to add to the
+search string characters following point from the buffer from which
+you started the search.
@node Isearch Yank
@subsection Isearch Yanking
@@ -357,17 +373,22 @@ following methods:
@itemize @bullet
@item
-Type @kbd{C-q}, followed by a non-graphic character or a sequence of
-octal digits. This adds a character to the search string, similar to
-inserting into a buffer using @kbd{C-q} (@pxref{Inserting Text}). For
-example, @kbd{C-q C-s} during incremental search adds the
-@samp{control-S} character to the search string.
+@findex isearch-quote-char
+@kindex C-q @r{(Incremental Search)}
+Type @kbd{C-q} (@code{isearch-quote-char}), followed by a non-graphic
+character or a sequence of octal digits. This adds a character to the
+search string, similar to inserting into a buffer using @kbd{C-q}
+(@pxref{Inserting Text}). For example, @kbd{C-q C-s} during
+incremental search adds the @samp{control-S} character to the search
+string.
@item
-Type @kbd{C-x 8 @key{RET}}, followed by a Unicode name or code-point
-in hex. This adds the specified character into the search string,
-similar to the usual @code{insert-char} command (@pxref{Inserting
-Text}).
+@findex isearch-char-by-name
+@kindex C-x 8 RET @r{(Incremental Search)}
+Type @kbd{C-x 8 @key{RET}} (@code{isearch-char-by-name}), followed by
+a Unicode name or code-point in hex. This adds the specified
+character into the search string, similar to the usual
+@code{insert-char} command (@pxref{Inserting Text}).
@item
@kindex C-^ @r{(Incremental Search)}
@@ -400,12 +421,20 @@ current buffer afterwards.
@code{isearch-occur}, which runs @code{occur} with the current search
string. @xref{Other Repeating Search, occur}.
+@findex isearch-query-replace
+@findex isearch-query-replace-regexp
@kindex M-% @r{(Incremental search)}
- Typing @kbd{M-%} in incremental search invokes @code{query-replace}
-or @code{query-replace-regexp} (depending on search mode) with the
-current search string used as the string to replace. A negative
-prefix argument means to replace backward. @xref{Query Replace}.
-
+@kindex C-M-% @r{(Incremental search)}
+ Typing @kbd{M-%} (@code{isearch-query-replace}) in incremental
+search invokes @code{query-replace} or @code{query-replace-regexp}
+(depending on search mode) with the current search string used as the
+string to replace. A negative prefix argument means to replace
+backward. @xref{Query Replace}. Typing @kbd{C-M-%}
+(@code{isearch-query-replace-regexp}) invokes
+@code{query-replace-regexp} with the current search string used as the
+regexp to replace.
+
+@findex isearch-complete
@kindex M-TAB @r{(Incremental search)}
Typing @kbd{M-@key{TAB}} in incremental search invokes
@code{isearch-complete}, which attempts to complete the search string
@@ -599,15 +628,17 @@ Search backward for @var{words}, using a nonincremental word search.
Search the Web for the text in region.
@end table
-@kindex M-s w
@findex isearch-forward-word
+@findex isearch-toggle-word
+@kindex M-s w
To begin a forward incremental word search, type @kbd{M-s w}. If
incremental search is not already active, this runs the command
@code{isearch-forward-word}. If incremental search is already active
-(whether a forward or backward search), @kbd{M-s w} switches to a word
-search while keeping the direction of the search and the current
-search string unchanged. You can toggle word search back off by
-typing @kbd{M-s w} again.
+(whether a forward or backward search), @kbd{M-s w} runs the command
+@code{isearch-toggle-word}, which switches to a word search while
+keeping the direction of the search and the current search string
+unchanged. You can toggle word search back off by typing @kbd{M-s w}
+again.
@findex word-search-forward
@findex word-search-backward