summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorzeertzjq <zeertzjq@outlook.com>2023-09-28 01:00:12 +0800
committerGitHub <noreply@github.com>2023-09-27 19:00:12 +0200
commit5277cfaf8afe847b7d4dcde6057fbecb001ab64e (patch)
treef162099e5cf55dc4a49ab18243d08c02b9eafb35
parent54f70cf0780a797efaf0ff9fd4190215a3ff0eb7 (diff)
runtime(doc): mention mouse scrolling in scrollbind-quickadj (#13190)
Signed-off-by: Christian Brabandt <cb@256bit.org>
-rw-r--r--runtime/doc/options.txt6
-rw-r--r--runtime/doc/scroll.txt15
2 files changed, 11 insertions, 10 deletions
diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt
index c5123289ad..f7606397d9 100644
--- a/runtime/doc/options.txt
+++ b/runtime/doc/options.txt
@@ -6757,9 +6757,9 @@ A jump table for the options with a short description can be found at |Q_op|.
*'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
'scrollbind' 'scb' boolean (default off)
local to window
- See also |scroll-binding|. When this option is set, the current
- window scrolls as other scrollbind windows (windows that also have
- this option set) scroll. This option is useful for viewing the
+ See also |scroll-binding|. When this option is set, scrolling the
+ current window also scrolls other scrollbind windows (windows that
+ also have this option set). This option is useful for viewing the
differences between two versions of a file, see 'diff'.
See |'scrollopt'| for options that determine how this option should be
interpreted.
diff --git a/runtime/doc/scroll.txt b/runtime/doc/scroll.txt
index 8e57be441c..91fa22824f 100644
--- a/runtime/doc/scroll.txt
+++ b/runtime/doc/scroll.txt
@@ -191,16 +191,16 @@ windows can be given this behavior by setting the (window-specific)
other 'scrollbind' windows are scrolled the same amount, if possible. The
behavior of 'scrollbind' can be modified by the 'scrollopt' option.
-When using the scrollbars, the binding only happens when scrolling the window
-with focus (where the cursor is). You can use this to avoid scroll-binding
-for a moment without resetting options.
+When using the scrollbars or the mouse wheel, the binding only happens when
+scrolling the window with focus (where the cursor is). You can use this to
+avoid scroll-binding for a moment without resetting options.
When a window also has the 'diff' option set, the scroll-binding uses the
differences between the two buffers to synchronize the position precisely.
Otherwise the following method is used.
*scrollbind-relative*
-Each 'scrollbind' window keeps track of its "relative offset," which can be
+Each 'scrollbind' window keeps track of its "relative offset", which can be
thought of as the difference between the current window's vertical scroll
position and the other window's vertical scroll position. When one of the
'scrollbind' windows is asked to vertically scroll past the beginning or end
@@ -224,9 +224,10 @@ option.
*scrollbind-quickadj*
The 'scrollbind' flag is meaningful when using keyboard commands to vertically
-scroll a window, and also meaningful when using the vertical scrollbar of the
-window which has the cursor focus. However, when using the vertical scrollbar
-of a window which doesn't have the cursor focus, 'scrollbind' is ignored.
+scroll a window, and is also meaningful when using the vertical scrollbar or
+the mouse wheel in the window which has the cursor focus. However, when using
+the vertical scrollbar or the mouse wheel in a window which doesn't have the
+cursor focus, 'scrollbind' is ignored.
This allows quick adjustment of the relative offset of 'scrollbind' windows.
==============================================================================