aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEli Zaretskii2012-11-05 20:01:20 +0200
committerEli Zaretskii2012-11-05 20:01:20 +0200
commitbff6f2417efbcfa6247648b8750b4bf8f042f9d5 (patch)
tree273c82035774e45bd33a7636d3156bb8797446d4
parent508f51f5f41e1e7af50f5f215688ad77daec0f1a (diff)
downloademacs-bff6f2417efbcfa6247648b8750b4bf8f042f9d5.tar.gz
emacs-bff6f2417efbcfa6247648b8750b4bf8f042f9d5.zip
Clarify documentation of scroll-step, per bug #12801.
doc/emacs/display.texi (Auto Scrolling): Clarify that scroll-step is ignored when scroll-conservatively is set to a non-zero value.
-rw-r--r--doc/emacs/ChangeLog6
-rw-r--r--doc/emacs/display.texi27
2 files changed, 23 insertions, 10 deletions
diff --git a/doc/emacs/ChangeLog b/doc/emacs/ChangeLog
index a402c8a17a2..3413e93a3e8 100644
--- a/doc/emacs/ChangeLog
+++ b/doc/emacs/ChangeLog
@@ -1,3 +1,9 @@
12012-11-05 Eli Zaretskii <eliz@gnu.org>
2
3 * display.texi (Auto Scrolling): Clarify that scroll-step is
4 ignored when scroll-conservatively is set to a non-zero value.
5 (Bug#12801)
6
12012-11-05 Chong Yidong <cyd@gnu.org> 72012-11-05 Chong Yidong <cyd@gnu.org>
2 8
3 * dired.texi (Dired Updating): Doc fix (Bug#11744). 9 * dired.texi (Dired Updating): Doc fix (Bug#11744).
diff --git a/doc/emacs/display.texi b/doc/emacs/display.texi
index 90bfcf147c5..c40c545ec53 100644
--- a/doc/emacs/display.texi
+++ b/doc/emacs/display.texi
@@ -221,20 +221,27 @@ visible portion of the text.
221if you set @code{scroll-conservatively} to a small number @var{n}, 221if you set @code{scroll-conservatively} to a small number @var{n},
222then if you move point just a little off the screen (less than @var{n} 222then if you move point just a little off the screen (less than @var{n}
223lines), Emacs scrolls the text just far enough to bring point back on 223lines), Emacs scrolls the text just far enough to bring point back on
224screen. By default, @code{scroll-conservatively} is@tie{}0. If you 224screen. If doing so fails to make point visible, Emacs centers point
225set @code{scroll-conservatively} to a large number (larger than 100), 225in the window. By default, @code{scroll-conservatively} is@tie{}0.
226Emacs will never center point as result of scrolling, even if point 226If you set @code{scroll-conservatively} to a large number (larger than
227moves far away from the text previously displayed in the window. With 227100), Emacs will never center point as result of scrolling, even if
228such a large value, Emacs will always scroll text just enough for 228point moves far away from the text previously displayed in the window.
229With such a large value, Emacs will always scroll text just enough for
229bringing point into view, so point will end up at the top or bottom of 230bringing point into view, so point will end up at the top or bottom of
230the window, depending on the scroll direction. 231the window, depending on the scroll direction.
231 232
232@vindex scroll-step 233@vindex scroll-step
233 The variable @code{scroll-step} determines how many lines to scroll 234 An alternative way of controlling how Emacs scrolls text is by
234the window when point moves off the screen. If moving by that number 235customizing the variable @code{scroll-step}. Its value determines how
235of lines fails to bring point back into view, point is centered 236many lines to scroll the window when point moves off the screen. If
236instead. The default value is zero, which causes point to always be 237moving by that number of lines fails to bring point back into view,
237centered after scrolling. 238point is centered instead. The default value is zero, which causes
239point to always be centered after scrolling.
240
241 Since both @code{scroll-conservatively} and @code{scroll-step}
242control automatic scrolling in contradicting ways, you should set only
243one of them. If you customize both, the value of
244@code{scroll-conservatively} takes precedence.
238 245
239@cindex aggressive scrolling 246@cindex aggressive scrolling
240@vindex scroll-up-aggressively 247@vindex scroll-up-aggressively