aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEli Zaretskii2008-11-08 18:07:29 +0000
committerEli Zaretskii2008-11-08 18:07:29 +0000
commita1401ab1230bfd8e9e433c9714e1f0010e19a3a3 (patch)
tree2da89a2891b3ed7d2f54486904bffde3790eb479
parent040575352102171e2455e6c0a67b48d62088f572 (diff)
downloademacs-a1401ab1230bfd8e9e433c9714e1f0010e19a3a3.tar.gz
emacs-a1401ab1230bfd8e9e433c9714e1f0010e19a3a3.zip
(Basic Windows, Splitting Windows)
(Deleting Windows, Selecting Windows, Cyclic Window Ordering) (Buffers and Windows, Displaying Buffers, Dedicated Windows) (Resizing Windows, Window Configurations, Window Parameters): Fix wording and markup.
-rw-r--r--doc/lispref/ChangeLog8
-rw-r--r--doc/lispref/windows.texi88
2 files changed, 53 insertions, 43 deletions
diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog
index 896be8d4a5e..74e96df46f1 100644
--- a/doc/lispref/ChangeLog
+++ b/doc/lispref/ChangeLog
@@ -1,3 +1,11 @@
12008-11-08 Eli Zaretskii <eliz@gnu.org>
2
3 * windows.texi (Basic Windows, Splitting Windows)
4 (Deleting Windows, Selecting Windows, Cyclic Window Ordering)
5 (Buffers and Windows, Displaying Buffers, Dedicated Windows)
6 (Resizing Windows, Window Configurations, Window Parameters): Fix
7 wording and markup.
8
12008-11-07 Martin Rudalics <rudalics@gmx.at> 92008-11-07 Martin Rudalics <rudalics@gmx.at>
2 10
3 * windows.texi (Windows): Update entries. 11 * windows.texi (Windows): Update entries.
diff --git a/doc/lispref/windows.texi b/doc/lispref/windows.texi
index 6243babaa53..af1e3285489 100644
--- a/doc/lispref/windows.texi
+++ b/doc/lispref/windows.texi
@@ -23,7 +23,7 @@ windows.
23 and choosing a window for it. 23 and choosing a window for it.
24* Choosing Window:: How to choose a window for displaying a buffer. 24* Choosing Window:: How to choose a window for displaying a buffer.
25* Dedicated Windows:: How to avoid displaying another buffer in 25* Dedicated Windows:: How to avoid displaying another buffer in
26 a specific window. 26 a specific window.
27* Window Point:: Each window has its own location of point. 27* Window Point:: Each window has its own location of point.
28* Window Start and End:: Buffer positions indicating which text is 28* Window Start and End:: Buffer positions indicating which text is
29 on-screen in a window. 29 on-screen in a window.
@@ -51,26 +51,27 @@ buffer is displayed. The term is also used to refer to a Lisp object that
51represents that screen area in Emacs Lisp. It should be 51represents that screen area in Emacs Lisp. It should be
52clear from the context which is meant. 52clear from the context which is meant.
53 53
54 Emacs groups windows into frames, @xref{Frames}. A frame represents 54 Emacs groups windows into frames, see @ref{Frames}. A frame
55an area of screen available for Emacs to use. Each frame always 55represents an area of screen available for Emacs to use. Each frame
56contains at least one window, but you can subdivide it vertically or 56always contains at least one window, but you can subdivide it
57horizontally into multiple, nonoverlapping Emacs windows. 57vertically or horizontally into multiple, nonoverlapping Emacs
58windows.
58 59
59 In each frame, at any time, one and only one window is designated as 60 In each frame, at any time, one and only one window is designated as
60@dfn{selected within the frame}. The frame's cursor appears in that 61@dfn{selected within the frame}. The frame's cursor appears in that
61window, but the other windows have ``non-selected'' cursors, normally 62window, but the other windows have ``non-selected'' cursors, normally
62less visible. (@pxref{Cursor Parameters}, for customizing this.) At 63less visible. (@xref{Cursor Parameters}, for customizing this.) At
63any time, one frame is the selected frame; and the window selected 64any time, one frame is the selected frame; and the window selected
64within that frame is @dfn{the selected window}. The selected window's 65within that frame is @dfn{the selected window}. The selected window's
65buffer is usually the current buffer (except when @code{set-buffer} has 66buffer is usually the current buffer (except when @code{set-buffer} has
66been used), @xref{Current Buffer}. 67been used), see @ref{Current Buffer}.
67 68
68 For practical purposes, a window exists only while it is displayed in 69 For practical purposes, a window exists only while it is displayed in
69a frame. Once removed from the frame, the window is effectively deleted 70a frame. Once removed from the frame, the window is effectively deleted
70and should not be used, @emph{even though there may still be references 71and should not be used, @emph{even though there may still be references
71to it} from other Lisp objects, @xref{Deleting Windows}. Restoring a 72to it} from other Lisp objects, see @ref{Deleting Windows}. Restoring a
72saved window configuration is the only way for a window no longer on the 73saved window configuration is the only way for a window no longer on the
73screen to come back to life, @xref{Window Configurations}. 74screen to come back to life, see @ref{Window Configurations}.
74 75
75@cindex multiple windows 76@cindex multiple windows
76 Users create multiple windows so they can look at several buffers at 77 Users create multiple windows so they can look at several buffers at
@@ -217,8 +218,8 @@ Now the screen looks like this:
217@end smallexample 218@end smallexample
218 219
219Normally, Emacs indicates the border between two side-by-side windows 220Normally, Emacs indicates the border between two side-by-side windows
220with a scroll bar, @xref{Scroll Bars}, or @samp{|} characters. The 221with a scroll bar (@pxref{Scroll Bars}), or with @samp{|} characters. The
221display table can specify alternative border characters; @xref{Display 222display table can specify alternative border characters; see @ref{Display
222Tables}. 223Tables}.
223@end deffn 224@end deffn
224 225
@@ -314,8 +315,8 @@ of a window aside from restoring a saved window configuration
314(@pxref{Window Configurations}). Restoring a window configuration also 315(@pxref{Window Configurations}). Restoring a window configuration also
315deletes any windows that aren't part of that configuration. 316deletes any windows that aren't part of that configuration.
316 317
317 When you delete a window, the space it took up is given to one 318 When you delete a window, the space it took up is given to one of
318adjacent window. 319its sibling windows adjacent to it.
319 320
320@c Emacs 19 feature 321@c Emacs 19 feature
321@defun window-live-p window 322@defun window-live-p window
@@ -391,9 +392,9 @@ which the cursor appears and to which many commands apply.
391 392
392@defun select-window window &optional norecord 393@defun select-window window &optional norecord
393This function makes @var{window} the selected window. The cursor then 394This function makes @var{window} the selected window. The cursor then
394appears in @var{window} (on redisplay). Unless @var{window} was already 395appears in @var{window} (after redisplay). Unless @var{window} was
395selected, @code{select-window} makes @var{window}'s buffer the current 396already selected, @code{select-window} makes @var{window}'s buffer the
396buffer. The return value is @var{window}. 397current buffer. The return value is @var{window}.
397 398
398Normally, @var{window}'s selected buffer is moved to the front of the 399Normally, @var{window}'s selected buffer is moved to the front of the
399buffer list (@pxref{The Buffer List}) and @var{window} becomes the most 400buffer list (@pxref{The Buffer List}) and @var{window} becomes the most
@@ -418,7 +419,7 @@ earlier selected frame and windows. It also saves and restores the
418current buffer. It returns the value of the last form in @var{forms}. 419current buffer. It returns the value of the last form in @var{forms}.
419 420
420This macro does not save or restore anything about the sizes, 421This macro does not save or restore anything about the sizes,
421arrangement or contents of windows; therefore, if the @var{forms} change 422arrangement or contents of windows; therefore, if @var{forms} change
422them, the change persists. If the previously selected window of some 423them, the change persists. If the previously selected window of some
423frame is no longer live at the time of exit from @var{forms}, that 424frame is no longer live at the time of exit from @var{forms}, that
424frame's selected window is left alone. If the previously selected 425frame's selected window is left alone. If the previously selected
@@ -435,7 +436,8 @@ This macro selects @var{window}, executes @var{forms} in sequence, then
435restores the previously selected window and current buffer. The ordering 436restores the previously selected window and current buffer. The ordering
436of recently selected windows and the buffer list remain unchanged unless 437of recently selected windows and the buffer list remain unchanged unless
437you deliberately change them within @var{forms}, for example, by calling 438you deliberately change them within @var{forms}, for example, by calling
438@code{select-window} with argument @var{norecord} nil or omitted there. 439@code{select-window} with argument @var{norecord} @code{nil} or omitted
440there.
439@end defmac 441@end defmac
440 442
441@cindex finding windows 443@cindex finding windows
@@ -452,7 +454,7 @@ only window. A newly created window becomes the least recently used
452window until it is selected. A minibuffer window is never a candidate. 454window until it is selected. A minibuffer window is never a candidate.
453A dedicated window (@pxref{Dedicated Windows}) is never a candidate 455A dedicated window (@pxref{Dedicated Windows}) is never a candidate
454unless the @var{dedicated} argument is non-@code{nil}, so if all 456unless the @var{dedicated} argument is non-@code{nil}, so if all
455existing windows are dedicated, the value is @code{nil}. 457existing windows are dedicated, the function returns @code{nil}.
456 458
457The argument @var{frame} specifies which windows are considered. 459The argument @var{frame} specifies which windows are considered.
458 460
@@ -476,10 +478,10 @@ width). If there are no side-by-side windows, then this is the window
476with the most lines. A minibuffer window is never a candidate. A 478with the most lines. A minibuffer window is never a candidate. A
477dedicated window (@pxref{Dedicated Windows}) is never a candidate unless 479dedicated window (@pxref{Dedicated Windows}) is never a candidate unless
478the @var{dedicated} argument is non-@code{nil}, so if all existing 480the @var{dedicated} argument is non-@code{nil}, so if all existing
479windows are dedicated, the value is @code{nil}. 481windows are dedicated, the function returns @code{nil}.
480 482
481If there are two candidate windows of the same size, this function 483If there are two candidate windows of the same size, this function
482prefers the one that comes first in the cyclic ordering of windows 484prefers the one that comes first in the cyclic ordering of windows,
483starting from the selected window (@pxref{Cyclic Window Ordering}). 485starting from the selected window (@pxref{Cyclic Window Ordering}).
484 486
485The argument @var{frame} specifies which set of windows to consider, see 487The argument @var{frame} specifies which set of windows to consider, see
@@ -536,7 +538,7 @@ The value of the argument @var{minibuf} specifies whether the minibuffer
536is included in the window order. Normally, when @var{minibuf} is 538is included in the window order. Normally, when @var{minibuf} is
537@code{nil}, the minibuffer is included only if it is currently 539@code{nil}, the minibuffer is included only if it is currently
538``active''; this matches the behavior of @kbd{C-x o}. (The minibuffer 540``active''; this matches the behavior of @kbd{C-x o}. (The minibuffer
539window is active while the minibuffer is in use, @xref{Minibuffers}.) 541window is active while the minibuffer is in use, see @ref{Minibuffers}.)
540 542
541If @var{minibuf} is @code{t}, the cyclic ordering includes the 543If @var{minibuf} is @code{t}, the cyclic ordering includes the
542minibuffer window even if it is not active. If @var{minibuf} is neither 544minibuffer window even if it is not active. If @var{minibuf} is neither
@@ -624,7 +626,7 @@ for details.
624@defun window-list &optional frame minibuf window 626@defun window-list &optional frame minibuf window
625This function returns a list of all windows on @var{frame}, starting 627This function returns a list of all windows on @var{frame}, starting
626with @var{window}. @var{frame} defaults to the selected frame; 628with @var{window}. @var{frame} defaults to the selected frame;
627@var{window} to the selected window. 629@var{window} defaults to the selected window.
628 630
629The value of @var{minibuf} specifies if the minibuffer window shall be 631The value of @var{minibuf} specifies if the minibuffer window shall be
630included in the result list. If @var{minibuf} is @code{t}, the result 632included in the result list. If @var{minibuf} is @code{t}, the result
@@ -669,7 +671,7 @@ ways of doing that call this function.
669 671
670Normally, displaying @var{buffer-or-name} in @var{window} resets the 672Normally, displaying @var{buffer-or-name} in @var{window} resets the
671window's position, display margins, fringe widths, and scroll bar 673window's position, display margins, fringe widths, and scroll bar
672settings, to values based on the local variables of that buffer. 674settings based on the local variables of that buffer.
673However, if @var{keep-margins} is non-@code{nil}, display margins and 675However, if @var{keep-margins} is non-@code{nil}, display margins and
674fringe widths of @var{window} remain unchanged. @xref{Fringes}. 676fringe widths of @var{window} remain unchanged. @xref{Fringes}.
675 677
@@ -782,13 +784,13 @@ displays the buffer in the selected window. This means that a human can
782see the buffer and subsequent keyboard commands will apply to it. 784see the buffer and subsequent keyboard commands will apply to it.
783Contrast this with @code{set-buffer}, which makes @var{buffer-or-name} 785Contrast this with @code{set-buffer}, which makes @var{buffer-or-name}
784the current buffer but does not display it in the selected window, 786the current buffer but does not display it in the selected window,
785@xref{Current Buffer}. 787see @ref{Current Buffer}.
786 788
787If @var{buffer-or-name} is @code{nil}, @code{switch-to-buffer} chooses a 789If @var{buffer-or-name} is @code{nil}, @code{switch-to-buffer} chooses a
788buffer using @code{other-buffer}. If @var{buffer-or-name} is a string 790buffer using @code{other-buffer}. If @var{buffer-or-name} is a string
789that does not identify an existing buffer, then a new buffer by that 791that does not identify an existing buffer, then a new buffer by that
790name is created. The major mode for the new buffer is set according to 792name is created. The major mode for the new buffer is set according to
791the variable @code{default-major-mode}, @xref{Auto Major Mode}. 793the variable @code{default-major-mode}, see @ref{Auto Major Mode}.
792 794
793When @code{enable-recursive-minibuffers} is non-@code{nil} and the 795When @code{enable-recursive-minibuffers} is non-@code{nil} and the
794selected window is either the minibuffer window or is dedicated to its 796selected window is either the minibuffer window or is dedicated to its
@@ -829,7 +831,7 @@ unless @var{norecord} is non-@code{nil}.
829This command makes @var{buffer-or-name} the current buffer and switches 831This command makes @var{buffer-or-name} the current buffer and switches
830to it in some window, preferably not the window previously selected. 832to it in some window, preferably not the window previously selected.
831The ``popped-to'' window becomes the selected window. Its frame is 833The ``popped-to'' window becomes the selected window. Its frame is
832given the X server's focus, if possible, @xref{Input Focus}. The return 834given the X server's focus, if possible, see @ref{Input Focus}. The return
833value is the buffer that was switched to. 835value is the buffer that was switched to.
834 836
835If @var{buffer-or-name} is @code{nil}, that means to choose some other 837If @var{buffer-or-name} is @code{nil}, that means to choose some other
@@ -851,7 +853,7 @@ recently selected frame that was not just a minibuffer.)
851 853
852If the variable @code{pop-up-windows} is non-@code{nil}, windows may be 854If the variable @code{pop-up-windows} is non-@code{nil}, windows may be
853split to create a new window that is different from the original window. 855split to create a new window that is different from the original window.
854For details, @xref{Choosing Window}. 856For details, see @ref{Choosing Window}.
855 857
856If @var{other-window} is non-@code{nil}, @code{pop-to-buffer} finds or 858If @var{other-window} is non-@code{nil}, @code{pop-to-buffer} finds or
857creates another window even if @var{buffer-or-name} is already visible 859creates another window even if @var{buffer-or-name} is already visible
@@ -893,7 +895,7 @@ This function returns @code{nil}.
893 895
894 This section describes the basic facility that chooses a window to 896 This section describes the basic facility that chooses a window to
895display a buffer in---@code{display-buffer}. Higher-level functions and 897display a buffer in---@code{display-buffer}. Higher-level functions and
896commands like @code{switch-to-buffer} and @code{pop-to-buffer} use this 898commands, like @code{switch-to-buffer} and @code{pop-to-buffer}, use this
897subroutine. Here we describe how to use @code{display-buffer} and how 899subroutine. Here we describe how to use @code{display-buffer} and how
898to customize it. 900to customize it.
899 901
@@ -1212,7 +1214,7 @@ This function returns non-@code{nil} if @var{window} is dedicated to its
1212buffer and @code{nil} otherwise. More precisely, the return value is 1214buffer and @code{nil} otherwise. More precisely, the return value is
1213the value assigned by the last call of @code{set-window-dedicated-p} for 1215the value assigned by the last call of @code{set-window-dedicated-p} for
1214@var{window} or @code{nil} if that function was never called with 1216@var{window} or @code{nil} if that function was never called with
1215@var{WINDOW} as its argument. @var{WINDOW} defaults to the selected 1217@var{window} as its argument. @var{window} defaults to the selected
1216window. 1218window.
1217@end defun 1219@end defun
1218 1220
@@ -2103,7 +2105,7 @@ frame.
2103If there are various other windows from which lines or columns can be 2105If there are various other windows from which lines or columns can be
2104stolen, and some of them specify fixed size (using 2106stolen, and some of them specify fixed size (using
2105@code{window-size-fixed}, see below), they are left untouched while 2107@code{window-size-fixed}, see below), they are left untouched while
2106other windows are ``robbed''. If it would be necessary to alter the 2108other windows are ``robbed.'' If it would be necessary to alter the
2107size of a fixed-size window, @code{enlarge-window} gets an error 2109size of a fixed-size window, @code{enlarge-window} gets an error
2108instead. 2110instead.
2109 2111
@@ -2235,7 +2237,7 @@ A value less than @code{2} is ignored.
2235@end defopt 2237@end defopt
2236 2238
2237@cindex balancing window sizes 2239@cindex balancing window sizes
2238Emacs provides two functions to balance windows, that means, to even out 2240Emacs provides two functions to balance windows, that is, to even out
2239the sizes of windows on the same frame. The minibuffer window and 2241the sizes of windows on the same frame. The minibuffer window and
2240fixed-size windows are not resized by these functions. 2242fixed-size windows are not resized by these functions.
2241 2243
@@ -2246,13 +2248,13 @@ specifies a frame, it balances all windows on that frame. If
2246@var{window-or-frame} specifies a window, it balances this window and 2248@var{window-or-frame} specifies a window, it balances this window and
2247its ``siblings'' only. Think of a sibling as the other (original or 2249its ``siblings'' only. Think of a sibling as the other (original or
2248new) window with respect to the present one, involved in the process of 2250new) window with respect to the present one, involved in the process of
2249splitting, @xref{Splitting Windows}. Since a sibling may have been 2251splitting, see @ref{Splitting Windows}. Since a sibling may have been
2250split again, a window can have more than one sibling. 2252split again, a window can have more than one sibling.
2251@end deffn 2253@end deffn
2252 2254
2253@deffn Command balance-windows-area 2255@deffn Command balance-windows-area
2254This function attempts to give all windows on the selected frame 2256This function attempts to give all windows on the selected frame
2255approximately the same share of the screen area. This means, that 2257approximately the same share of the screen area. This means that
2256full-width or full-height windows are not given more space than other 2258full-width or full-height windows are not given more space than other
2257windows. 2259windows.
2258@end deffn 2260@end deffn
@@ -2356,12 +2358,12 @@ fringes, margins, and scroll bar settings. It also includes the value
2356of @code{minibuffer-scroll-window}. As a special exception, the window 2358of @code{minibuffer-scroll-window}. As a special exception, the window
2357configuration does not record the value of point in the selected window 2359configuration does not record the value of point in the selected window
2358for the current buffer. Also, the window configuration does not record 2360for the current buffer. Also, the window configuration does not record
2359the values of window parameters, @xref{Window Parameters}. 2361the values of window parameters, see @ref{Window Parameters}.
2360 2362
2361 You can bring back an entire frame layout by restoring a window 2363 You can bring back an entire frame layout by restoring a previously
2362configuration previously saved. If you want to record the layout of all 2364saved window configuration. If you want to record the layout of all
2363frames instead of just one, use a frame configuration instead of a 2365frames instead of just one, use a frame configuration instead of a
2364window configuration, @xref{Frame Configurations}. 2366window configuration, see @ref{Frame Configurations}.
2365 2367
2366@defun current-window-configuration &optional frame 2368@defun current-window-configuration &optional frame
2367This function returns a new object representing @var{frame}'s current 2369This function returns a new object representing @var{frame}'s current
@@ -2478,11 +2480,11 @@ This function returns @var{window}'s value for @var{parameter}.
2478setting for @var{parameter}, this function returns @code{nil}. 2480setting for @var{parameter}, this function returns @code{nil}.
2479@end defun 2481@end defun
2480 2482
2481@defun window-parameters &optional window 2483@defun window-parameters &optional window
2482This function returns all parameters of @var{window} and their values. 2484This function returns all parameters of @var{window} and their values.
2483@var{window} defaults to the selected window. The return value is an 2485@var{window} defaults to the selected window. The return value is an
2484association list of elements of the form (@var{parameter} 2486association list of elements of the form @code{(@var{parameter}
2485. @var{value}). 2487. @var{value})}.
2486@end defun 2488@end defun
2487 2489
2488@defun set-window-parameter window parameter value 2490@defun set-window-parameter window parameter value
@@ -2496,8 +2498,8 @@ consequently not restored by @code{set-window-configuration}. Hence,
2496any change of a parameter introduced via @code{set-window-parameter} can 2498any change of a parameter introduced via @code{set-window-parameter} can
2497be undone only by invoking @code{set-window-parameter} for the same 2499be undone only by invoking @code{set-window-parameter} for the same
2498parameter again. Since @code{save-window-excursion} relies on window 2500parameter again. Since @code{save-window-excursion} relies on window
2499configurations, window parameters are not saved and restored by that 2501configurations (@pxref{Window Configurations}), window parameters are
2500special form either, @xref{Window Configurations}. 2502not saved and restored by that special form, either.
2501 2503
2502@node Window Hooks 2504@node Window Hooks
2503@section Hooks for Window Scrolling and Changes 2505@section Hooks for Window Scrolling and Changes