aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGlenn Morris2012-04-20 22:15:27 -0400
committerGlenn Morris2012-04-20 22:15:27 -0400
commite78d873d900163034c22977ff79ffe702f3a22c1 (patch)
tree4ec11d31665432fc475511eee5710de3991faa3b
parent0b27932b2d99659ee808dbfee6adf1236a05efa0 (diff)
downloademacs-e78d873d900163034c22977ff79ffe702f3a22c1.tar.gz
emacs-e78d873d900163034c22977ff79ffe702f3a22c1.zip
More small edits for doc/lispref/windows.texi
* doc/lispref/windows.texi (Cyclic Window Ordering, Window History) (Dedicated Windows, Quitting Windows, Window Configurations): Copyedits. (Window Start and End): Remove pointless example. Remove cross-reference to deleted count-lines content.
-rw-r--r--doc/lispref/ChangeLog6
-rw-r--r--doc/lispref/windows.texi68
2 files changed, 34 insertions, 40 deletions
diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog
index ace1d2bb76f..fe63359fad2 100644
--- a/doc/lispref/ChangeLog
+++ b/doc/lispref/ChangeLog
@@ -2,10 +2,14 @@
2 2
3 * windows.texi (Basic Windows, Windows and Frames, Window Sizes) 3 * windows.texi (Basic Windows, Windows and Frames, Window Sizes)
4 (Resizing Windows, Deleting Windows, Selecting Windows) 4 (Resizing Windows, Deleting Windows, Selecting Windows)
5 (Choosing Window Options, Horizontal Scrolling): Copyedits. 5 (Choosing Window Options, Horizontal Scrolling)
6 (Cyclic Window Ordering, Window History, Dedicated Windows)
7 (Quitting Windows, Window Configurations): Copyedits.
6 (Splitting Windows, Deleting Windows): 8 (Splitting Windows, Deleting Windows):
7 Fix ignore-window-parameters logic. 9 Fix ignore-window-parameters logic.
8 (Selecting Windows, Choosing Window Options): Markup fixes. 10 (Selecting Windows, Choosing Window Options): Markup fixes.
11 (Window Start and End): Remove pointless example.
12 Remove cross-reference to deleted count-lines content.
9 13
10 * elisp.texi, vol1.texi, vol2.texi: Bump VERSION and DATE. 14 * elisp.texi, vol1.texi, vol2.texi: Bump VERSION and DATE.
11 15
diff --git a/doc/lispref/windows.texi b/doc/lispref/windows.texi
index da29d528f1b..2e4657328eb 100644
--- a/doc/lispref/windows.texi
+++ b/doc/lispref/windows.texi
@@ -1224,7 +1224,7 @@ the cyclic ordering of windows. @var{window} should be a live window;
1224if omitted or @code{nil}, it defaults to the selected window. 1224if omitted or @code{nil}, it defaults to the selected window.
1225 1225
1226The optional argument @var{minibuf} specifies whether minibuffer windows 1226The optional argument @var{minibuf} specifies whether minibuffer windows
1227shall be included in the cyclic ordering. Normally, when @var{minibuf} 1227should be included in the cyclic ordering. Normally, when @var{minibuf}
1228is @code{nil}, a minibuffer window is included only if it is currently 1228is @code{nil}, a minibuffer window is included only if it is currently
1229``active''; this matches the behavior of @kbd{C-x o}. (Note that a 1229``active''; this matches the behavior of @kbd{C-x o}. (Note that a
1230minibuffer window is active as long as its minibuffer is in use; see 1230minibuffer window is active as long as its minibuffer is in use; see
@@ -1998,8 +1998,8 @@ above.
1998@section Window History 1998@section Window History
1999@cindex window history 1999@cindex window history
2000 2000
2001Each window remembers the buffers it has displayed earlier and the order 2001Each window remembers the buffers it has previously displayed, and the order
2002in which these buffers have been removed from it. This history is used, 2002in which these buffers were removed from it. This history is used,
2003for example, by @code{replace-buffer-in-windows} (@pxref{Buffers and 2003for example, by @code{replace-buffer-in-windows} (@pxref{Buffers and
2004Windows}). This list is automatically maintained by Emacs, but you can 2004Windows}). This list is automatically maintained by Emacs, but you can
2005use the following functions to explicitly inspect or alter it: 2005use the following functions to explicitly inspect or alter it:
@@ -2062,41 +2062,41 @@ This command displays the previous buffer in @var{window}. The
2062argument @var{window} should be a live window or @code{nil} (meaning 2062argument @var{window} should be a live window or @code{nil} (meaning
2063the selected window). If the optional argument @var{bury-or-kill} is 2063the selected window). If the optional argument @var{bury-or-kill} is
2064non-@code{nil}, this means that the buffer currently shown in 2064non-@code{nil}, this means that the buffer currently shown in
2065@var{window} is about to be buried or killed and consequently shall 2065@var{window} is about to be buried or killed and consequently should
2066not be switched to in future invocations of this command. 2066not be switched to in future invocations of this command.
2067 2067
2068The previous buffer is usually the buffer shown before the buffer 2068The previous buffer is usually the buffer shown before the buffer
2069currently shown in @var{window}. However, a buffer that has been buried 2069currently shown in @var{window}. However, a buffer that has been buried
2070or killed or has been already shown by a recent invocation of 2070or killed, or has been already shown by a recent invocation of
2071@code{switch-to-prev-buffer} does not qualify as previous buffer. 2071@code{switch-to-prev-buffer}, does not qualify as previous buffer.
2072 2072
2073If repeated invocations of this command have already shown all buffers 2073If repeated invocations of this command have already shown all buffers
2074previously shown in @var{window}, further invocations will show buffers 2074previously shown in @var{window}, further invocations will show buffers
2075from the buffer list of the frame @var{window} appears on (@pxref{The 2075from the buffer list of the frame @var{window} appears on (@pxref{The
2076Buffer List}) trying to skip buffers that are already shown in another 2076Buffer List}), trying to skip buffers that are already shown in another
2077window on that frame. 2077window on that frame.
2078@end deffn 2078@end deffn
2079 2079
2080@deffn Command switch-to-next-buffer &optional window 2080@deffn Command switch-to-next-buffer &optional window
2081This command switches to the next buffer in @var{window} thus undoing 2081This command switches to the next buffer in @var{window}, thus undoing
2082the effect of the last @code{switch-to-prev-buffer} command in 2082the effect of the last @code{switch-to-prev-buffer} command in
2083@var{window}. The argument @var{window} must be a live window and 2083@var{window}. The argument @var{window} must be a live window and
2084defaults to the selected one. 2084defaults to the selected one.
2085 2085
2086If there is no recent invocation of a @code{switch-to-prev-buffer} that 2086If there is no recent invocation of @code{switch-to-prev-buffer} that
2087can be undone, this function tries to show a buffer from the buffer list 2087can be undone, this function tries to show a buffer from the buffer list
2088of the frame @var{window} appears on (@pxref{The Buffer List}). 2088of the frame @var{window} appears on (@pxref{The Buffer List}).
2089@end deffn 2089@end deffn
2090 2090
2091By default @code{switch-to-prev-buffer} and @code{switch-to-next-buffer} 2091By default @code{switch-to-prev-buffer} and @code{switch-to-next-buffer}
2092can switch to a buffer that is already shown in another window on the 2092can switch to a buffer that is already shown in another window on the
2093same frame. The following option can be used to override that behavior. 2093same frame. The following option can be used to override this behavior.
2094 2094
2095@defopt switch-to-visible-buffer 2095@defopt switch-to-visible-buffer
2096If this variable is non-@code{nil}, @code{switch-to-prev-buffer} and 2096If this variable is non-@code{nil}, @code{switch-to-prev-buffer} and
2097@code{switch-to-next-buffer} may switch to a buffer that is already 2097@code{switch-to-next-buffer} may switch to a buffer that is already
2098visible on the same frame, provided the buffer was shown in the argument 2098visible on the same frame, provided the buffer was shown in the relevant
2099window before. If it's @code{nil}, @code{switch-to-prev-buffer} and 2099window before. If it is @code{nil}, @code{switch-to-prev-buffer} and
2100@code{switch-to-next-buffer} always try to avoid switching to a buffer 2100@code{switch-to-next-buffer} always try to avoid switching to a buffer
2101that is already visible in another window on the same frame. 2101that is already visible in another window on the same frame.
2102@end defopt 2102@end defopt
@@ -2138,7 +2138,7 @@ another buffer in it and iconifies the frame.
2138This function returns non-@code{nil} if @var{window} is dedicated to its 2138This function returns non-@code{nil} if @var{window} is dedicated to its
2139buffer and @code{nil} otherwise. More precisely, the return value is 2139buffer and @code{nil} otherwise. More precisely, the return value is
2140the value assigned by the last call of @code{set-window-dedicated-p} for 2140the value assigned by the last call of @code{set-window-dedicated-p} for
2141@var{window} or @code{nil} if that function was never called with 2141@var{window}, or @code{nil} if that function was never called with
2142@var{window} as its argument. The default for @var{window} is the 2142@var{window} as its argument. The default for @var{window} is the
2143selected window. 2143selected window.
2144@end defun 2144@end defun
@@ -2159,20 +2159,20 @@ non-@code{nil} value.
2159@node Quitting Windows 2159@node Quitting Windows
2160@section Quitting Windows 2160@section Quitting Windows
2161 2161
2162When you want to get rid of a window used for displaying a buffer you 2162When you want to get rid of a window used for displaying a buffer, you
2163can call @code{delete-window} or @code{delete-windows-on} 2163can call @code{delete-window} or @code{delete-windows-on}
2164(@pxref{Deleting Windows}) to remove that window from its frame. If the 2164(@pxref{Deleting Windows}) to remove that window from its frame. If the
2165buffer is shown on a separate frame, you might want to call 2165buffer is shown on a separate frame, you might want to call
2166@code{delete-frame} (@pxref{Deleting Frames}) instead. If, on the other 2166@code{delete-frame} (@pxref{Deleting Frames}) instead. If, on the other
2167hand, a window has been reused for displaying the buffer, you might 2167hand, a window has been reused for displaying the buffer, you might
2168prefer showing the buffer previously shown in that window by calling the 2168prefer showing the buffer previously shown in that window, by calling the
2169function @code{switch-to-prev-buffer} (@pxref{Window History}). 2169function @code{switch-to-prev-buffer} (@pxref{Window History}).
2170Finally, you might want to either bury (@pxref{The Buffer List}) or kill 2170Finally, you might want to either bury (@pxref{The Buffer List}) or kill
2171(@pxref{Killing Buffers}) the window's buffer. 2171(@pxref{Killing Buffers}) the window's buffer.
2172 2172
2173 The following function uses information on how the window for 2173 The following function uses information on how the window for
2174displaying the buffer was obtained in the first place thus attempting to 2174displaying the buffer was obtained in the first place, thus attempting to
2175automatize the above decisions for you. 2175automate the above decisions for you.
2176 2176
2177@deffn Command quit-window &optional kill window 2177@deffn Command quit-window &optional kill window
2178This command quits @var{window} and buries its buffer. The argument 2178This command quits @var{window} and buries its buffer. The argument
@@ -2200,39 +2200,39 @@ restore the original height of @var{window}.
2200The three cases described so far require that the buffer shown in 2200The three cases described so far require that the buffer shown in
2201@var{window} is still the buffer displayed by the last buffer display 2201@var{window} is still the buffer displayed by the last buffer display
2202function for this window. If another buffer has been shown in the 2202function for this window. If another buffer has been shown in the
2203meantime or the buffer previously shown no longer exists, this command 2203meantime, or the buffer previously shown no longer exists, this command
2204calls @code{switch-to-prev-buffer} (@pxref{Window History}) to show some 2204calls @code{switch-to-prev-buffer} (@pxref{Window History}) to show some
2205other buffer instead. 2205other buffer instead.
2206@end deffn 2206@end deffn
2207 2207
2208The function @code{quit-window} bases its decisions on information 2208The function @code{quit-window} bases its decisions on information
2209stored in @var{window}'s @code{quit-restore} window parameter 2209stored in @var{window}'s @code{quit-restore} window parameter
2210(@pxref{Window Parameters}) and resets that parameter to @code{nil} 2210(@pxref{Window Parameters}), and resets that parameter to @code{nil}
2211after it's done. 2211after it's done.
2212 2212
2213The following option specifies how to deal with a frame containing just 2213The following option specifies how to deal with a frame containing just
2214one window that shall be either quit or whose buffer shall be buried. 2214one window that should be either quit, or whose buffer should be buried.
2215 2215
2216@defopt frame-auto-hide-function 2216@defopt frame-auto-hide-function
2217The function specified by this option is called to automatically hide 2217The function specified by this option is called to automatically hide
2218frames. This function is called with one argument - a frame. 2218frames. This function is called with one argument---a frame.
2219 2219
2220The function specified here is called by @code{bury-buffer} (@pxref{The 2220The function specified here is called by @code{bury-buffer} (@pxref{The
2221Buffer List}) when the selected window is dedicated and shows the buffer 2221Buffer List}) when the selected window is dedicated and shows the buffer
2222that shall be buried. It is also called by @code{quit-window} (see 2222that should be buried. It is also called by @code{quit-window} (see
2223above) when the frame of the window that shall be quit has been 2223above) when the frame of the window that should be quit has been
2224specially created for displaying that window's buffer and the buffer 2224specially created for displaying that window's buffer and the buffer
2225shall be buried. 2225should be buried.
2226 2226
2227The default is to call @code{iconify-frame} (@pxref{Visibility of 2227The default is to call @code{iconify-frame} (@pxref{Visibility of
2228Frames}). Alternatively, you may either specify @code{delete-frame} 2228Frames}). Alternatively, you may specify either @code{delete-frame}
2229(@pxref{Deleting Frames}) to remove the frame from its display, 2229(@pxref{Deleting Frames}) to remove the frame from its display,
2230@code{ignore} to leave the frame unchanged, or any other function that 2230@code{ignore} to leave the frame unchanged, or any other function that
2231can take a frame as its sole argument. 2231can take a frame as its sole argument.
2232 2232
2233Note that the function specified by this option is called if and only if 2233Note that the function specified by this option is called if and only if
2234there's at least one other frame on the terminal of the frame it's 2234there is at least one other frame on the terminal of the frame it's
2235supposed to handle and that frame contains only one live window. 2235supposed to handle, and that frame contains only one live window.
2236@end defopt 2236@end defopt
2237 2237
2238 2238
@@ -2322,14 +2322,7 @@ command to a key.
2322@cindex window top line 2322@cindex window top line
2323This function returns the display-start position of window 2323This function returns the display-start position of window
2324@var{window}. If @var{window} is @code{nil}, the selected window is 2324@var{window}. If @var{window} is @code{nil}, the selected window is
2325used. For example, 2325used.
2326
2327@example
2328@group
2329(window-start)
2330 @result{} 7058
2331@end group
2332@end example
2333 2326
2334When you create a window, or display a different buffer in it, the 2327When you create a window, or display a different buffer in it, the
2335display-start position is set to a display-start position recently used 2328display-start position is set to a display-start position recently used
@@ -2341,9 +2334,6 @@ it explicitly since the previous redisplay)---to make sure point appears
2341on the screen. Nothing except redisplay automatically changes the 2334on the screen. Nothing except redisplay automatically changes the
2342window-start position; if you move point, do not expect the window-start 2335window-start position; if you move point, do not expect the window-start
2343position to change in response until after the next redisplay. 2336position to change in response until after the next redisplay.
2344
2345For a realistic example of using @code{window-start}, see the
2346description of @code{count-lines}. @xref{Definition of count-lines}.
2347@end defun 2337@end defun
2348 2338
2349@cindex window end position 2339@cindex window end position
@@ -3236,7 +3226,7 @@ of the selected frame.
3236If the optional argument @var{writable} is non-@code{nil}, this means to 3226If the optional argument @var{writable} is non-@code{nil}, this means to
3237not use markers for sampling positions like @code{window-point} or 3227not use markers for sampling positions like @code{window-point} or
3238@code{window-start}. This argument should be non-@code{nil} when the 3228@code{window-start}. This argument should be non-@code{nil} when the
3239state shall be written to disk and read back in another session. 3229state will be written to disk and read back in another session.
3240 3230
3241Together, the argument @var{writable} and the variable 3231Together, the argument @var{writable} and the variable
3242@code{window-persistent-parameters} specify which window parameters are 3232@code{window-persistent-parameters} specify which window parameters are