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

Clarify documentation of scroll-step, per bug #12801.

Browse source 
doc/emacs/display.texi (Auto Scrolling): Clarify that scroll-step is
 ignored when scroll-conservatively is set to a non-zero value.
This commit is contained in:
Eli Zaretskii 2012-11-05 20:01:20 +02:00
parent 508f51f5f4
commit bff6f2417e
2 changed files with 23 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
doc/emacs/ChangeLog
View file

@ -1,3 +1,9 @@
2012-11-05 Eli Zaretskii <eliz@gnu.org>
* display.texi (Auto Scrolling): Clarify that scroll-step is
ignored when scroll-conservatively is set to a non-zero value.
(Bug#12801)
2012-11-05 Chong Yidong <cyd@gnu.org>
* dired.texi (Dired Updating): Doc fix (Bug#11744).

27
doc/emacs/display.texi
View file

@ -221,20 +221,27 @@ visible portion of the text.
if you set @code{scroll-conservatively} to a small number @var{n},
then if you move point just a little off the screen (less than @var{n}
lines), Emacs scrolls the text just far enough to bring point back on
screen. By default, @code{scroll-conservatively} is@tie{}0. If you
set @code{scroll-conservatively} to a large number (larger than 100),
Emacs will never center point as result of scrolling, even if point
moves far away from the text previously displayed in the window. With
such a large value, Emacs will always scroll text just enough for
screen. If doing so fails to make point visible, Emacs centers point
in the window. By default, @code{scroll-conservatively} is@tie{}0.
If you set @code{scroll-conservatively} to a large number (larger than
100), Emacs will never center point as result of scrolling, even if
point moves far away from the text previously displayed in the window.
With such a large value, Emacs will always scroll text just enough for
bringing point into view, so point will end up at the top or bottom of
the window, depending on the scroll direction.
@vindex scroll-step
The variable @code{scroll-step} determines how many lines to scroll
the window when point moves off the screen. If moving by that number
of lines fails to bring point back into view, point is centered
instead. The default value is zero, which causes point to always be
centered after scrolling.
An alternative way of controlling how Emacs scrolls text is by
customizing the variable @code{scroll-step}. Its value determines how
many lines to scroll the window when point moves off the screen. If
moving by that number of lines fails to bring point back into view,
point is centered instead. The default value is zero, which causes
point to always be centered after scrolling.
Since both @code{scroll-conservatively} and @code{scroll-step}
control automatic scrolling in contradicting ways, you should set only
one of them. If you customize both, the value of
@code{scroll-conservatively} takes precedence.
@cindex aggressive scrolling
@vindex scroll-up-aggressively