diff options
author | Lars Ingebrigtsen <larsi@gnus.org> | 2020-12-09 20:40:03 +0100 |
---|---|---|
committer | Lars Ingebrigtsen <larsi@gnus.org> | 2020-12-09 20:40:10 +0100 |
commit | 7f42cab82cf7aa5435400a03007ffb85590b39e5 (patch) | |
tree | 61f6d09c87e81c57577e982e993a3d39c3a8bb83 /src/window.c | |
parent | b71be20eaff7b3b13c67515e7919d36ecbd7b22b (diff) | |
download | emacs-7f42cab82cf7aa5435400a03007ffb85590b39e5.tar.gz |
Clarify `scroll-preserve-screen-position' doc string
* src/window.c (syms_of_window): Clarify the doc string (bug#7910).
Diffstat (limited to 'src/window.c')
-rw-r--r-- | src/window.c | 8 |
1 files changed, 7 insertions, 1 deletions
diff --git a/src/window.c b/src/window.c index 5df3e37fbe2..8e75e460b2b 100644 --- a/src/window.c +++ b/src/window.c @@ -8246,11 +8246,17 @@ is displayed in the `mode-line' face. */); DEFVAR_LISP ("scroll-preserve-screen-position", Vscroll_preserve_screen_position, doc: /* Controls if scroll commands move point to keep its screen position unchanged. + A value of nil means point does not keep its screen position except at the scroll margin or window boundary respectively. + A value of t means point keeps its screen position if the scroll command moved it vertically out of the window, e.g. when scrolling -by full screens. +by full screens. If point is within `next-screen-context-lines' lines +from the edges of the window, point will typically not keep its screen +position when doing commands like `scroll-up-command'/`scroll-down-command' +and the like. + Any other value means point always keeps its screen position. Scroll commands should have the `scroll-command' property on their symbols to be controlled by this variable. */); |