procyberian/emacs
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

; Improve documentation of Isearch command properties

Browse source 
* doc/emacs/display.texi (Scrolling):
* doc/emacs/search.texi (Not Exiting Isearch): Improve
documentation and indexing of 'scroll-command',	'isearch-scroll',
and 'isearch-move' properties.
This commit is contained in:
Eli Zaretskii 2023-05-23 14:58:39 +03:00
parent a347b26cba
commit 117b29c6f6
2 changed files with 24 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

5
doc/emacs/display.texi
View file

@ -127,7 +127,10 @@ command leaves point in the window. This variable affects all the
scroll commands documented in this section, as well as scrolling with scroll commands documented in this section, as well as scrolling with
the mouse wheel (@pxref{Mouse Commands}); in general, it affects any the mouse wheel (@pxref{Mouse Commands}); in general, it affects any
command that has a non-@code{nil} @code{scroll-command} property. command that has a non-@code{nil} @code{scroll-command} property.
@xref{Property Lists,,, elisp, The Emacs Lisp Reference Manual}. @xref{Property Lists,,, elisp, The Emacs Lisp Reference Manual}. The
same property also causes Emacs not to exit incremental search when
one of these commands is invoked and @code{isearch-allow-scroll} is
non-@code{nil} (@pxref{Not Exiting Isearch}).
@vindex fast-but-imprecise-scrolling @vindex fast-but-imprecise-scrolling
Sometimes, particularly when you hold down keys such as @kbd{C-v} Sometimes, particularly when you hold down keys such as @kbd{C-v}

35
doc/emacs/search.texi
View file

@ -587,26 +587,30 @@ i.e., they don't terminate the search, even if
@item Scrolling Commands @item Scrolling Commands
@cindex scrolling commands, during incremental search @cindex scrolling commands, during incremental search
@vindex isearch-allow-scroll @vindex isearch-allow-scroll
Normally, scrolling commands exit incremental search. If you change @cindex @code{scroll-command} property, and incremental search
the variable @code{isearch-allow-scroll} to a non-@code{nil} value, Normally, scrolling commands exit incremental search. But if you
that enables the use of the scroll-bar, as well as keyboard scrolling change the variable @code{isearch-allow-scroll} to a non-@code{nil}
commands like @kbd{C-v}, @kbd{M-v}, and @kbd{C-l} (@pxref{Scrolling}). value, that enables the use of the scroll-bar, as well as keyboard
This applies only to calling these commands via their bound key scrolling commands like @kbd{C-v}, @kbd{M-v}, and @kbd{C-l}
sequences---typing @kbd{M-x} will still exit the search. You can give (@pxref{Scrolling}), which have a non-@code{nil} @code{scroll-command}
prefix arguments to these commands in the usual way. This feature property, without exiting the search. This applies only to calling
normally won't let you scroll the current match out of visibility; but these commands via their bound key sequences---typing @kbd{M-x} will
if you customize @code{isearch-allow-scroll} to the special value still exit the search. You can give prefix arguments to these
@code{unlimited}, that restriction is lifted. commands in the usual way. This feature normally won't let you scroll
the current match out of visibility; but if you customize
@code{isearch-allow-scroll} to the special value @code{unlimited},
that restriction is lifted.
@cindex @code{isearch-scroll} property
@cindex prevent commands from exiting incremental search
The @code{isearch-allow-scroll} feature also affects some other The @code{isearch-allow-scroll} feature also affects some other
commands, such as @kbd{C-x 2} (@code{split-window-below}) and commands, such as @kbd{C-x 2} (@code{split-window-below}) and
@kbd{C-x ^} (@code{enlarge-window}), which don't exactly scroll but do @kbd{C-x ^} (@code{enlarge-window}), which don't exactly scroll but do
affect where the text appears on the screen. It applies to any affect where the text appears on the screen. In fact, it affects
command whose name has a non-@code{nil} @code{isearch-scroll} any command that has a non-@code{nil} @code{isearch-scroll} property.
property. So you can control which commands are affected by changing So you can control which commands are affected by changing these
these properties. properties.
@cindex prevent commands from exiting incremental search
For example, to make @kbd{C-h l} usable within an incremental search For example, to make @kbd{C-h l} usable within an incremental search
in all future Emacs sessions, use @kbd{C-h c} to find what command it in all future Emacs sessions, use @kbd{C-h c} to find what command it
runs (@pxref{Key Help}), which is @code{view-lossage}. Then you can runs (@pxref{Key Help}), which is @code{view-lossage}. Then you can
@ -643,6 +647,7 @@ you can extend the search string by holding down the shift key while
typing cursor motion commands. It will yank text that ends at the new typing cursor motion commands. It will yank text that ends at the new
position after moving point in the current buffer. position after moving point in the current buffer.
@cindex @code{isearch-move} property
When @code{isearch-yank-on-move} is @code{t}, you can extend the When @code{isearch-yank-on-move} is @code{t}, you can extend the
search string without using the shift key for cursor motion commands, search string without using the shift key for cursor motion commands,
but it applies only for certain motion command that have the but it applies only for certain motion command that have the