(Glossary): Explain `iff'.
[emacs.git] / man / display.texi
blob020721fb462500c8199440f9723862f2c9a892a2
1 @c This is part of the Emacs manual.
2 @c Copyright (C) 1985, 1986, 1987, 1993, 1994, 1995, 1997, 2000, 2001,
3 @c   2002, 2003, 2004, 2005, 2006, 2007 Free Software Foundation, Inc.
4 @c See file emacs.texi for copying conditions.
5 @node Display, Search, Registers, Top
6 @chapter Controlling the Display
8   Since only part of a large buffer fits in the window, Emacs tries to
9 show a part that is likely to be interesting.  Display-control
10 commands allow you to specify which part of the text you want to see,
11 and how to display it.  Many variables also affect the details of
12 redisplay.  Unless otherwise stated, the variables described in this
13 chapter have their effect by customizing redisplay itself; therefore,
14 their values only make a difference at the time of redisplay.
16 @menu
17 * Scrolling::              Commands to move text up and down in a window.
18 * Auto Scrolling::         Redisplay scrolls text automatically when needed.
19 * Horizontal Scrolling::   Moving text left and right in a window.
20 * Follow Mode::            Follow mode lets two windows scroll as one.
21 * Faces::                  How to change the display style using faces.
22 * Standard Faces::         Emacs' predefined faces.
23 * Font Lock::              Minor mode for syntactic highlighting using faces.
24 * Highlight Interactively:: Tell Emacs what text to highlight.
25 * Fringes::                Enabling or disabling window fringes.
26 * Displaying Boundaries::  Displaying top and bottom of the buffer.
27 * Useless Whitespace::     Showing possibly-spurious trailing whitespace.
28 * Selective Display::      Hiding lines with lots of indentation.
29 * Optional Mode Line::     Optional mode line display features.
30 * Text Display::           How text characters are normally displayed.
31 * Cursor Display::         Features for displaying the cursor.
32 * Line Truncation::        Truncating lines to fit the screen width instead
33                              of continuing them to multiple screen lines.
34 * Display Custom::         Information on variables for customizing display.
35 @end menu
37 @node Scrolling
38 @section Scrolling
40   If a buffer contains text that is too large to fit entirely within a
41 window that is displaying the buffer, Emacs shows a contiguous portion of
42 the text.  The portion shown always contains point.
44 @cindex scrolling
45   @dfn{Scrolling} means moving text up or down in the window so that
46 different parts of the text are visible.  Scrolling ``forward'' or
47 ``up'' means that text moves up, and new text appears at the bottom.
48 Scrolling ``backward'' or ``down'' moves text down, and new text
49 appears at the top.
51   Scrolling happens automatically if you move point past the bottom or
52 top of the window.  You can also scroll explicitly with the commands
53 in this section.
55 @table @kbd
56 @item C-l
57 Clear screen and redisplay, scrolling the selected window to center
58 point vertically within it (@code{recenter}).
59 @item C-v
60 Scroll forward (a windowful or a specified number of lines) (@code{scroll-up}).
61 @item @key{NEXT}
62 @itemx @key{PAGEDOWN}
63 Likewise, scroll forward.
64 @item M-v
65 Scroll backward (@code{scroll-down}).
66 @item @key{PRIOR}
67 @itemx @key{PAGEUP}
68 Likewise, scroll backward.
69 @item @var{arg} C-l
70 Scroll so point is on line @var{arg} (@code{recenter}).
71 @item C-M-l
72 Scroll heuristically to bring useful information onto the screen
73 (@code{reposition-window}).
74 @end table
76 @kindex C-l
77 @findex recenter
78   The most basic scrolling command is @kbd{C-l} (@code{recenter}) with
79 no argument.  It scrolls the selected window so that point is halfway
80 down from the top of the window.  On a text terminal, it also clears
81 the screen and redisplays all windows.  That is useful in case the
82 screen is garbled (@pxref{Screen Garbled}).
84 @kindex C-v
85 @kindex M-v
86 @kindex NEXT
87 @kindex PRIOR
88 @kindex PAGEDOWN
89 @kindex PAGEUP
90 @findex scroll-up
91 @findex scroll-down
92   To read the buffer a windowful at a time, use @kbd{C-v}
93 (@code{scroll-up}) with no argument.  This scrolls forward by nearly
94 the whole window height.  The effect is to take the two lines at the
95 bottom of the window and put them at the top, followed by nearly a
96 whole windowful of lines that were not previously visible.  If point
97 was in the text that scrolled off the top, it ends up at the new top
98 of the window.
100 @vindex next-screen-context-lines
101   @kbd{M-v} (@code{scroll-down}) with no argument scrolls backward in
102 a similar way, also with overlap.  The number of lines of overlap that
103 the @kbd{C-v} or @kbd{M-v} commands leave is controlled by the
104 variable @code{next-screen-context-lines}; by default, it is 2.  The
105 function keys @key{NEXT} and @key{PRIOR}, or @key{PAGEDOWN} and
106 @key{PAGEUP}, are equivalent to @kbd{C-v} and @kbd{M-v}.
108   The commands @kbd{C-v} and @kbd{M-v} with a numeric argument scroll
109 the text in the selected window up or down a few lines.  @kbd{C-v}
110 with an argument moves the text and point up, together, that many
111 lines; it brings the same number of new lines into view at the bottom
112 of the window.  @kbd{M-v} with numeric argument scrolls the text
113 downward, bringing that many new lines into view at the top of the
114 window.  @kbd{C-v} with a negative argument is like @kbd{M-v} and vice
115 versa.
117   The names of scroll commands are based on the direction that the
118 text moves in the window.  Thus, the command to scroll forward is
119 called @code{scroll-up} because it moves the text upward on the
120 screen.  The keys @key{PAGEDOWN} and @key{PAGEUP} derive their names
121 and customary meanings from a different convention that developed
122 elsewhere; hence the strange result that @key{PAGEDOWN} runs
123 @code{scroll-up}.
125 @vindex scroll-preserve-screen-position
126   Some users like the full-screen scroll commands to keep point at the
127 same screen line.  To enable this behavior, set the variable
128 @code{scroll-preserve-screen-position} to a non-@code{nil} value.  In
129 this mode, when these commands would scroll the text around point off
130 the screen, or within @code{scroll-margin} lines of the edge, they
131 moves point to keep the same vertical position within the window.
132 This mode is convenient for browsing through a file by scrolling by
133 screenfuls; if you come back to the screen where you started, point
134 goes back to the line where it started.  However, this mode is
135 inconvenient when you move to the next screen in order to move point
136 to the text there.
138   Another way to do scrolling is with @kbd{C-l} with a numeric argument.
139 @kbd{C-l} does not clear the screen when given an argument; it only scrolls
140 the selected window.  With a positive argument @var{n}, it repositions text
141 to put point @var{n} lines down from the top.  An argument of zero puts
142 point on the very top line.  Point does not move with respect to the text;
143 rather, the text and point move rigidly on the screen.  @kbd{C-l} with a
144 negative argument puts point that many lines from the bottom of the window.
145 For example, @kbd{C-u - 1 C-l} puts point on the bottom line, and @kbd{C-u
146 - 5 C-l} puts it five lines from the bottom.  @kbd{C-u C-l} scrolls to put
147 point at the center (vertically) of the selected window.
149 @kindex C-M-l
150 @findex reposition-window
151   The @kbd{C-M-l} command (@code{reposition-window}) scrolls the current
152 window heuristically in a way designed to get useful information onto
153 the screen.  For example, in a Lisp file, this command tries to get the
154 entire current defun onto the screen if possible.
156 @node Auto Scrolling
157 @section Automatic Scrolling
159 @vindex scroll-conservatively
160   Redisplay scrolls the buffer automatically when point moves out of
161 the visible portion of the text.  The purpose of automatic scrolling
162 is to make point visible, but you can customize many aspects of how
163 this is done.
165   Normally, automatic scrolling centers point vertically within the
166 window.  However, if you set @code{scroll-conservatively} to a small
167 number @var{n}, then if you move point just a little off the
168 screen---less than @var{n} lines---then Emacs scrolls the text just
169 far enough to bring point back on screen.  By default,
170 @code{scroll-conservatively} is@tie{}0.
172 @cindex aggressive scrolling
173 @vindex scroll-up-aggressively
174 @vindex scroll-down-aggressively
175   When the window does scroll by a longer distance, you can control
176 how aggressively it scrolls, by setting the variables
177 @code{scroll-up-aggressively} and @code{scroll-down-aggressively}.
178 The value of @code{scroll-up-aggressively} should be either
179 @code{nil}, or a fraction @var{f} between 0 and 1.  A fraction
180 specifies where on the screen to put point when scrolling upward.
181 More precisely, when a window scrolls up because point is above the
182 window start, the new start position is chosen to put point @var{f}
183 part of the window height from the top.  The larger @var{f}, the more
184 aggressive the scrolling.
186   @code{nil}, which is the default, scrolls to put point at the center.
187 So it is equivalent to .5.
189   Likewise, @code{scroll-down-aggressively} is used for scrolling
190 down.  The value, @var{f}, specifies how far point should be placed
191 from the bottom of the window; thus, as with
192 @code{scroll-up-aggressively}, a larger value is more aggressive.
194 @vindex scroll-margin
195   The variable @code{scroll-margin} restricts how close point can come
196 to the top or bottom of a window.  Its value is a number of screen
197 lines; if point comes within that many lines of the top or bottom of the
198 window, Emacs recenters the window.  By default, @code{scroll-margin} is
201 @node Horizontal Scrolling
202 @section Horizontal Scrolling
203 @cindex horizontal scrolling
205   @dfn{Horizontal scrolling} means shifting all the lines sideways
206 within a window---so that some of the text near the left margin is not
207 displayed at all.  When the text in a window is scrolled horizontally,
208 text lines are truncated rather than continued (@pxref{Line
209 Truncation}).  Whenever a window shows truncated lines, Emacs
210 automatically updates its horizontal scrolling whenever point moves
211 off the left or right edge of the screen.  You can also use these
212 commands to do explicit horizontal scrolling.
214 @table @kbd
215 @item C-x <
216 Scroll text in current window to the left (@code{scroll-left}).
217 @item C-x >
218 Scroll to the right (@code{scroll-right}).
219 @end table
221 @kindex C-x <
222 @kindex C-x >
223 @findex scroll-left
224 @findex scroll-right
225   The command @kbd{C-x <} (@code{scroll-left}) scrolls the selected
226 window to the left by @var{n} columns with argument @var{n}.  This moves
227 part of the beginning of each line off the left edge of the window.
228 With no argument, it scrolls by almost the full width of the window (two
229 columns less, to be precise).
231   @kbd{C-x >} (@code{scroll-right}) scrolls similarly to the right.  The
232 window cannot be scrolled any farther to the right once it is displayed
233 normally (with each line starting at the window's left margin);
234 attempting to do so has no effect.  This means that you don't have to
235 calculate the argument precisely for @w{@kbd{C-x >}}; any sufficiently large
236 argument will restore the normal display.
238   If you use those commands to scroll a window horizontally, that sets
239 a lower bound for automatic horizontal scrolling.  Automatic scrolling
240 will continue to scroll the window, but never farther to the right
241 than the amount you previously set by @code{scroll-left}.
243 @vindex hscroll-margin
244   The value of the variable @code{hscroll-margin} controls how close
245 to the window's edges point is allowed to get before the window will
246 be automatically scrolled.  It is measured in columns.  If the value
247 is 5, then moving point within 5 columns of the edge causes horizontal
248 scrolling away from that edge.
250 @vindex hscroll-step
251   The variable @code{hscroll-step} determines how many columns to
252 scroll the window when point gets too close to the edge.  If it's
253 zero, horizontal scrolling centers point horizontally within the
254 window.  If it's a positive integer, it specifies the number of
255 columns to scroll by.  If it's a floating-point number, it specifies
256 the fraction of the window's width to scroll by.  The default is zero.
258 @vindex auto-hscroll-mode
259   To disable automatic horizontal scrolling, set the variable
260 @code{auto-hscroll-mode} to @code{nil}.
262 @node Follow Mode
263 @section Follow Mode
264 @cindex Follow mode
265 @cindex mode, Follow
266 @findex follow-mode
267 @cindex windows, synchronizing
268 @cindex synchronizing windows
270   @dfn{Follow mode} is a minor mode that makes two windows, both
271 showing the same buffer, scroll as a single tall ``virtual window.''
272 To use Follow mode, go to a frame with just one window, split it into
273 two side-by-side windows using @kbd{C-x 3}, and then type @kbd{M-x
274 follow-mode}.  From then on, you can edit the buffer in either of the
275 two windows, or scroll either one; the other window follows it.
277   In Follow mode, if you move point outside the portion visible in one
278 window and into the portion visible in the other window, that selects
279 the other window---again, treating the two as if they were parts of
280 one large window.
282   To turn off Follow mode, type @kbd{M-x follow-mode} a second time.
284 @node Faces
285 @section Using Multiple Typefaces
286 @cindex faces
288   You can specify various styles for displaying text using
289 @dfn{faces}.  Each face can specify various @dfn{face attributes},
290 such as the font family, the height, weight and slant of the
291 characters, the foreground and background color, and underlining or
292 overlining.  A face does not have to specify all of these attributes;
293 often it inherits most of them from another face.
295   On graphical display, all the Emacs face attributes are meaningful.
296 On a text-only terminal, only some of them work.  Some text-only
297 terminals support inverse video, bold, and underline attributes; some
298 support colors.  Text-only terminals generally do not support changing
299 the height and width or the font family.
301   Emacs uses faces automatically for highlighting, through the work of
302 Font Lock mode.  @xref{Font Lock}, for more information about Font
303 Lock mode and syntactic highlighting.  You can print out the buffer
304 with the highlighting that appears on your screen using the command
305 @code{ps-print-buffer-with-faces}.  @xref{PostScript}.
307   You control the appearance of a part of the text in the buffer by
308 specifying the face or faces to use for it.  The style of display used
309 for any given character is determined by combining the attributes of
310 all the applicable faces specified for that character.  Any attribute
311 that isn't specified by these faces is taken from the @code{default} face,
312 whose attributes reflect the default settings of the frame itself.
314   Enriched mode, the mode for editing formatted text, includes several
315 commands and menus for specifying faces for text in the buffer.
316 @xref{Format Faces}, for how to specify the font for text in the
317 buffer.  @xref{Format Colors}, for how to specify the foreground and
318 background color.
320 @cindex face colors, setting
321 @findex set-face-foreground
322 @findex set-face-background
323   To alter the appearance of a face, use the customization buffer.
324 @xref{Face Customization}.  You can also use X resources to specify
325 attributes of particular faces (@pxref{Resources}).  Alternatively,
326 you can change the foreground and background colors of a specific face
327 with @kbd{M-x set-face-foreground} and @kbd{M-x set-face-background}.
328 These commands prompt in the minibuffer for a face name and a color
329 name, with completion, and then set that face to use the specified
330 color.  Changing the colors of the @code{default} face also changes
331 the foreground and background colors on all frames, both existing and
332 those to be created in the future.  (You can also set foreground and
333 background colors for the current frame only; see @ref{Frame
334 Parameters}.)
336   Emacs can correctly display variable-width fonts, but Emacs commands
337 that calculate width and indentation do not know how to calculate
338 variable widths.  This can sometimes lead to incorrect results when
339 you use variable-width fonts.  In particular, indentation commands can
340 give inconsistent results, so we recommend you avoid variable-width
341 fonts for editing program source code.  Filling will sometimes make
342 lines too long or too short.  We plan to address these issues in
343 future Emacs versions.
345 @node Standard Faces
346 @section Standard Faces
348 @findex list-faces-display
349   To see what faces are currently defined, and what they look like,
350 type @kbd{M-x list-faces-display}.  It's possible for a given face to
351 look different in different frames; this command shows the appearance
352 in the frame in which you type it.  With a prefix argument, this
353 prompts for a regular expression, and displays only faces with names
354 matching that regular expression.
356   Here are the standard faces for specifying text appearance.  You can
357 apply them to specific text when you want the effects they produce.
359 @table @code
360 @item default
361 This face is used for ordinary text that doesn't specify any face.
362 @item bold
363 This face uses a bold variant of the default font, if it has one.
364 It's up to you to choose a default font that has a bold variant,
365 if you want to use one.
366 @item italic
367 This face uses an italic variant of the default font, if it has one.
368 @item bold-italic
369 This face uses a bold italic variant of the default font, if it has one.
370 @item underline
371 This face underlines text.
372 @item fixed-pitch
373 This face forces use of a particular fixed-width font.
374 @item variable-pitch
375 This face forces use of a particular variable-width font.  It's
376 reasonable to customize this face to use a different variable-width font,
377 if you like, but you should not make it a fixed-width font.
378 @item shadow
379 This face is used for making the text less noticeable than the surrounding
380 ordinary text.  Usually this can be achieved by using shades of gray in
381 contrast with either black or white default foreground color.
382 @end table
384   Here's an incomplete list of faces used to highlight parts of the
385 text temporarily for specific purposes.  (Many other modes define
386 their own faces for this purpose.)
388 @table @code
389 @item highlight
390 This face is used for highlighting portions of text, in various modes.
391 For example, mouse-sensitive text is highlighted using this face.
392 @item isearch
393 This face is used for highlighting the current Isearch match.
394 @item query-replace
395 This face is used for highlighting the current Query Replace match.
396 @item lazy-highlight
397 This face is used for lazy highlighting of Isearch and Query Replace
398 matches other than the current one.
399 @item region
400 This face is used for displaying a selected region (when Transient Mark
401 mode is enabled---see below).
402 @item secondary-selection
403 This face is used for displaying a secondary X selection (@pxref{Secondary
404 Selection}).
405 @item trailing-whitespace
406 The face for highlighting excess spaces and tabs at the end of a line
407 when @code{show-trailing-whitespace} is non-@code{nil}; see
408 @ref{Useless Whitespace}.
409 @item nobreak-space
410 The face for displaying the character ``nobreak space.''
411 @item escape-glyph
412 The face for highlighting the @samp{\} or @samp{^} that indicates
413 a control character.  It's also used when @samp{\} indicates a
414 nobreak space or nobreak (soft) hyphen.
415 @end table
417 @cindex @code{region} face
418   When Transient Mark mode is enabled, the text of the region is
419 highlighted when the mark is active.  This uses the face named
420 @code{region}; you can control the style of highlighting by changing the
421 style of this face (@pxref{Face Customization}).  @xref{Transient Mark},
422 for more information about Transient Mark mode and activation and
423 deactivation of the mark.
425   These faces control the appearance of parts of the Emacs frame.
426 They exist as faces to provide a consistent way to customize the
427 appearance of these parts of the frame.
429 @table @code
430 @item mode-line
431 @itemx modeline
432 This face is used for the mode line of the currently selected window,
433 and for menu bars when toolkit menus are not used.  By default, it's
434 drawn with shadows for a ``raised'' effect on graphical displays, and
435 drawn as the inverse of the default face on non-windowed terminals.
436 @code{modeline} is an alias for the @code{mode-line} face, for
437 compatibility with old Emacs versions.
438 @item mode-line-inactive
439 Like @code{mode-line}, but used for mode lines of the windows other
440 than the selected one (if @code{mode-line-in-non-selected-windows} is
441 non-@code{nil}).  This face inherits from @code{mode-line}, so changes
442 in that face affect mode lines in all windows.
443 @item mode-line-highlight
444 Like @code{highlight}, but used for portions of text on mode lines.
445 @item mode-line-buffer-id
446 This face is used for buffer identification parts in the mode line.
447 @item header-line
448 Similar to @code{mode-line} for a window's header line, which appears
449 at the top of a window just as the mode line appears at the bottom.
450 Most windows do not have a header line---only some special modes, such
451 Info mode, create one.
452 @item vertical-border
453 This face is used for the vertical divider between windows.
454 By default this face inherits from the @code{mode-line-inactive} face
455 on character terminals.  On graphical displays the foreground color of
456 this face is used for the vertical line between windows without
457 scrollbars.
458 @item minibuffer-prompt
459 @cindex @code{minibuffer-prompt} face
460 @vindex minibuffer-prompt-properties
461 This face is used for the prompt strings displayed in the minibuffer.
462 By default, Emacs automatically adds this face to the value of
463 @code{minibuffer-prompt-properties}, which is a list of text
464 properties used to display the prompt text.  (This variable takes
465 effect when you enter the minibuffer.)
466 @item fringe
467 @cindex @code{fringe} face
468 The face for the fringes to the left and right of windows on graphic
469 displays.  (The fringes are the narrow portions of the Emacs frame
470 between the text area and the window's right and left borders.)
471 @xref{Fringes}.
472 @item scroll-bar
473 This face determines the visual appearance of the scroll bar.
474 @xref{Scroll Bars}.
475 @item border
476 This face determines the color of the frame border.
477 @item cursor
478 This face determines the color of the cursor.
479 @item mouse
480 This face determines the color of the mouse pointer.
481 @item tool-bar
482 This face determines the color of tool bar icons.  @xref{Tool Bars}.
483 @item tooltip
484 This face is used for tooltips.  @xref{Tooltips}.
485 @item menu
486 @cindex menu bar appearance
487 @cindex @code{menu} face, no effect if customized
488 @cindex customization of @code{menu} face
489 This face determines the colors and font of Emacs's menus.  @xref{Menu
490 Bars}.  Setting the font of LessTif/Motif menus is currently not
491 supported; attempts to set the font are ignored in this case.
492 Likewise, attempts to customize this face in Emacs built with GTK and
493 in the MS-Windows/Mac ports are ignored by the respective GUI toolkits;
494 you need to use system-wide styles and options to change the
495 appearance of the menus.
496 @end table
498 @node Font Lock
499 @section Font Lock mode
500 @cindex Font Lock mode
501 @cindex mode, Font Lock
502 @cindex syntax highlighting and coloring
504   Font Lock mode is a minor mode, always local to a particular buffer,
505 which highlights (or ``fontifies'') the buffer contents according to
506 the syntax of the text you are editing.  It can recognize comments and
507 strings in most languages; in several languages, it can also recognize
508 and properly highlight various other important constructs---for
509 example, names of functions being defined or reserved keywords.
510 Some special modes, such as Occur mode and Info mode, have completely
511 specialized ways of assigning fonts for Font Lock mode.
513 @findex font-lock-mode
514   Font Lock mode is turned on by default in all modes which support it.
515 You can toggle font-lock for each buffer with the command @kbd{M-x
516 font-lock-mode}.  Using a positive argument unconditionally turns Font
517 Lock mode on, and a negative or zero argument turns it off.
519 @findex global-font-lock-mode
520 @vindex global-font-lock-mode
521   If you do not wish Font Lock mode to be turned on by default,
522 customize the variable @code{global-font-lock-mode} using the Customize
523 interface (@pxref{Easy Customization}), or use the function
524 @code{global-font-lock-mode} in your @file{.emacs} file, like this:
526 @example
527 (global-font-lock-mode 0)
528 @end example
530 @noindent
531 This variable, like all the variables that control Font Lock mode,
532 take effect whenever fontification is done; that is, potentially at
533 any time.
535 @findex turn-on-font-lock
536   If you have disabled Global Font Lock mode, you can still enable Font
537 Lock for specific major modes by adding the function
538 @code{turn-on-font-lock} to the mode hooks (@pxref{Hooks}).  For
539 example, to enable Font Lock mode for editing C files, you can do this:
541 @example
542 (add-hook 'c-mode-hook 'turn-on-font-lock)
543 @end example
545   Font Lock mode uses several specifically named faces to do its job,
546 including @code{font-lock-string-face}, @code{font-lock-comment-face},
547 and others.  The easiest way to find them all is to use @kbd{M-x
548 customize-group @key{RET} font-lock-faces @key{RET}}.  You can then
549 use that customization buffer to customize the appearance of these
550 faces.  @xref{Face Customization}.
552   You can also customize these faces using @kbd{M-x
553 set-face-foreground} or @kbd{M-x set-face-background}.  @xref{Faces}.
555 @vindex font-lock-maximum-decoration
556   The variable @code{font-lock-maximum-decoration} specifies the
557 preferred level of fontification, for modes that provide multiple
558 levels.  Level 1 is the least amount of fontification; some modes
559 support levels as high as 3.  The normal default is ``as high as
560 possible.''  You can specify an integer, which applies to all modes, or
561 you can specify different numbers for particular major modes; for
562 example, to use level 1 for C/C++ modes, and the default level
563 otherwise, use this:
565 @example
566 (setq font-lock-maximum-decoration
567       '((c-mode . 1) (c++-mode . 1)))
568 @end example
570 @vindex font-lock-maximum-size
571   Fontification can be too slow for large buffers, so you can suppress
572 it for buffers above a certain size.  The variable
573 @code{font-lock-maximum-size} specifies a buffer size, beyond which
574 buffer fontification is suppressed.
576 @c @w is used below to prevent a bad page-break.
577 @vindex font-lock-beginning-of-syntax-function
578 @cindex incorrect fontification
579 @cindex parenthesis in column zero and fontification
580 @cindex brace in column zero and fontification
581   Comment and string fontification (or ``syntactic'' fontification)
582 relies on analysis of the syntactic structure of the buffer text.  For
583 the sake of speed, some modes, including Lisp mode, rely on a special
584 convention: an open-parenthesis or open-brace in the leftmost column
585 always defines the @w{beginning} of a defun, and is thus always
586 outside any string or comment.  (@xref{Left Margin Paren}.)  If you
587 don't follow this convention, Font Lock mode can misfontify the text
588 that follows an open-parenthesis or open-brace in the leftmost column
589 that is inside a string or comment.
591 @cindex slow display during scrolling
592   The variable @code{font-lock-beginning-of-syntax-function} (always
593 buffer-local) specifies how Font Lock mode can find a position
594 guaranteed to be outside any comment or string.  In modes which use the
595 leftmost column parenthesis convention, the default value of the variable
596 is @code{beginning-of-defun}---that tells Font Lock mode to use the
597 convention.  If you set this variable to @code{nil}, Font Lock no longer
598 relies on the convention.  This avoids incorrect results, but the price
599 is that, in some cases, fontification for a changed text must rescan
600 buffer text from the beginning of the buffer.  This can considerably
601 slow down redisplay while scrolling, particularly if you are close to
602 the end of a large buffer.
604 @findex font-lock-add-keywords
605   Font Lock highlighting patterns already exist for many modes, but you
606 may want to fontify additional patterns.  You can use the function
607 @code{font-lock-add-keywords}, to add your own highlighting patterns for
608 a particular mode.  For example, to highlight @samp{FIXME:} words in C
609 comments, use this:
611 @example
612 (font-lock-add-keywords
613  'c-mode
614  '(("\\<\\(FIXME\\):" 1 font-lock-warning-face t)))
615 @end example
617 @findex font-lock-remove-keywords
618   To remove keywords from the font-lock highlighting patterns, use the
619 function @code{font-lock-remove-keywords}.  @xref{Search-based
620 Fontification,,, elisp, The Emacs Lisp Reference Manual}, for
621 documentation of the format of this list.
623 @cindex just-in-time (JIT) font-lock
624 @cindex background syntax highlighting
625   Fontifying large buffers can take a long time.  To avoid large
626 delays when a file is visited, Emacs fontifies only the visible
627 portion of a buffer.  As you scroll through the buffer, each portion
628 that becomes visible is fontified as soon as it is displayed.  The
629 parts of the buffer that are not displayed are fontified
630 ``stealthily,'' in the background, i.e.@: when Emacs is idle.  You can
631 control this background fontification, also called @dfn{Just-In-Time}
632 (or @dfn{JIT}) Lock, by customizing variables in the customization
633 group @samp{jit-lock}.  @xref{Specific Customization}.
635 @node Highlight Interactively
636 @section Interactive Highlighting
637 @cindex highlighting by matching
638 @cindex interactive highlighting
639 @cindex Highlight Changes mode
641 @findex highlight-changes-mode
642   Use @kbd{M-x highlight-changes-mode} to enable (or disable)
643 Highlight Changes mode, a minor mode that uses faces (colors,
644 typically) to indicate which parts of the buffer were changed most
645 recently.
647 @cindex Hi Lock mode
648 @findex hi-lock-mode
649   Hi Lock mode is another minor mode, which highlights text that
650 matches your specified regular expressions.  For example, you might
651 wish to see all the references to a certain variable in a program
652 source file, highlight certain parts in a voluminous output of some
653 program, or make certain names stand out in an article.  Use the
654 @kbd{M-x hi-lock-mode} command to enable (or disable) Hi Lock mode.
655 To enable Hi Lock mode for all buffers, use @kbd{M-x
656 global-hi-lock-mode} or place @code{(global-hi-lock-mode 1)} in your
657 @file{.emacs} file.
659   Hi Lock mode works like Font Lock mode (@pxref{Font Lock}), except
660 that you specify explicitly the regular expressions to highlight.  You
661 control them with these commands:
663 @table @kbd
664 @item C-x w h @var{regexp} @key{RET} @var{face} @key{RET}
665 @kindex C-x w h
666 @findex highlight-regexp
667 Highlight text that matches @var{regexp} using face @var{face}
668 (@code{highlight-regexp}).  The highlighting will remain as long as
669 the buffer is loaded.  For example, to highlight all occurrences of
670 the word ``whim'' using the default face (a yellow background)
671 @kbd{C-x w h whim @key{RET} @key{RET}}.  Any face can be used for
672 highlighting, Hi Lock provides several of its own and these are
673 pre-loaded into a history list.  While being prompted for a face use
674 @kbd{M-p} and @kbd{M-n} to cycle through them.
676 You can use this command multiple times, specifying various regular
677 expressions to highlight in different ways.
679 @item C-x w r @var{regexp} @key{RET}
680 @kindex C-x w r
681 @findex unhighlight-regexp
682 Unhighlight @var{regexp} (@code{unhighlight-regexp}).
684 If you invoke this from the menu, you select the expression to
685 unhighlight from a list.  If you invoke this from the keyboard, you
686 use the minibuffer.  It will show the most recently added regular
687 expression; use @kbd{M-p} to show the next older expression and
688 @kbd{M-n} to select the next newer expression.  (You can also type the
689 expression by hand, with completion.)  When the expression you want to
690 unhighlight appears in the minibuffer, press @kbd{@key{RET}} to exit
691 the minibuffer and unhighlight it.
693 @item C-x w l @var{regexp} @key{RET} @var{face} @key{RET}
694 @kindex C-x w l
695 @findex highlight-lines-matching-regexp
696 @cindex lines, highlighting
697 @cindex highlighting lines of text
698 Highlight entire lines containing a match for @var{regexp}, using face
699 @var{face} (@code{highlight-lines-matching-regexp}).
701 @item C-x w b
702 @kindex C-x w b
703 @findex hi-lock-write-interactive-patterns
704 Insert all the current highlighting regexp/face pairs into the buffer
705 at point, with comment delimiters to prevent them from changing your
706 program.  (This key binding runs the
707 @code{hi-lock-write-interactive-patterns} command.)
709 These patterns will be read the next time you visit the file while
710 Hi Lock mode is enabled, or whenever you use the @kbd{M-x
711 hi-lock-find-patterns} command.
713 @item C-x w i
714 @kindex C-x w i
715 @findex hi-lock-find-patterns
716 @vindex hi-lock-exclude-modes
717 Re-read regexp/face pairs in the current buffer
718 (@code{hi-lock-write-interactive-patterns}).  Users familiar with Font
719 Lock keywords might interactively enter patterns
720 (@code{highlight-regexp}), write them into the file
721 (@code{hi-lock-write-interactive-patterns}), edit them, perhaps
722 including different faces for different parenthesized parts of the
723 match, and finally use this command
724 (@code{hi-lock-write-interactive-patterns}) to have Hi Lock highlight
725 them.
727 This command does nothing if the current major mode's symbol is a member
728 of the list @code{hi-lock-exclude-modes}.
729 @end table
731 @node Fringes
732 @section Window Fringes
733 @cindex fringes
735   On a graphical display, each Emacs window normally has narrow
736 @dfn{fringes} on the left and right edges.  The fringes display
737 indications about the text in the window.
739   The most common use of the fringes is to indicate a continuation
740 line, when one line of text is split into multiple lines on the
741 screen.  The left fringe shows a curving arrow for each screen line
742 except the first, indicating that ``this is not the real beginning.''
743 The right fringe shows a curving arrow for each screen line except the
744 last, indicating that ``this is not the real end.''
746   The fringes indicate line truncation with short horizontal arrows
747 meaning ``there's more text on this line which is scrolled
748 horizontally out of view;'' clicking the mouse on one of the arrows
749 scrolls the display horizontally in the direction of the arrow.   The
750 fringes can also indicate other things, such as empty lines, or where a
751 program you are debugging is executing (@pxref{Debuggers}).
753 @findex set-fringe-style
754 @findex fringe-mode
755   You can enable and disable the fringes for all frames using
756 @kbd{M-x fringe-mode}.  To enable and disable the fringes
757 for the selected frame, use @kbd{M-x set-fringe-style}.
759 @node Displaying Boundaries
760 @section Displaying Boundaries
762 @vindex indicate-buffer-boundaries
763   On a graphical display, Emacs can indicate the buffer boundaries in
764 the fringes.  It indicates the first line and the last line with
765 angle images in the fringes.  This can be combined with up and down
766 arrow images which say whether it is possible to scroll the window up
767 and down.
769   The buffer-local variable @code{indicate-buffer-boundaries} controls
770 how the buffer boundaries and window scrolling is indicated in the
771 fringes.  If the value is @code{left} or @code{right}, both angle and
772 arrow bitmaps are displayed in the left or right fringe, respectively.
774   If value is an alist, each element @code{(@var{indicator} .
775 @var{position})} specifies the position of one of the indicators.
776 The @var{indicator} must be one of @code{top}, @code{bottom},
777 @code{up}, @code{down}, or @code{t} which specifies the default
778 position for the indicators not present in the alist.
779 The @var{position} is one of @code{left}, @code{right}, or @code{nil}
780 which specifies not to show this indicator.
782   For example, @code{((top . left) (t . right))} places the top angle
783 bitmap in left fringe, the bottom angle bitmap in right fringe, and
784 both arrow bitmaps in right fringe.  To show just the angle bitmaps in
785 the left fringe, but no arrow bitmaps, use @code{((top .  left)
786 (bottom . left))}.
788 @vindex default-indicate-buffer-boundaries
789   The value of the variable @code{default-indicate-buffer-boundaries}
790 is the default value for @code{indicate-buffer-boundaries} in buffers
791 that do not override it.
793 @node Useless Whitespace
794 @section Useless Whitespace
796 @cindex trailing whitespace
797 @cindex whitespace, trailing
798 @vindex show-trailing-whitespace
799   It is easy to leave unnecessary spaces at the end of a line, or
800 empty lines at the end of a file, without realizing it.  In most
801 cases, this @dfn{trailing whitespace} has no effect, but there are
802 special circumstances where it matters.  It can also be a nuisance
803 that the line has ``changed,'' when the change is just spaces added or
804 removed at the end.
806   You can make trailing whitespace at the end of a line visible on the
807 screen by setting the buffer-local variable
808 @code{show-trailing-whitespace} to @code{t}.  Then Emacs displays
809 trailing whitespace in the face @code{trailing-whitespace}.
811   This feature does not apply when point is at the end of the line
812 containing the whitespace.  Strictly speaking, that is ``trailing
813 whitespace'' nonetheless, but displaying it specially in that case
814 looks ugly while you are typing in new text.  In this special case,
815 the location of point is enough to show you that the spaces are
816 present.
818 @findex delete-trailing-whitespace
819   To delete all trailing whitespace within the current buffer's
820 accessible portion (@pxref{Narrowing}), type @kbd{M-x
821 delete-trailing-whitespace @key{RET}}.  (This command does not remove
822 the form-feed characters.)
824 @vindex indicate-empty-lines
825 @vindex default-indicate-empty-lines
826 @cindex unused lines
827 @cindex fringes, and unused line indication
828   Emacs can indicate unused lines at the end of the window with a
829 small image in the left fringe (@pxref{Fringes}).  The image appears
830 for window lines that do not correspond to any buffer text.  Blank
831 lines at the end of the buffer then stand out because they do not have
832 this image in the fringe.
834   To enable this feature, set the buffer-local variable
835 @code{indicate-empty-lines} to a non-@code{nil} value.  The default
836 value of this variable is controlled by the variable
837 @code{default-indicate-empty-lines}; by setting that variable, you
838 can enable or disable this feature for all new buffers.  (This feature
839 currently doesn't work on text-only terminals.)
841 @node Selective Display
842 @section Selective Display
843 @cindex selective display
844 @findex set-selective-display
845 @kindex C-x $
847   Emacs has the ability to hide lines indented more than a certain number
848 of columns (you specify how many columns).  You can use this to get an
849 overview of a part of a program.
851   To hide lines in the current buffer, type @kbd{C-x $}
852 (@code{set-selective-display}) with a numeric argument @var{n}.  Then
853 lines with at least @var{n} columns of indentation disappear from the
854 screen.  The only indication of their presence is that three dots
855 (@samp{@dots{}}) appear at the end of each visible line that is
856 followed by one or more hidden ones.
858   The commands @kbd{C-n} and @kbd{C-p} move across the hidden lines as
859 if they were not there.
861   The hidden lines are still present in the buffer, and most editing
862 commands see them as usual, so you may find point in the middle of the
863 hidden text.  When this happens, the cursor appears at the end of the
864 previous line, after the three dots.  If point is at the end of the
865 visible line, before the newline that ends it, the cursor appears before
866 the three dots.
868   To make all lines visible again, type @kbd{C-x $} with no argument.
870 @vindex selective-display-ellipses
871   If you set the variable @code{selective-display-ellipses} to
872 @code{nil}, the three dots do not appear at the end of a line that
873 precedes hidden lines.  Then there is no visible indication of the
874 hidden lines.  This variable becomes local automatically when set.
876   See also @ref{Outline Mode} for another way to hide part of
877 the text in a buffer.
879 @node Optional Mode Line
880 @section Optional Mode Line Features
882 @cindex buffer size display
883 @cindex display of buffer size
884 @findex size-indication-mode
885   The buffer percentage @var{pos} indicates the percentage of the
886 buffer above the top of the window.  You can additionally display the
887 size of the buffer by typing @kbd{M-x size-indication-mode} to turn on
888 Size Indication mode.  The size will be displayed immediately
889 following the buffer percentage like this:
891 @example
892 @var{POS} of @var{SIZE}
893 @end example
895 @noindent
896 Here @var{SIZE} is the human readable representation of the number of
897 characters in the buffer, which means that @samp{k} for 10^3, @samp{M}
898 for 10^6, @samp{G} for 10^9, etc., are used to abbreviate.
900 @cindex narrowing, and buffer size display
901   If you have narrowed the buffer (@pxref{Narrowing}), the size of the
902 accessible part of the buffer is shown.
904 @cindex line number display
905 @cindex display of line number
906 @findex line-number-mode
907   The current line number of point appears in the mode line when Line
908 Number mode is enabled.  Use the command @kbd{M-x line-number-mode} to
909 turn this mode on and off; normally it is on.  The line number appears
910 after the buffer percentage @var{pos}, with the letter @samp{L} to
911 indicate what it is.  @xref{Minor Modes}, for more information about
912 minor modes and about how to use this command.
914 @cindex narrowing, and line number display
915   If you have narrowed the buffer (@pxref{Narrowing}), the displayed
916 line number is relative to the accessible portion of the buffer.
917 Thus, it isn't suitable as an argument to @code{goto-line}.  (Use
918 @code{what-line} command to see the line number relative to the whole
919 file.)
921 @vindex line-number-display-limit
922   If the buffer is very large (larger than the value of
923 @code{line-number-display-limit}), then the line number doesn't appear.
924 Emacs doesn't compute the line number when the buffer is large, because
925 that would be too slow.  Set it to @code{nil} to remove the limit.
927 @vindex line-number-display-limit-width
928   Line-number computation can also be slow if the lines in the buffer
929 are too long.  For this reason, Emacs normally doesn't display line
930 numbers if the average width, in characters, of lines near point is
931 larger than the value of the variable
932 @code{line-number-display-limit-width}.  The default value is 200
933 characters.
935 @cindex Column Number mode
936 @cindex mode, Column Number
937 @findex column-number-mode
938   You can also display the current column number by turning on Column
939 Number mode.  It displays the current column number preceded by the
940 letter @samp{C}.  Type @kbd{M-x column-number-mode} to toggle this mode.
942 @findex display-time
943 @cindex time (on mode line)
944   Emacs can optionally display the time and system load in all mode
945 lines.  To enable this feature, type @kbd{M-x display-time} or customize
946 the option @code{display-time-mode}.  The information added to the mode
947 line usually appears after the buffer name, before the mode names and
948 their parentheses.  It looks like this:
950 @example
951 @var{hh}:@var{mm}pm @var{l.ll}
952 @end example
954 @noindent
955 @vindex display-time-24hr-format
956 Here @var{hh} and @var{mm} are the hour and minute, followed always by
957 @samp{am} or @samp{pm}.  @var{l.ll} is the average number of running
958 processes in the whole system recently.  (Some fields may be missing if
959 your operating system cannot support them.)  If you prefer time display
960 in 24-hour format, set the variable @code{display-time-24hr-format}
961 to @code{t}.
963 @cindex mail (on mode line)
964 @vindex display-time-use-mail-icon
965 @vindex display-time-mail-face
966 @vindex display-time-mail-file
967 @vindex display-time-mail-directory
968   The word @samp{Mail} appears after the load level if there is mail
969 for you that you have not read yet.  On a graphical display you can use
970 an icon instead of @samp{Mail} by customizing
971 @code{display-time-use-mail-icon}; this may save some space on the mode
972 line.  You can customize @code{display-time-mail-face} to make the mail
973 indicator prominent.  Use @code{display-time-mail-file} to specify
974 the mail file to check, or set @code{display-time-mail-directory}
975 to specify the directory to check for incoming mail (any nonempty regular
976 file in the directory is considered as ``newly arrived mail'').
978 @cindex mode line, 3D appearance
979 @cindex attributes of mode line, changing
980 @cindex non-integral number of lines in a window
981   By default, the mode line is drawn on graphics displays with
982 3D-style highlighting, like that of a button when it is not being
983 pressed.  If you don't like this effect, you can disable the 3D
984 highlighting of the mode line, by customizing the attributes of the
985 @code{mode-line} face.  @xref{Face Customization}.
987 @cindex non-selected windows, mode line appearance
988   By default, the mode line of nonselected windows is displayed in a
989 different face, called @code{mode-line-inactive}.  Only the selected
990 window is displayed in the @code{mode-line} face.  This helps show
991 which window is selected.  When the minibuffer is selected, since
992 it has no mode line, the window from which you activated the minibuffer
993 has its mode line displayed using @code{mode-line}; as a result,
994 ordinary entry to the minibuffer does not change any mode lines.
996 @vindex mode-line-in-non-selected-windows
997   You can disable use of @code{mode-line-inactive} by setting variable
998 @code{mode-line-in-non-selected-windows} to @code{nil}; then all mode
999 lines are displayed in the @code{mode-line} face.
1001 @vindex eol-mnemonic-unix
1002 @vindex eol-mnemonic-dos
1003 @vindex eol-mnemonic-mac
1004 @vindex eol-mnemonic-undecided
1005   You can customize the mode line display for each of the end-of-line
1006 formats by setting each of the variables @code{eol-mnemonic-unix},
1007 @code{eol-mnemonic-dos}, @code{eol-mnemonic-mac}, and
1008 @code{eol-mnemonic-undecided} to the strings you prefer.
1010 @node Text Display
1011 @section How Text Is Displayed
1012 @cindex characters (in text)
1014   @acronym{ASCII} printing characters (octal codes 040 through 0176) in Emacs
1015 buffers are displayed with their graphics, as are non-ASCII multibyte
1016 printing characters (octal codes above 0400).
1018   Some @acronym{ASCII} control characters are displayed in special ways.  The
1019 newline character (octal code 012) is displayed by starting a new line.
1020 The tab character (octal code 011) is displayed by moving to the next
1021 tab stop column (normally every 8 columns).
1023   Other @acronym{ASCII} control characters are normally displayed as a caret
1024 (@samp{^}) followed by the non-control version of the character; thus,
1025 control-A is displayed as @samp{^A}.  The caret appears in face
1026 @code{escape-glyph}.
1028   Non-@acronym{ASCII} characters 0200 through 0237 (octal) are
1029 displayed with octal escape sequences; thus, character code 0230
1030 (octal) is displayed as @samp{\230}.  The backslash appears in face
1031 @code{escape-glyph}.
1033 @vindex ctl-arrow
1034   If the variable @code{ctl-arrow} is @code{nil}, control characters in
1035 the buffer are displayed with octal escape sequences, except for newline
1036 and tab.  Altering the value of @code{ctl-arrow} makes it local to the
1037 current buffer; until that time, the default value is in effect.  The
1038 default is initially @code{t}.
1040   The display of character codes 0240 through 0377 (octal) may be
1041 either as escape sequences or as graphics.  They do not normally occur
1042 in multibyte buffers, but if they do, they are displayed as Latin-1
1043 graphics.  In unibyte mode, if you enable European display they are
1044 displayed using their graphics (assuming your terminal supports them),
1045 otherwise as escape sequences.  @xref{Unibyte Mode}.
1047 @vindex nobreak-char-display
1048 @cindex no-break space, display
1049 @cindex no-break hyphen, display
1050 @cindex soft hyphen, display
1051   Some character sets define ``no-break'' versions of the space and
1052 hyphen characters, which are used where a line should not be broken.
1053 Emacs normally displays these characters with special faces
1054 (respectively, @code{nobreak-space} and @code{escape-glyph}) to
1055 distinguish them from ordinary spaces and hyphens.  You can turn off
1056 this feature by setting the variable @code{nobreak-char-display} to
1057 @code{nil}.  If you set the variable to any other value, that means to
1058 prefix these characters with an escape character.
1060 @vindex tab-width
1061 @vindex default-tab-width
1062   Normally, a tab character in the buffer is displayed as whitespace which
1063 extends to the next display tab stop position, and display tab stops come
1064 at intervals equal to eight spaces.  The number of spaces per tab is
1065 controlled by the variable @code{tab-width}, which is made local by
1066 changing it.  Note that how the tab character
1067 in the buffer is displayed has nothing to do with the definition of
1068 @key{TAB} as a command.  The variable @code{tab-width} must have an
1069 integer value between 1 and 1000, inclusive.  The variable
1070 @code{default-tab-width} controls the default value of this variable
1071 for buffers where you have not set it locally.
1073   You can customize the way any particular character code is displayed
1074 by means of a display table.  @xref{Display Tables,, Display Tables,
1075 elisp, The Emacs Lisp Reference Manual}.
1077 @node Cursor Display
1078 @section Displaying the Cursor
1080 @findex blink-cursor-mode
1081 @vindex blink-cursor-alist
1082 @cindex cursor, locating visually
1083 @cindex cursor, blinking
1084   You can customize the cursor's color, and whether it blinks, using
1085 the @code{cursor} Custom group (@pxref{Easy Customization}).  On
1086 a graphical display, the command @kbd{M-x blink-cursor-mode} enables
1087 or disables the blinking of the cursor.  (On text terminals, the
1088 terminal itself blinks the cursor, and Emacs has no control over it.)
1089 You can control how the cursor appears when it blinks off by setting
1090 the variable @code{blink-cursor-alist}.
1092 @vindex visible-cursor
1093   Some text terminals offer two different cursors: the normal cursor
1094 and the very visible cursor, where the latter may be e.g. bigger or
1095 blinking.  By default Emacs uses the very visible cursor, and switches
1096 to it when you start or resume Emacs.  If the variable
1097 @code{visible-cursor} is @code{nil} when Emacs starts or resumes, it
1098 doesn't switch, so it uses the normal cursor.
1100 @cindex cursor in non-selected windows
1101 @vindex cursor-in-non-selected-windows
1102   Normally, the cursor appears in non-selected windows in the ``off''
1103 state, with the same appearance as when the blinking cursor blinks
1104 ``off.''  For a box cursor, this is a hollow box; for a bar cursor,
1105 this is a thinner bar.  To turn off cursors in non-selected windows,
1106 customize the variable @code{cursor-in-non-selected-windows} and assign
1107 it a @code{nil} value.
1109 @vindex x-stretch-cursor
1110 @cindex wide block cursor
1111   On graphical displays, Emacs can optionally draw the block cursor
1112 as wide as the character under the cursor---for example, if the cursor
1113 is on a tab character, it would cover the full width occupied by that
1114 tab character.  To enable this feature, set the variable
1115 @code{x-stretch-cursor} to a non-@code{nil} value.
1117 @findex hl-line-mode
1118 @findex global-hl-line-mode
1119 @cindex highlight current line
1120   To make the cursor even more visible, you can use HL Line mode, a
1121 minor mode that highlights the line containing point.  Use @kbd{M-x
1122 hl-line-mode} to enable or disable it in the current buffer.  @kbd{M-x
1123 global-hl-line-mode} enables or disables the same mode globally.
1125 @node Line Truncation
1126 @section Truncation of Lines
1128 @cindex truncation
1129 @cindex line truncation, and fringes
1130   As an alternative to continuation, Emacs can display long lines by
1131 @dfn{truncation}.  This means that all the characters that do not fit
1132 in the width of the screen or window do not appear at all.  On
1133 graphical displays, a small straight arrow in the fringe indicates
1134 truncation at either end of the line.  On text-only terminals, @samp{$}
1135 appears in the first column when there is text truncated to the left,
1136 and in the last column when there is text truncated to the right.
1138 @vindex truncate-lines
1139 @findex toggle-truncate-lines
1140   Horizontal scrolling automatically causes line truncation
1141 (@pxref{Horizontal Scrolling}).  You can explicitly enable line
1142 truncation for a particular buffer with the command @kbd{M-x
1143 toggle-truncate-lines}.  This works by locally changing the variable
1144 @code{truncate-lines}.  If that variable is non-@code{nil}, long lines
1145 are truncated; if it is @code{nil}, they are continued onto multiple
1146 screen lines.  Setting the variable @code{truncate-lines} in any way
1147 makes it local to the current buffer; until that time, the default
1148 value is in effect.  The default value is normally @code{nil}.
1150 @c @vindex truncate-partial-width-windows  @c Idx entry is in Split Windows.
1151   If the variable @code{truncate-partial-width-windows} is
1152 non-@code{nil}, it forces truncation rather than continuation in any
1153 window less than the full width of the screen or frame, regardless of
1154 the value of @code{truncate-lines}.  For information about side-by-side
1155 windows, see @ref{Split Window}.  See also @ref{Display,, Display,
1156 elisp, The Emacs Lisp Reference Manual}.
1158 @vindex overflow-newline-into-fringe
1159   If the variable @code{overflow-newline-into-fringe} is
1160 non-@code{nil} on a graphical display, then Emacs does not continue or
1161 truncate a line which is exactly as wide as the window.  Instead, the
1162 newline overflows into the right fringe, and the cursor appears in the
1163 fringe when positioned on that newline.
1165 @node Display Custom
1166 @section Customization of Display
1168   This section describes variables (@pxref{Variables}) that you can
1169 change to customize how Emacs displays.  Beginning users can skip
1171 @c the reason for that pxref is because an xref early in the
1172 @c ``echo area'' section leads here.
1174 @vindex inverse-video
1175   If the variable @code{inverse-video} is non-@code{nil}, Emacs attempts
1176 to invert all the lines of the display from what they normally are.
1178 @vindex visible-bell
1179   If the variable @code{visible-bell} is non-@code{nil}, Emacs attempts
1180 to make the whole screen blink when it would normally make an audible bell
1181 sound.  This variable has no effect if your terminal does not have a way
1182 to make the screen blink.
1184 @vindex echo-keystrokes
1185   The variable @code{echo-keystrokes} controls the echoing of multi-character
1186 keys; its value is the number of seconds of pause required to cause echoing
1187 to start, or zero, meaning don't echo at all.  The value takes effect when
1188 there is someting to echo.  @xref{Echo Area}.
1190 @vindex baud-rate
1191   The variable @anchor{baud-rate}@code{baud-rate} holds the output
1192 speed of the terminal, as far as Emacs knows.  Setting this variable
1193 does not change the speed of actual data transmission, but the value
1194 is used for calculations.  On text-only terminals, it affects padding,
1195 and decisions about whether to scroll part of the screen or redraw it
1196 instead.  It also affects the behavior of incremental search.
1198   On graphical displays, @code{baud-rate} is only used to determine
1199 how frequently to look for pending input during display updating.  A
1200 higher value of @code{baud-rate} means that check for pending input
1201 will be done less frequently.
1203 @cindex hourglass pointer display
1204 @vindex hourglass-delay
1205   On graphical display, Emacs can optionally display the mouse pointer
1206 in a special shape to say that Emacs is busy.  To turn this feature on
1207 or off, customize the group @code{cursor}.  You can also control the
1208 amount of time Emacs must remain busy before the busy indicator is
1209 displayed, by setting the variable @code{hourglass-delay}.
1211 @vindex overline-margin
1212   On graphical display, this variables specifies the vertical position
1213 of an overline above the text, including the height of the overline
1214 itself (1 pixel).  The default value is 2 pixels.
1216 @vindex x-underline-at-descent-line
1217   On graphical display, Emacs normally draws an underline at the
1218 baseline level of the font.  If @code{x-underline-at-descent-line} is
1219 non-@code{nil}, Emacs draws the underline at the same height as the
1220 font's descent line.
1222 @findex tty-suppress-bold-inverse-default-colors
1223   On some text-only terminals, bold face and inverse video together
1224 result in text that is hard to read.  Call the function
1225 @code{tty-suppress-bold-inverse-default-colors} with a non-@code{nil}
1226 argument to suppress the effect of bold-face in this case.
1228 @vindex no-redraw-on-reenter
1229   On a text-only terminal, when you reenter Emacs after suspending, Emacs
1230 normally clears the screen and redraws the entire display.  On some
1231 terminals with more than one page of memory, it is possible to arrange
1232 the termcap entry so that the @samp{ti} and @samp{te} strings (output
1233 to the terminal when Emacs is entered and exited, respectively) switch
1234 between pages of memory so as to use one page for Emacs and another
1235 page for other output.  On such terminals, you might want to set the variable
1236 @code{no-redraw-on-reenter} non-@code{nil}; this tells Emacs to
1237 assume, when resumed, that the screen page it is using still contains
1238 what Emacs last wrote there.
1240 @ignore
1241    arch-tag: 2219f910-2ff0-4521-b059-1bd231a536c4
1242 @end ignore