diff options
| author | Glenn Morris | 2012-04-21 12:31:05 -0700 |
|---|---|---|
| committer | Glenn Morris | 2012-04-21 12:31:05 -0700 |
| commit | 09ebefe1e00416b16c27c9c85d1a30498ed3c047 (patch) | |
| tree | 0c2cef943e3fdb7abf94e08700c55fb38b2d00e3 | |
| parent | 581b67880c0d1d9193707b64b9c6b1aee2743338 (diff) | |
| download | emacs-09ebefe1e00416b16c27c9c85d1a30498ed3c047.tar.gz emacs-09ebefe1e00416b16c27c9c85d1a30498ed3c047.zip | |
More small edits for doc/lispref/windows.texi
* doc/lispref/windows.texi (Textual Scrolling, Coordinates and Windows)
(Window Configurations, Window Parameters, Window Hooks): Copyedits.
(Textual Scrolling): Mention recenter-redisplay, recenter-top-bottom,
and recenter-positions. Remove recenter example.
* admin/FOR-RELEASE: Related markup.
| -rw-r--r-- | admin/FOR-RELEASE | 2 | ||||
| -rw-r--r-- | doc/lispref/ChangeLog | 6 | ||||
| -rw-r--r-- | doc/lispref/windows.texi | 144 |
3 files changed, 83 insertions, 69 deletions
diff --git a/admin/FOR-RELEASE b/admin/FOR-RELEASE index 6bcd8703674..f53b74e98c4 100644 --- a/admin/FOR-RELEASE +++ b/admin/FOR-RELEASE | |||
| @@ -229,7 +229,7 @@ syntax.texi cyd | |||
| 229 | text.texi cyd | 229 | text.texi cyd |
| 230 | tips.texi rgm | 230 | tips.texi rgm |
| 231 | variables.texi cyd | 231 | variables.texi cyd |
| 232 | windows.texi | 232 | windows.texi rgm (skimmed) |
| 233 | 233 | ||
| 234 | 234 | ||
| 235 | Local variables: | 235 | Local variables: |
diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog index fe63359fad2..7b30b0e7ac3 100644 --- a/doc/lispref/ChangeLog +++ b/doc/lispref/ChangeLog | |||
| @@ -4,12 +4,16 @@ | |||
| 4 | (Resizing Windows, Deleting Windows, Selecting Windows) | 4 | (Resizing Windows, Deleting Windows, Selecting Windows) |
| 5 | (Choosing Window Options, Horizontal Scrolling) | 5 | (Choosing Window Options, Horizontal Scrolling) |
| 6 | (Cyclic Window Ordering, Window History, Dedicated Windows) | 6 | (Cyclic Window Ordering, Window History, Dedicated Windows) |
| 7 | (Quitting Windows, Window Configurations): Copyedits. | 7 | (Quitting Windows, Window Configurations, Textual Scrolling): |
| 8 | (Coordinates and Windows, Window Configurations) | ||
| 9 | (Window Parameters, Window Hooks): Copyedits. | ||
| 8 | (Splitting Windows, Deleting Windows): | 10 | (Splitting Windows, Deleting Windows): |
| 9 | Fix ignore-window-parameters logic. | 11 | Fix ignore-window-parameters logic. |
| 10 | (Selecting Windows, Choosing Window Options): Markup fixes. | 12 | (Selecting Windows, Choosing Window Options): Markup fixes. |
| 11 | (Window Start and End): Remove pointless example. | 13 | (Window Start and End): Remove pointless example. |
| 12 | Remove cross-reference to deleted count-lines content. | 14 | Remove cross-reference to deleted count-lines content. |
| 15 | (Textual Scrolling): Mention recenter-redisplay, recenter-top-bottom, | ||
| 16 | and recenter-positions. Remove recenter example. | ||
| 13 | 17 | ||
| 14 | * elisp.texi, vol1.texi, vol2.texi: Bump VERSION and DATE. | 18 | * elisp.texi, vol1.texi, vol2.texi: Bump VERSION and DATE. |
| 15 | 19 | ||
diff --git a/doc/lispref/windows.texi b/doc/lispref/windows.texi index 2e4657328eb..c8a9316bcfa 100644 --- a/doc/lispref/windows.texi +++ b/doc/lispref/windows.texi | |||
| @@ -2507,12 +2507,16 @@ commands move the paper up and down. Thus, if you are looking at the | |||
| 2507 | middle of a buffer and repeatedly call @code{scroll-down}, you will | 2507 | middle of a buffer and repeatedly call @code{scroll-down}, you will |
| 2508 | eventually see the beginning of the buffer. | 2508 | eventually see the beginning of the buffer. |
| 2509 | 2509 | ||
| 2510 | Some people have urged that the opposite convention be used: they | 2510 | Unfortunately, this sometimes causes confusion, because some people |
| 2511 | tend to think in terms of the opposite convention: they | ||
| 2511 | imagine the window moving over text that remains in place, so that | 2512 | imagine the window moving over text that remains in place, so that |
| 2512 | ``down'' commands take you to the end of the buffer. This convention | 2513 | ``down'' commands take you to the end of the buffer. This convention |
| 2513 | is consistent with fact that such a command is bound to a key named | 2514 | is consistent with fact that such a command is bound to a key named |
| 2514 | @key{PageDown} on modern keyboards. We have not switched to this | 2515 | @key{PageDown} on modern keyboards. |
| 2515 | convention as that is likely to break existing Emacs Lisp code. | 2516 | @ignore |
| 2517 | We have not switched to this convention as that is likely to break | ||
| 2518 | existing Emacs Lisp code. | ||
| 2519 | @end ignore | ||
| 2516 | 2520 | ||
| 2517 | Textual scrolling functions (aside from @code{scroll-other-window}) | 2521 | Textual scrolling functions (aside from @code{scroll-other-window}) |
| 2518 | have unpredictable results if the current buffer is not the one | 2522 | have unpredictable results if the current buffer is not the one |
| @@ -2542,13 +2546,8 @@ signals an error. Otherwise, it returns @code{nil}. | |||
| 2542 | This function scrolls backward by @var{count} lines in the selected | 2546 | This function scrolls backward by @var{count} lines in the selected |
| 2543 | window. | 2547 | window. |
| 2544 | 2548 | ||
| 2545 | If @var{count} is negative, it scrolls forward instead. If | 2549 | If @var{count} is negative, it scrolls forward instead. In other |
| 2546 | @var{count} is omitted or @code{nil}, the distance scrolled is | 2550 | respects, it behaves the same way as @code{scroll-up} does. |
| 2547 | @code{next-screen-context-lines} lines less than the height of the | ||
| 2548 | window's text area. | ||
| 2549 | |||
| 2550 | If the selected window cannot be scrolled any further, this function | ||
| 2551 | signals an error. Otherwise, it returns @code{nil}. | ||
| 2552 | @end deffn | 2551 | @end deffn |
| 2553 | 2552 | ||
| 2554 | @deffn Command scroll-up-command &optional count | 2553 | @deffn Command scroll-up-command &optional count |
| @@ -2578,8 +2577,8 @@ already displayed, @code{scroll-other-window} displays it in some | |||
| 2578 | window. | 2577 | window. |
| 2579 | 2578 | ||
| 2580 | When the selected window is the minibuffer, the next window is normally | 2579 | When the selected window is the minibuffer, the next window is normally |
| 2581 | the one at the top left corner. You can specify a different window to | 2580 | the leftmost one immediately above it. You can specify a different |
| 2582 | scroll, when the minibuffer is selected, by setting the variable | 2581 | window to scroll, when the minibuffer is selected, by setting the variable |
| 2583 | @code{minibuffer-scroll-window}. This variable has no effect when any | 2582 | @code{minibuffer-scroll-window}. This variable has no effect when any |
| 2584 | other window is selected. When it is non-@code{nil} and the | 2583 | other window is selected. When it is non-@code{nil} and the |
| 2585 | minibuffer is selected, it takes precedence over | 2584 | minibuffer is selected, it takes precedence over |
| @@ -2591,7 +2590,7 @@ window is the one at the bottom right corner. In this case, | |||
| 2591 | @code{scroll-other-window} attempts to scroll the minibuffer. If the | 2590 | @code{scroll-other-window} attempts to scroll the minibuffer. If the |
| 2592 | minibuffer contains just one line, it has nowhere to scroll to, so the | 2591 | minibuffer contains just one line, it has nowhere to scroll to, so the |
| 2593 | line reappears after the echo area momentarily displays the message | 2592 | line reappears after the echo area momentarily displays the message |
| 2594 | @samp{Beginning of buffer}. | 2593 | @samp{End of buffer}. |
| 2595 | @end deffn | 2594 | @end deffn |
| 2596 | 2595 | ||
| 2597 | @defvar other-window-scroll-buffer | 2596 | @defvar other-window-scroll-buffer |
| @@ -2690,12 +2689,12 @@ If @var{count} is a non-negative number, that puts the line containing | |||
| 2690 | point @var{count} lines down from the top of the window. If | 2689 | point @var{count} lines down from the top of the window. If |
| 2691 | @var{count} is a negative number, then it counts upward from the | 2690 | @var{count} is a negative number, then it counts upward from the |
| 2692 | bottom of the window, so that @minus{}1 stands for the last usable | 2691 | bottom of the window, so that @minus{}1 stands for the last usable |
| 2693 | line in the window. If @var{count} is a non-@code{nil} list, then it | 2692 | line in the window. |
| 2694 | stands for the line in the middle of the window. | ||
| 2695 | 2693 | ||
| 2696 | If @var{count} is @code{nil}, @code{recenter} puts the line containing | 2694 | If @var{count} is @code{nil} (or a non-@code{nil} list), |
| 2697 | point in the middle of the window, then clears and redisplays the entire | 2695 | @code{recenter} puts the line containing point in the middle of the |
| 2698 | selected frame. | 2696 | window. If @var{count} is @code{nil}, this function may redraw the |
| 2697 | frame, according to the value of @code{recenter-redisplay}. | ||
| 2699 | 2698 | ||
| 2700 | When @code{recenter} is called interactively, @var{count} is the raw | 2699 | When @code{recenter} is called interactively, @var{count} is the raw |
| 2701 | prefix argument. Thus, typing @kbd{C-u} as the prefix sets the | 2700 | prefix argument. Thus, typing @kbd{C-u} as the prefix sets the |
| @@ -2704,22 +2703,32 @@ prefix argument. Thus, typing @kbd{C-u} as the prefix sets the | |||
| 2704 | top. | 2703 | top. |
| 2705 | 2704 | ||
| 2706 | With an argument of zero, @code{recenter} positions the current line at | 2705 | With an argument of zero, @code{recenter} positions the current line at |
| 2707 | the top of the window. This action is so handy that some people make a | 2706 | the top of the window. The command @code{recenter-top-bottom} offers |
| 2708 | separate key binding to do this. For example, | 2707 | a more convenient way to achieve this. |
| 2708 | @end deffn | ||
| 2709 | 2709 | ||
| 2710 | @example | 2710 | @defopt recenter-redisplay |
| 2711 | @group | 2711 | If this variable is non-@code{nil}, calling @code{recenter} with a |
| 2712 | (defun line-to-top-of-window () | 2712 | @code{nil} argument redraws the frame. The default value is |
| 2713 | "Scroll current line to top of window. | 2713 | @code{tty}, which means only redraw the frame if it is a tty frame. |
| 2714 | Replaces three keystroke sequence C-u 0 C-l." | 2714 | @end defopt |
| 2715 | (interactive) | ||
| 2716 | (recenter 0)) | ||
| 2717 | 2715 | ||
| 2718 | (global-set-key [kp-multiply] 'line-to-top-of-window) | 2716 | @deffn Command recenter-top-bottom &optional count |
| 2719 | @end group | 2717 | This command, which is the default binding for @kbd{C-l}, acts like |
| 2720 | @end example | 2718 | @code{recenter}, except if called with no argument. In that case, |
| 2719 | successive calls place point according to the cycling order defined | ||
| 2720 | by the variable @code{recenter-positions}. | ||
| 2721 | @end deffn | 2721 | @end deffn |
| 2722 | 2722 | ||
| 2723 | @defopt recenter-positions | ||
| 2724 | This variable controls how @code{recenter-top-bottom} behaves when | ||
| 2725 | called with no argument. The default value is @code{(middle top | ||
| 2726 | bottom)}, which means that successive calls of | ||
| 2727 | @code{recenter-top-bottom} with no argument cycle between placing | ||
| 2728 | point at the middle, top, and bottom of the window. | ||
| 2729 | @end defopt | ||
| 2730 | |||
| 2731 | |||
| 2723 | @node Vertical Scrolling | 2732 | @node Vertical Scrolling |
| 2724 | @section Vertical Fractional Scrolling | 2733 | @section Vertical Fractional Scrolling |
| 2725 | @cindex vertical fractional scrolling | 2734 | @cindex vertical fractional scrolling |
| @@ -3005,7 +3014,7 @@ frame. | |||
| 3005 | 3014 | ||
| 3006 | @defun coordinates-in-window-p coordinates window | 3015 | @defun coordinates-in-window-p coordinates window |
| 3007 | This function checks whether a window @var{window} occupies the | 3016 | This function checks whether a window @var{window} occupies the |
| 3008 | frame-relative coordinates @var{coordinates}, and if so which part of | 3017 | frame-relative coordinates @var{coordinates}, and if so, which part of |
| 3009 | the window that is. @var{window} should be a live window. | 3018 | the window that is. @var{window} should be a live window. |
| 3010 | @var{coordinates} should be a cons cell of the form @code{(@var{x} | 3019 | @var{coordinates} should be a cons cell of the form @code{(@var{x} |
| 3011 | . @var{y})}, where @var{x} and @var{y} are frame-relative coordinates. | 3020 | . @var{y})}, where @var{x} and @var{y} are frame-relative coordinates. |
| @@ -3103,14 +3112,14 @@ for the current buffer. | |||
| 3103 | You can bring back an entire frame layout by restoring a previously | 3112 | You can bring back an entire frame layout by restoring a previously |
| 3104 | saved window configuration. If you want to record the layout of all | 3113 | saved window configuration. If you want to record the layout of all |
| 3105 | frames instead of just one, use a frame configuration instead of a | 3114 | frames instead of just one, use a frame configuration instead of a |
| 3106 | window configuration; see @ref{Frame Configurations}. | 3115 | window configuration. @xref{Frame Configurations}. |
| 3107 | 3116 | ||
| 3108 | @defun current-window-configuration &optional frame | 3117 | @defun current-window-configuration &optional frame |
| 3109 | This function returns a new object representing @var{frame}'s current | 3118 | This function returns a new object representing @var{frame}'s current |
| 3110 | window configuration. The default for @var{frame} is the selected | 3119 | window configuration. The default for @var{frame} is the selected |
| 3111 | frame. The variable @code{window-persistent-parameters} specifies | 3120 | frame. The variable @code{window-persistent-parameters} specifies |
| 3112 | whether and which window parameters are saved by this function, see | 3121 | which window parameters (if any) are saved by this function. |
| 3113 | @ref{Window Parameters} for details. | 3122 | @xref{Window Parameters}. |
| 3114 | @end defun | 3123 | @end defun |
| 3115 | 3124 | ||
| 3116 | @defun set-window-configuration configuration | 3125 | @defun set-window-configuration configuration |
| @@ -3127,7 +3136,7 @@ change and triggers execution of the @code{window-size-change-functions} | |||
| 3127 | know how to tell whether the new configuration actually differs from the | 3136 | know how to tell whether the new configuration actually differs from the |
| 3128 | old one. | 3137 | old one. |
| 3129 | 3138 | ||
| 3130 | If the frame which @var{configuration} was saved from is dead, all this | 3139 | If the frame from which @var{configuration} was saved is dead, all this |
| 3131 | function does is restore the three variables @code{window-min-height}, | 3140 | function does is restore the three variables @code{window-min-height}, |
| 3132 | @code{window-min-width} and @code{minibuffer-scroll-window}. In this | 3141 | @code{window-min-width} and @code{minibuffer-scroll-window}. In this |
| 3133 | case, the function returns @code{nil}. Otherwise, it returns @code{t}. | 3142 | case, the function returns @code{nil}. Otherwise, it returns @code{t}. |
| @@ -3212,8 +3221,8 @@ configurations. | |||
| 3212 | 3221 | ||
| 3213 | The objects returned by @code{current-window-configuration} die | 3222 | The objects returned by @code{current-window-configuration} die |
| 3214 | together with the Emacs process. In order to store a window | 3223 | together with the Emacs process. In order to store a window |
| 3215 | configuration on disk and read it back in another Emacs session, the | 3224 | configuration on disk and read it back in another Emacs session, you |
| 3216 | functions described next can be used. These functions are also useful | 3225 | can use the functions described next. These functions are also useful |
| 3217 | to clone the state of a frame into an arbitrary live window | 3226 | to clone the state of a frame into an arbitrary live window |
| 3218 | (@code{set-window-configuration} effectively clones the windows of a | 3227 | (@code{set-window-configuration} effectively clones the windows of a |
| 3219 | frame into the root window of that very frame only). | 3228 | frame into the root window of that very frame only). |
| @@ -3230,13 +3239,13 @@ state will be written to disk and read back in another session. | |||
| 3230 | 3239 | ||
| 3231 | Together, the argument @var{writable} and the variable | 3240 | Together, the argument @var{writable} and the variable |
| 3232 | @code{window-persistent-parameters} specify which window parameters are | 3241 | @code{window-persistent-parameters} specify which window parameters are |
| 3233 | saved by this function, see @ref{Window Parameters} for details. | 3242 | saved by this function. @xref{Window Parameters}. |
| 3234 | @end defun | 3243 | @end defun |
| 3235 | 3244 | ||
| 3236 | The value returned by @code{window-state-get} can be used in the same | 3245 | The value returned by @code{window-state-get} can be used in the same |
| 3237 | session to make a clone of a window in another window. It can be also | 3246 | session to make a clone of a window in another window. It can be also |
| 3238 | written to disk and read back in another session. In either case, use | 3247 | written to disk and read back in another session. In either case, use |
| 3239 | the function described next to restore the state of the window. | 3248 | the following function to restore the state of the window. |
| 3240 | 3249 | ||
| 3241 | @defun window-state-put state &optional window ignore | 3250 | @defun window-state-put state &optional window ignore |
| 3242 | This function puts the window state @var{state} into @var{window}. The | 3251 | This function puts the window state @var{state} into @var{window}. The |
| @@ -3245,9 +3254,9 @@ earlier invocation of @code{window-state-get}, see above. The optional | |||
| 3245 | argument @var{window} must specify a live window and defaults to the | 3254 | argument @var{window} must specify a live window and defaults to the |
| 3246 | selected one. | 3255 | selected one. |
| 3247 | 3256 | ||
| 3248 | The optional argument @var{ignore} non-@code{nil} means to ignore | 3257 | If the optional argument @var{ignore} is non-@code{nil}, it means to ignore |
| 3249 | minimum window sizes and fixed size restrictions. If @var{ignore} | 3258 | minimum window sizes and fixed-size restrictions. If @var{ignore} |
| 3250 | equals @code{safe}, this means windows can get as small as one line | 3259 | is @code{safe}, this means windows can get as small as one line |
| 3251 | and/or two columns. | 3260 | and/or two columns. |
| 3252 | @end defun | 3261 | @end defun |
| 3253 | 3262 | ||
| @@ -3267,8 +3276,8 @@ setting for @var{parameter}, this function returns @code{nil}. | |||
| 3267 | 3276 | ||
| 3268 | @defun window-parameters &optional window | 3277 | @defun window-parameters &optional window |
| 3269 | This function returns all parameters of @var{window} and their values. | 3278 | This function returns all parameters of @var{window} and their values. |
| 3270 | The default for @var{window} is the selected window. The return value, | 3279 | The default for @var{window} is the selected window. The return value |
| 3271 | if non-@code{nil} is an association list whose elements have the form | 3280 | is either @code{nil}, or an association list whose elements have the form |
| 3272 | @code{(@var{parameter} . @var{value})}. | 3281 | @code{(@var{parameter} . @var{value})}. |
| 3273 | @end defun | 3282 | @end defun |
| 3274 | 3283 | ||
| @@ -3278,34 +3287,34 @@ This function sets @var{window}'s value of @var{parameter} to | |||
| 3278 | is the selected window. | 3287 | is the selected window. |
| 3279 | @end defun | 3288 | @end defun |
| 3280 | 3289 | ||
| 3281 | By default, functions saving and restoring window configurations or the | 3290 | By default, the functions that save and restore window configurations or the |
| 3282 | states of windows (@pxref{Window Configurations}) do not care about | 3291 | states of windows (@pxref{Window Configurations}) do not care about |
| 3283 | window parameters. This means, that when you change the value of a | 3292 | window parameters. This means that when you change the value of a |
| 3284 | parameter within the body of a @code{save-window-excursion}, the | 3293 | parameter within the body of a @code{save-window-excursion}, the |
| 3285 | previous value is not restored upon exit of that macro. It also means | 3294 | previous value is not restored when that macro exits. It also means |
| 3286 | that when you restore via @code{window-state-put} a window state saved | 3295 | that when you restore via @code{window-state-put} a window state saved |
| 3287 | earlier by @code{window-state-get}, all cloned windows have their | 3296 | earlier by @code{window-state-get}, all cloned windows have their |
| 3288 | parameters reset to @code{nil}. The following variable allows to | 3297 | parameters reset to @code{nil}. The following variable allows you to |
| 3289 | override the standard behavior. | 3298 | override the standard behavior: |
| 3290 | 3299 | ||
| 3291 | @defvar window-persistent-parameters | 3300 | @defvar window-persistent-parameters |
| 3292 | This variable is an alist specifying which parameters get saved by | 3301 | This variable is an alist specifying which parameters get saved by |
| 3293 | @code{current-window-configuration} and @code{window-state-get} and | 3302 | @code{current-window-configuration} and @code{window-state-get}, and |
| 3294 | subsequently restored by @code{set-window-configuration} and | 3303 | subsequently restored by @code{set-window-configuration} and |
| 3295 | @code{window-state-put}, see @ref{Window Configurations}. | 3304 | @code{window-state-put}. @xref{Window Configurations}. |
| 3296 | 3305 | ||
| 3297 | The @sc{car} of each entry of this alist is the symbol specifying the | 3306 | The @sc{car} of each entry of this alist is a symbol specifying the |
| 3298 | parameter. The @sc{cdr} should be one of the following: | 3307 | parameter. The @sc{cdr} should be one of the following: |
| 3299 | 3308 | ||
| 3300 | @table @asis | 3309 | @table @asis |
| 3301 | @item @code{nil} | 3310 | @item @code{nil} |
| 3302 | This value means the parameter is neither saved by | 3311 | This value means the parameter is saved neither by |
| 3303 | @code{window-state-get} nor by @code{current-window-configuration}. | 3312 | @code{window-state-get} nor by @code{current-window-configuration}. |
| 3304 | 3313 | ||
| 3305 | @item @code{t} | 3314 | @item @code{t} |
| 3306 | This value specifies that the parameter is saved by | 3315 | This value specifies that the parameter is saved by |
| 3307 | @code{current-window-configuration} and, provided its @var{writable} | 3316 | @code{current-window-configuration} and (provided its @var{writable} |
| 3308 | argument is @code{nil}, by @code{window-state-get}. | 3317 | argument is @code{nil}) by @code{window-state-get}. |
| 3309 | 3318 | ||
| 3310 | @item @code{writable} | 3319 | @item @code{writable} |
| 3311 | This means that the parameter is saved unconditionally by both | 3320 | This means that the parameter is saved unconditionally by both |
| @@ -3316,8 +3325,8 @@ may fail with an @code{invalid-read-syntax} error. | |||
| 3316 | @end table | 3325 | @end table |
| 3317 | @end defvar | 3326 | @end defvar |
| 3318 | 3327 | ||
| 3319 | Some functions, notably @code{delete-window}, | 3328 | Some functions (notably @code{delete-window}, |
| 3320 | @code{delete-other-windows} and @code{split-window} may behave specially | 3329 | @code{delete-other-windows} and @code{split-window}), may behave specially |
| 3321 | when their @var{window} argument has a parameter set. You can override | 3330 | when their @var{window} argument has a parameter set. You can override |
| 3322 | such special behavior by binding the following variable to a | 3331 | such special behavior by binding the following variable to a |
| 3323 | non-@code{nil} value: | 3332 | non-@code{nil} value: |
| @@ -3325,7 +3334,7 @@ non-@code{nil} value: | |||
| 3325 | @defvar ignore-window-parameters | 3334 | @defvar ignore-window-parameters |
| 3326 | If this variable is non-@code{nil}, some standard functions do not | 3335 | If this variable is non-@code{nil}, some standard functions do not |
| 3327 | process window parameters. The functions currently affected by this are | 3336 | process window parameters. The functions currently affected by this are |
| 3328 | @code{split-window}, @code{delete-window}, @code{delete-other-windows} | 3337 | @code{split-window}, @code{delete-window}, @code{delete-other-windows}, |
| 3329 | and @code{other-window}. | 3338 | and @code{other-window}. |
| 3330 | 3339 | ||
| 3331 | An application can bind this variable to a non-@code{nil} value around | 3340 | An application can bind this variable to a non-@code{nil} value around |
| @@ -3359,18 +3368,19 @@ This parameter marks the window as not selectable by @code{other-window} | |||
| 3359 | (@pxref{Cyclic Window Ordering}). | 3368 | (@pxref{Cyclic Window Ordering}). |
| 3360 | 3369 | ||
| 3361 | @item @code{clone-of} | 3370 | @item @code{clone-of} |
| 3362 | This parameter specifies the window this one has been cloned from and is | 3371 | This parameter specifies the window that this one has been cloned |
| 3363 | installed by @code{window-state-get}, see @ref{Window Configurations}. | 3372 | from. It is installed by @code{window-state-get} (@pxref{Window |
| 3373 | Configurations}). | ||
| 3364 | 3374 | ||
| 3365 | @item @code{quit-restore} | 3375 | @item @code{quit-restore} |
| 3366 | This parameter tells how to proceed with a window when the buffer it | 3376 | This parameter specifies what to do with a window when the buffer it |
| 3367 | shows is no more needed. It is installed by the buffer display | 3377 | shows is not needed any more. It is installed by the buffer display |
| 3368 | functions (@pxref{Choosing Window}) and consulted by the function | 3378 | functions (@pxref{Choosing Window}), and consulted by the function |
| 3369 | @code{quit-window} (@pxref{Quitting Windows}). | 3379 | @code{quit-window} (@pxref{Quitting Windows}). |
| 3370 | @end table | 3380 | @end table |
| 3371 | 3381 | ||
| 3372 | In addition, the parameters @code{window-atom} and @code{window-side} | 3382 | There are additional parameters @code{window-atom} and @code{window-side}; |
| 3373 | are reserved and should not be used by applications. | 3383 | these are reserved and should not be used by applications. |
| 3374 | 3384 | ||
| 3375 | 3385 | ||
| 3376 | @node Window Hooks | 3386 | @node Window Hooks |
| @@ -3392,7 +3402,7 @@ the window also runs these functions. | |||
| 3392 | This variable is not a normal hook, because each function is called with | 3402 | This variable is not a normal hook, because each function is called with |
| 3393 | two arguments: the window, and its new display-start position. | 3403 | two arguments: the window, and its new display-start position. |
| 3394 | 3404 | ||
| 3395 | These functions must be careful in using @code{window-end} | 3405 | These functions must take care when using @code{window-end} |
| 3396 | (@pxref{Window Start and End}); if you need an up-to-date value, you | 3406 | (@pxref{Window Start and End}); if you need an up-to-date value, you |
| 3397 | must use the @var{update} argument to ensure you get it. | 3407 | must use the @var{update} argument to ensure you get it. |
| 3398 | 3408 | ||
| @@ -3430,7 +3440,7 @@ of an existing frame. This includes splitting or deleting windows, | |||
| 3430 | changing the sizes of windows, or displaying a different buffer in a | 3440 | changing the sizes of windows, or displaying a different buffer in a |
| 3431 | window. | 3441 | window. |
| 3432 | 3442 | ||
| 3433 | The buffer-local part of this hook is run once per each window on the | 3443 | The buffer-local part of this hook is run once for each window on the |
| 3434 | affected frame, with the relevant window selected and its buffer | 3444 | affected frame, with the relevant window selected and its buffer |
| 3435 | current. The global part is run once for the modified frame, with that | 3445 | current. The global part is run once for the modified frame, with that |
| 3436 | frame selected. | 3446 | frame selected. |