diff options
| author | Chong Yidong | 2012-03-20 16:52:11 +0800 |
|---|---|---|
| committer | Chong Yidong | 2012-03-20 16:52:11 +0800 |
| commit | 025de85b0709596975ddcd0fa298f88d12493254 (patch) | |
| tree | 32d0edb7f14590f3ddc709ecfdbacc8f1e867216 /doc | |
| parent | ee52ebf3e27fc33defe5971c2410dbe8746919e3 (diff) | |
| download | emacs-025de85b0709596975ddcd0fa298f88d12493254.tar.gz emacs-025de85b0709596975ddcd0fa298f88d12493254.zip | |
Update doc to reflect new non-nil value of redisplay-dont-pause.
* doc/lispref/display.texi (Forcing Redisplay): Various rewrites to reflect
new value of redisplay-dont-pause.
(Truncation): Copyedits.
* src/dispnew.c (Fredisplay, Vredisplay_preemption_period): Update doc
to reflect default non-nil value of redisplay-dont-pause.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/lispref/ChangeLog | 6 | ||||
| -rw-r--r-- | doc/lispref/display.texi | 122 |
2 files changed, 66 insertions, 62 deletions
diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog index d8e96914d51..43ae349cb4c 100644 --- a/doc/lispref/ChangeLog +++ b/doc/lispref/ChangeLog | |||
| @@ -1,3 +1,9 @@ | |||
| 1 | 2012-03-20 Chong Yidong <cyd@gnu.org> | ||
| 2 | |||
| 3 | * display.texi (Forcing Redisplay): Various rewrites to reflect | ||
| 4 | new value of redisplay-dont-pause. | ||
| 5 | (Truncation): Copyedits. | ||
| 6 | |||
| 1 | 2012-03-20 Glenn Morris <rgm@gnu.org> | 7 | 2012-03-20 Glenn Morris <rgm@gnu.org> |
| 2 | 8 | ||
| 3 | * os.texi (Startup Summary): Don't mention initial-buffer-choice = t. | 9 | * os.texi (Startup Summary): Don't mention initial-buffer-choice = t. |
diff --git a/doc/lispref/display.texi b/doc/lispref/display.texi index c70418be52b..b68b0697936 100644 --- a/doc/lispref/display.texi +++ b/doc/lispref/display.texi | |||
| @@ -86,59 +86,57 @@ attempt to redisplay, in the middle of Lisp code, without actually | |||
| 86 | waiting for input. | 86 | waiting for input. |
| 87 | 87 | ||
| 88 | @defun redisplay &optional force | 88 | @defun redisplay &optional force |
| 89 | This function tries immediately to redisplay, provided there are no | 89 | This function tries immediately to redisplay. The optional argument |
| 90 | pending input events. | 90 | @var{force}, if non-@code{nil}, forces the redisplay to be performed, |
| 91 | 91 | instead of being preempted, even if input is pending and the variable | |
| 92 | If the optional argument @var{force} is non-@code{nil}, it does all | 92 | @code{redisplay-dont-pause} is @code{nil} (see below). If |
| 93 | pending redisplay work even if input is available, with no | 93 | @code{redisplay-dont-pause} is non-@code{nil} (the default), this |
| 94 | pre-emption. | 94 | function redisplays in any case, i.e.@: @var{force} does nothing. |
| 95 | 95 | ||
| 96 | The function returns @code{t} if it actually tried to redisplay, and | 96 | The function returns @code{t} if it actually tried to redisplay, and |
| 97 | @code{nil} otherwise. A value of @code{t} does not mean that | 97 | @code{nil} otherwise. A value of @code{t} does not mean that |
| 98 | redisplay proceeded to completion; it could have been pre-empted by | 98 | redisplay proceeded to completion; it could have been preempted by |
| 99 | newly arriving terminal input. | 99 | newly arriving input. |
| 100 | @end defun | ||
| 101 | |||
| 102 | @code{redisplay} with no argument tries immediately to redisplay, | ||
| 103 | but has no effect on the usual rules for what parts of the screen to | ||
| 104 | redisplay. By contrast, the following function adds certain windows | ||
| 105 | to the pending redisplay work (as if their contents had completely | ||
| 106 | changed), but doesn't immediately try to do any redisplay work. | ||
| 107 | |||
| 108 | @defun force-window-update &optional object | ||
| 109 | This function forces some or all windows to be updated on next | ||
| 110 | redisplay. If @var{object} is a window, it requires eventual | ||
| 111 | redisplay of that window. If @var{object} is a buffer or buffer name, | ||
| 112 | it requires eventual redisplay of all windows displaying that buffer. | ||
| 113 | If @var{object} is @code{nil} (or omitted), it requires eventual | ||
| 114 | redisplay of all windows. | ||
| 115 | @end defun | 100 | @end defun |
| 116 | 101 | ||
| 117 | @code{force-window-update} does not do a redisplay immediately. | ||
| 118 | (Emacs will do that when it waits for input.) Rather, its effect is | ||
| 119 | to put more work on the queue to be done by redisplay whenever there | ||
| 120 | is a chance. | ||
| 121 | |||
| 122 | @defvar redisplay-dont-pause | 102 | @defvar redisplay-dont-pause |
| 123 | If this variable is non-@code{nil}, pending input does not prevent or | 103 | If this variable is @code{nil}, arriving input events preempt |
| 124 | halt redisplay; redisplay occurs, and finishes, regardless of whether | 104 | redisplay; Emacs avoids starting a redisplay, and stops any redisplay |
| 125 | input is available. If it is @code{nil}, Emacs redisplay stops if | 105 | that is in progress, until the input has been processed. In |
| 126 | input arrives, and does not happen at all if input is available before | 106 | particular, @code{(redisplay)} returns @code{nil} without actually |
| 127 | it starts. The default is @code{t}. | 107 | redisplaying, if there is pending input. |
| 108 | |||
| 109 | The default value is @code{t}, which means that pending input does not | ||
| 110 | preempt redisplay. | ||
| 128 | @end defvar | 111 | @end defvar |
| 129 | 112 | ||
| 130 | @defvar redisplay-preemption-period | 113 | @defvar redisplay-preemption-period |
| 131 | This variable specifies how many seconds Emacs waits between checks | 114 | If @code{redisplay-dont-pause} is @code{nil}, this variable specifies |
| 132 | for new input during redisplay. (The default is 0.1 seconds.) If | 115 | how many seconds Emacs waits between checks for new input during |
| 133 | input has arrived when Emacs checks, it pre-empts redisplay and | 116 | redisplay; if input arrives during this interval, redisplay stops and |
| 134 | processes the available input before trying again to redisplay. | 117 | the input is processed. The default value is 0.1; if the value is |
| 118 | @code{nil}, Emacs does not check for input during redisplay. | ||
| 119 | |||
| 120 | This variable has no effect when @code{redisplay-dont-pause} is | ||
| 121 | non-@code{nil} (the default). | ||
| 122 | @end defvar | ||
| 135 | 123 | ||
| 136 | If this variable is @code{nil}, Emacs does not check for input during | 124 | Although @code{redisplay} tries immediately to redisplay, it does |
| 137 | redisplay, and redisplay cannot be preempted by input. | 125 | not change how Emacs decides which parts of its frame(s) to redisplay. |
| 126 | By contrast, the following function adds certain windows to the | ||
| 127 | pending redisplay work (as if their contents had completely changed), | ||
| 128 | but does not immediately try to perform redisplay. | ||
| 138 | 129 | ||
| 139 | This variable is only obeyed on graphical terminals. For | 130 | @defun force-window-update &optional object |
| 140 | text terminals, see @ref{Terminal Output}. | 131 | This function forces some or all windows to be updated the next time |
| 141 | @end defvar | 132 | Emacs does a redisplay. If @var{object} is a window, that window is |
| 133 | to be updated. If @var{object} is a buffer or buffer name, all | ||
| 134 | windows displaying that buffer are to be updated. If @var{object} is | ||
| 135 | @code{nil} (or omitted), all windows are to be updated. | ||
| 136 | |||
| 137 | This function does not do a redisplay immediately; Emacs does that as | ||
| 138 | it waits for input, or when the function @code{redisplay} is called. | ||
| 139 | @end defun | ||
| 142 | 140 | ||
| 143 | @node Truncation | 141 | @node Truncation |
| 144 | @section Truncation | 142 | @section Truncation |
| @@ -169,7 +167,7 @@ If this buffer-local variable is non-@code{nil}, lines that extend | |||
| 169 | beyond the right edge of the window are truncated; otherwise, they are | 167 | beyond the right edge of the window are truncated; otherwise, they are |
| 170 | continued. As a special exception, the variable | 168 | continued. As a special exception, the variable |
| 171 | @code{truncate-partial-width-windows} takes precedence in | 169 | @code{truncate-partial-width-windows} takes precedence in |
| 172 | @dfn{partial-width} windows (i.e., windows that do not occupy the | 170 | @dfn{partial-width} windows (i.e.@: windows that do not occupy the |
| 173 | entire frame width). | 171 | entire frame width). |
| 174 | @end defopt | 172 | @end defopt |
| 175 | 173 | ||
| @@ -192,37 +190,37 @@ a window, that forces truncation. | |||
| 192 | 190 | ||
| 193 | @defvar wrap-prefix | 191 | @defvar wrap-prefix |
| 194 | If this buffer-local variable is non-@code{nil}, it defines a | 192 | If this buffer-local variable is non-@code{nil}, it defines a |
| 195 | ``prefix'' that is prepended to every continuation line at | 193 | @dfn{wrap prefix} which Emacs displays at the start of every |
| 196 | display time. (If lines are truncated, the wrap-prefix is never | 194 | continuation line. (If lines are truncated, @code{wrap-prefix} is |
| 197 | used.) It may be a string or an image (@pxref{Other Display Specs}), | 195 | never used.) Its value may be a string or an image (@pxref{Other |
| 198 | or a stretch of whitespace such as specified by the @code{:width} or | 196 | Display Specs}), or a stretch of whitespace such as specified by the |
| 199 | @code{:align-to} display properties (@pxref{Specified Space}). The | 197 | @code{:width} or @code{:align-to} display properties (@pxref{Specified |
| 200 | value is interpreted in the same way as a @code{display} text | 198 | Space}). The value is interpreted in the same way as a @code{display} |
| 201 | property. @xref{Display Property}. | 199 | text property. @xref{Display Property}. |
| 202 | 200 | ||
| 203 | A wrap-prefix may also be specified for regions of text, using the | 201 | A wrap prefix may also be specified for regions of text, using the |
| 204 | @code{wrap-prefix} text or overlay property. This takes precedence | 202 | @code{wrap-prefix} text or overlay property. This takes precedence |
| 205 | over the @code{wrap-prefix} variable. @xref{Special Properties}. | 203 | over the @code{wrap-prefix} variable. @xref{Special Properties}. |
| 206 | @end defvar | 204 | @end defvar |
| 207 | 205 | ||
| 208 | @defvar line-prefix | 206 | @defvar line-prefix |
| 209 | If this buffer-local variable is non-@code{nil}, it defines a | 207 | If this buffer-local variable is non-@code{nil}, it defines a |
| 210 | ``prefix'' that is prepended to every non-continuation line at | 208 | @dfn{line prefix} which Emacs displays at the start of every |
| 211 | display time. It may be a string or an image (@pxref{Other Display | 209 | non-continuation line. Its value may be a string or an image |
| 212 | Specs}), or a stretch of whitespace such as specified by the | 210 | (@pxref{Other Display Specs}), or a stretch of whitespace such as |
| 213 | @code{:width} or @code{:align-to} display properties (@pxref{Specified | 211 | specified by the @code{:width} or @code{:align-to} display properties |
| 214 | Space}). The value is interpreted in the same way as a @code{display} | 212 | (@pxref{Specified Space}). The value is interpreted in the same way |
| 215 | text property. @xref{Display Property}. | 213 | as a @code{display} text property. @xref{Display Property}. |
| 216 | 214 | ||
| 217 | A line-prefix may also be specified for regions of text using the | 215 | A line prefix may also be specified for regions of text using the |
| 218 | @code{line-prefix} text or overlay property. This takes precedence | 216 | @code{line-prefix} text or overlay property. This takes precedence |
| 219 | over the @code{line-prefix} variable. @xref{Special Properties}. | 217 | over the @code{line-prefix} variable. @xref{Special Properties}. |
| 220 | @end defvar | 218 | @end defvar |
| 221 | 219 | ||
| 222 | If your buffer contains @emph{very} long lines, and you use | 220 | If your buffer contains @emph{very} long lines, and you use |
| 223 | continuation to display them, computing the continuation lines can | 221 | continuation to display them, computing the continuation lines can |
| 224 | make Emacs redisplay slow. The column computation and indentation | 222 | make redisplay slow. The column computation and indentation functions |
| 225 | functions also become slow. Then you might find it advisable to set | 223 | also become slow. Then you might find it advisable to set |
| 226 | @code{cache-long-line-scans} to @code{t}. | 224 | @code{cache-long-line-scans} to @code{t}. |
| 227 | 225 | ||
| 228 | @defvar cache-long-line-scans | 226 | @defvar cache-long-line-scans |