aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorBasil L. Contovounesios2018-05-03 13:52:20 +0100
committerNoam Postavsky2018-05-10 19:04:11 -0400
commitd5cf1b3160a5510198fc5dd4e28b3eca7aadf71b (patch)
tree557d7cbce4e09fdde16e484967a41da632ae6917 /doc
parentdc9188ada522743dd9c9a6658570d9c4973be432 (diff)
downloademacs-d5cf1b3160a5510198fc5dd4e28b3eca7aadf71b.tar.gz
emacs-d5cf1b3160a5510198fc5dd4e28b3eca7aadf71b.zip
Improve documentation for "other window" scrolling
* doc/emacs/windows.texi (Other Window): * doc/lispref/windows.texi (Textual Scrolling): Document scroll-other-window-down. * doc/lispref/minibuf.texi (Minibuffer Misc): Cross-reference minibuffer-scroll-window with Textual Scrolling. * src/window.c (Fother_window_for_scrolling): Clarify how "other window" is determined in docstring. (Fscroll_other_window): Simplify docstring, pointing to that of Fother_window_for_scrolling. (bug#30207)
Diffstat (limited to 'doc')
-rw-r--r--doc/emacs/windows.texi19
-rw-r--r--doc/lispref/minibuf.texi2
-rw-r--r--doc/lispref/windows.texi7
3 files changed, 21 insertions, 7 deletions
diff --git a/doc/emacs/windows.texi b/doc/emacs/windows.texi
index 809363305fb..17ce4ad04d3 100644
--- a/doc/emacs/windows.texi
+++ b/doc/emacs/windows.texi
@@ -157,7 +157,9 @@ this option is @code{nil}.
157@item C-x o 157@item C-x o
158Select another window (@code{other-window}). 158Select another window (@code{other-window}).
159@item C-M-v 159@item C-M-v
160Scroll the next window (@code{scroll-other-window}). 160Scroll the next window upward (@code{scroll-other-window}).
161@item C-M-S-v
162Scroll the next window downward (@code{scroll-other-window-down}).
161@item mouse-1 163@item mouse-1
162@kbd{mouse-1}, in the text area of a window, selects the window and 164@kbd{mouse-1}, in the text area of a window, selects the window and
163moves point to the position clicked. Clicking in the mode line 165moves point to the position clicked. Clicking in the mode line
@@ -181,13 +183,18 @@ back and finish supplying the minibuffer argument that is requested.
181 183
182@kindex C-M-v 184@kindex C-M-v
183@findex scroll-other-window 185@findex scroll-other-window
186@kindex C-M-S-v
187@findex scroll-other-window-down
184 The usual scrolling commands (@pxref{Display}) apply to the selected 188 The usual scrolling commands (@pxref{Display}) apply to the selected
185window only, but there is one command to scroll the next window. 189window only, but there are also commands to scroll the next window.
186@kbd{C-M-v} (@code{scroll-other-window}) scrolls the window that 190@kbd{C-M-v} (@code{scroll-other-window}) scrolls the window that
187@kbd{C-x o} would select. It takes arguments, positive and negative, 191@kbd{C-x o} would select. In other respects, the command behaves like
188like @kbd{C-v}. (In the minibuffer, @kbd{C-M-v} scrolls the help 192@kbd{C-v}; both move the buffer text upward relative to the window, and
189window associated with the minibuffer, if any, rather than the next 193take positive and negative arguments. (In the minibuffer, @kbd{C-M-v}
190window in the standard cyclic order; @pxref{Minibuffer Edit}.) 194scrolls the help window associated with the minibuffer, if any, rather
195than the next window in the standard cyclic order; @pxref{Minibuffer
196Edit}.) @kbd{C-M-S-v} (@code{scroll-other-window-down}) scrolls the
197next window downward in a similar way.
191 198
192@vindex mouse-autoselect-window 199@vindex mouse-autoselect-window
193 If you set @code{mouse-autoselect-window} to a non-@code{nil} value, 200 If you set @code{mouse-autoselect-window} to a non-@code{nil} value,
diff --git a/doc/lispref/minibuf.texi b/doc/lispref/minibuf.texi
index 338e03ef74d..889b64af8ae 100644
--- a/doc/lispref/minibuf.texi
+++ b/doc/lispref/minibuf.texi
@@ -2462,7 +2462,7 @@ locally inside the minibuffer (@pxref{Help Functions}).
2462@anchor{Definition of minibuffer-scroll-window} 2462@anchor{Definition of minibuffer-scroll-window}
2463If the value of this variable is non-@code{nil}, it should be a window 2463If the value of this variable is non-@code{nil}, it should be a window
2464object. When the function @code{scroll-other-window} is called in the 2464object. When the function @code{scroll-other-window} is called in the
2465minibuffer, it scrolls this window. 2465minibuffer, it scrolls this window (@pxref{Textual Scrolling}).
2466@end defvar 2466@end defvar
2467 2467
2468@defun minibuffer-selected-window 2468@defun minibuffer-selected-window
diff --git a/doc/lispref/windows.texi b/doc/lispref/windows.texi
index f5de2fc90ba..315ffd4f484 100644
--- a/doc/lispref/windows.texi
+++ b/doc/lispref/windows.texi
@@ -4028,6 +4028,13 @@ line reappears after the echo area momentarily displays the message
4028@samp{End of buffer}. 4028@samp{End of buffer}.
4029@end deffn 4029@end deffn
4030 4030
4031@deffn Command scroll-other-window-down &optional count
4032This function scrolls the text in another window downward @var{count}
4033lines. Negative values of @var{count}, or @code{nil}, are handled as
4034in @code{scroll-down}. In other respects, it behaves the same way as
4035@code{scroll-other-window} does.
4036@end deffn
4037
4031@defvar other-window-scroll-buffer 4038@defvar other-window-scroll-buffer
4032If this variable is non-@code{nil}, it tells @code{scroll-other-window} 4039If this variable is non-@code{nil}, it tells @code{scroll-other-window}
4033which buffer's window to scroll. 4040which buffer's window to scroll.