declare smobs in alloc.c
[bpt/emacs.git] / doc / emacs / display.texi
1 @c This is part of the Emacs manual.
2 @c Copyright (C) 1985-1987, 1993-1995, 1997, 2000-2014 Free Software
3 @c Foundation, Inc.
4
5 @c See file emacs.texi for copying conditions.
6 @node Display
7 @chapter Controlling the Display
8
9 Since only part of a large buffer fits in the window, Emacs has to
10 show only a part of it. This chapter describes commands and variables
11 that let you specify which part of the text you want to see, and how
12 the text is displayed.
13
14 @menu
15 * Scrolling:: Commands to move text up and down in a window.
16 * Recentering:: A scroll command that centers the current line.
17 * Auto Scrolling:: Redisplay scrolls text automatically when needed.
18 * Horizontal Scrolling:: Moving text left and right in a window.
19 * Narrowing:: Restricting display and editing to a portion
20 of the buffer.
21 * View Mode:: Viewing read-only buffers.
22 * Follow Mode:: Follow mode lets two windows scroll as one.
23 * Faces:: How to change the display style using faces.
24 * Colors:: Specifying colors for faces.
25 * Standard Faces:: The main predefined faces.
26 * Text Scale:: Increasing or decreasing text size in a buffer.
27 * Font Lock:: Minor mode for syntactic highlighting using faces.
28 * Highlight Interactively:: Tell Emacs what text to highlight.
29 * Fringes:: Enabling or disabling window fringes.
30 * Displaying Boundaries:: Displaying top and bottom of the buffer.
31 * Useless Whitespace:: Showing possibly spurious trailing whitespace.
32 * Selective Display:: Hiding lines with lots of indentation.
33 * Optional Mode Line:: Optional mode line display features.
34 * Text Display:: How text characters are normally displayed.
35 * Cursor Display:: Features for displaying the cursor.
36 * Line Truncation:: Truncating lines to fit the screen width instead
37 of continuing them to multiple screen lines.
38 * Visual Line Mode:: Word wrap and screen line-based editing.
39 * Display Custom:: Information on variables for customizing display.
40 @end menu
41
42 @node Scrolling
43 @section Scrolling
44 @cindex scrolling
45
46 If a window is too small to display all the text in its buffer, it
47 displays only a portion of it. @dfn{Scrolling} commands change which
48 portion of the buffer is displayed.
49
50 Scrolling ``forward'' or ``up'' advances the portion of the buffer
51 displayed in the window; equivalently, it moves the buffer text
52 upwards relative to the window. Scrolling ``backward'' or ``down''
53 displays an earlier portion of the buffer, and moves the text
54 downwards relative to the window.
55
56 In Emacs, scrolling ``up'' or ``down'' refers to the direction that
57 the text moves in the window, @emph{not} the direction that the window
58 moves relative to the text. This terminology was adopted by Emacs
59 before the modern meaning of ``scrolling up'' and ``scrolling down''
60 became widespread. Hence, the strange result that @key{PageDown}
61 scrolls ``up'' in the Emacs sense.
62
63 The portion of a buffer displayed in a window always contains point.
64 If you move point past the bottom or top of the window, scrolling
65 occurs automatically to bring it back onscreen (@pxref{Auto
66 Scrolling}). You can also scroll explicitly with these commands:
67
68 @table @kbd
69 @item C-v
70 @itemx @key{next}
71 @itemx @key{PageDown}
72 Scroll forward by nearly a full window (@code{scroll-up-command}).
73 @item M-v
74 @itemx @key{prior}
75 @itemx @key{PageUp}
76 Scroll backward (@code{scroll-down-command}).
77 @end table
78
79 @kindex C-v
80 @kindex M-v
81 @kindex next
82 @kindex prior
83 @kindex PageDown
84 @kindex PageUp
85 @findex scroll-up-command
86 @findex scroll-down-command
87 @kbd{C-v} (@code{scroll-up-command}) scrolls forward by nearly the
88 whole window height. The effect is to take the two lines at the
89 bottom of the window and put them at the top, followed by lines that
90 were not previously visible. If point was in the text that scrolled
91 off the top, it ends up on the window's new topmost line. The
92 @key{next} (or @key{PageDown}) key is equivalent to @kbd{C-v}.
93
94 @kbd{M-v} (@code{scroll-down-command}) scrolls backward in a similar
95 way. The @key{prior} (or @key{PageUp}) key is equivalent to
96 @kbd{M-v}.
97
98 @vindex next-screen-context-lines
99 The number of lines of overlap left by these scroll commands is
100 controlled by the variable @code{next-screen-context-lines}, whose
101 default value is 2. You can supply the commands with a numeric prefix
102 argument, @var{n}, to scroll by @var{n} lines; Emacs attempts to leave
103 point unchanged, so that the text and point move up or down together.
104 @kbd{C-v} with a negative argument is like @kbd{M-v} and vice versa.
105
106 @vindex scroll-error-top-bottom
107 By default, these commands signal an error (by beeping or flashing
108 the screen) if no more scrolling is possible, because the window has
109 reached the beginning or end of the buffer. If you change the
110 variable @code{scroll-error-top-bottom} to @code{t}, the command moves
111 point to the farthest possible position. If point is already there,
112 the command signals an error.
113
114 @vindex scroll-preserve-screen-position
115 @cindex @code{scroll-command} property
116 Some users like scroll commands to keep point at the same screen
117 position, so that scrolling back to the same screen conveniently
118 returns point to its original position. You can enable this behavior
119 via the variable @code{scroll-preserve-screen-position}. If the value
120 is @code{t}, Emacs adjusts point to keep the cursor at the same screen
121 position whenever a scroll command moves it off-window, rather than
122 moving it to the topmost or bottommost line. With any other
123 non-@code{nil} value, Emacs adjusts point this way even if the scroll
124 command leaves point in the window. This variable affects all the
125 scroll commands documented in this section, as well as scrolling with
126 the mouse wheel (@pxref{Mouse Commands}); in general, it affects any
127 command that has a non-@code{nil} @code{scroll-command} property.
128 @xref{Property Lists,,, elisp, The Emacs Lisp Reference Manual}.
129
130 @vindex scroll-up
131 @vindex scroll-down
132 @findex scroll-up-line
133 @findex scroll-down-line
134 The commands @kbd{M-x scroll-up} and @kbd{M-x scroll-down} behave
135 similarly to @code{scroll-up-command} and @code{scroll-down-command},
136 except they do not obey @code{scroll-error-top-bottom}. Prior to
137 Emacs 24, these were the default commands for scrolling up and down.
138 The commands @kbd{M-x scroll-up-line} and @kbd{M-x scroll-down-line}
139 scroll the current window by one line at a time. If you intend to use
140 any of these commands, you might want to give them key bindings
141 (@pxref{Init Rebinding}).
142
143 @node Recentering
144 @section Recentering
145
146 @table @kbd
147 @item C-l
148 Scroll the selected window so the current line is the center-most text
149 line; on subsequent consecutive invocations, make the current line the
150 top line, the bottom line, and so on in cyclic order. Possibly
151 redisplay the screen too (@code{recenter-top-bottom}).
152
153 @item M-x recenter
154 Scroll the selected window so the current line is the center-most text
155 line. Possibly redisplay the screen too.
156
157 @item C-M-l
158 Scroll heuristically to bring useful information onto the screen
159 (@code{reposition-window}).
160 @end table
161
162 @kindex C-l
163 @findex recenter-top-bottom
164 The @kbd{C-l} (@code{recenter-top-bottom}) command @dfn{recenters}
165 the selected window, scrolling it so that the current screen line is
166 exactly in the center of the window, or as close to the center as
167 possible.
168
169 Typing @kbd{C-l} twice in a row (@kbd{C-l C-l}) scrolls the window
170 so that point is on the topmost screen line. Typing a third @kbd{C-l}
171 scrolls the window so that point is on the bottom-most screen line.
172 Each successive @kbd{C-l} cycles through these three positions.
173
174 @vindex recenter-positions
175 You can change the cycling order by customizing the list variable
176 @code{recenter-positions}. Each list element should be the symbol
177 @code{top}, @code{middle}, or @code{bottom}, or a number; an integer
178 means to move the line to the specified screen line, while a
179 floating-point number between 0.0 and 1.0 specifies a percentage of
180 the screen space from the top of the window. The default,
181 @code{(middle top bottom)}, is the cycling order described above.
182 Furthermore, if you change the variable @code{scroll-margin} to a
183 non-zero value @var{n}, @kbd{C-l} always leaves at least @var{n}
184 screen lines between point and the top or bottom of the window
185 (@pxref{Auto Scrolling}).
186
187 You can also give @kbd{C-l} a prefix argument. A plain prefix
188 argument, @kbd{C-u C-l}, simply recenters point. A positive argument
189 @var{n} puts point @var{n} lines down from the top of the window. An
190 argument of zero puts point on the topmost line. A negative argument
191 @var{-n} puts point @var{n} lines from the bottom of the window. When
192 given an argument, @kbd{C-l} does not clear the screen or cycle
193 through different screen positions.
194
195 @vindex recenter-redisplay
196 If the variable @code{recenter-redisplay} has a non-@code{nil}
197 value, each invocation of @kbd{C-l} also clears and redisplays the
198 screen; the special value @code{tty} (the default) says to do this on
199 text-terminal frames only. Redisplaying is useful in case the screen
200 becomes garbled for any reason (@pxref{Screen Garbled}).
201
202 @findex recenter
203 The more primitive command @kbd{M-x recenter} behaves like
204 @code{recenter-top-bottom}, but does not cycle among screen positions.
205
206 @kindex C-M-l
207 @findex reposition-window
208 @kbd{C-M-l} (@code{reposition-window}) scrolls the current window
209 heuristically in a way designed to get useful information onto the
210 screen. For example, in a Lisp file, this command tries to get the
211 entire current defun onto the screen if possible.
212
213 @node Auto Scrolling
214 @section Automatic Scrolling
215
216 @cindex automatic scrolling
217 Emacs performs @dfn{automatic scrolling} when point moves out of the
218 visible portion of the text. Normally, automatic scrolling centers
219 point vertically in the window, but there are several ways to alter
220 this behavior.
221
222 @vindex scroll-conservatively
223 If you set @code{scroll-conservatively} to a small number @var{n},
224 then moving point just a little off the screen (no more than @var{n}
225 lines) causes Emacs to scroll just enough to bring point back on
226 screen; if doing so fails to make point visible, Emacs scrolls just
227 far enough to center point in the window. If you set
228 @code{scroll-conservatively} to a large number (larger than 100),
229 automatic scrolling never centers point, no matter how far point
230 moves; Emacs always scrolls text just enough to bring point into view,
231 either at the top or bottom of the window depending on the scroll
232 direction. By default, @code{scroll-conservatively} is@tie{}0, which
233 means to always center point in the window.
234
235 @vindex scroll-step
236 Another way to control automatic scrolling is to customize the
237 variable @code{scroll-step}. Its value determines the number of lines
238 by which to automatically scroll, when point moves off the screen. If
239 scrolling by that number of lines fails to bring point back into view,
240 point is centered instead. The default value is zero, which (by
241 default) causes point to always be centered after scrolling.
242
243 @cindex aggressive scrolling
244 @vindex scroll-up-aggressively
245 @vindex scroll-down-aggressively
246 A third way to control automatic scrolling is to customize the
247 variables @code{scroll-up-aggressively} and
248 @code{scroll-down-aggressively}, which directly specify the vertical
249 position of point after scrolling. The value of
250 @code{scroll-up-aggressively} should be either @code{nil} (the
251 default), or a floating point number @var{f} between 0 and 1. The
252 latter means that when point goes below the bottom window edge (i.e.,
253 scrolling forward), Emacs scrolls the window so that point is @var{f}
254 parts of the window height from the bottom window edge. Thus, larger
255 @var{f} means more aggressive scrolling: more new text is brought into
256 view. The default value, @code{nil}, is equivalent to 0.5.
257
258 Likewise, @code{scroll-down-aggressively} is used when point goes
259 above the bottom window edge (i.e., scrolling backward). The value
260 specifies how far point should be from the top margin of the window
261 after scrolling. Thus, as with @code{scroll-up-aggressively}, a
262 larger value is more aggressive.
263
264 Note that the variables @code{scroll-conservatively},
265 @code{scroll-step}, and @code{scroll-up-aggressively} /
266 @code{scroll-down-aggressively} control automatic scrolling in
267 contradictory ways. Therefore, you should pick no more than one of
268 these methods to customize automatic scrolling. In case you customize
269 multiple variables, the order of priority is:
270 @code{scroll-conservatively}, then @code{scroll-step}, and finally
271 @code{scroll-up-aggressively} / @code{scroll-down-aggressively}.
272
273 @vindex scroll-margin
274 The variable @code{scroll-margin} restricts how close point can come
275 to the top or bottom of a window (even if aggressive scrolling
276 specifies a fraction @var{f} that is larger than the window portion
277 between the top and the bottom margins). Its value is a number of screen
278 lines; if point comes within that many lines of the top or bottom of
279 the window, Emacs performs automatic scrolling. By default,
280 @code{scroll-margin} is 0.
281
282 @node Horizontal Scrolling
283 @section Horizontal Scrolling
284 @cindex horizontal scrolling
285
286 @vindex auto-hscroll-mode
287 @dfn{Horizontal scrolling} means shifting all the lines sideways
288 within a window, so that some of the text near the left margin is not
289 displayed. When the text in a window is scrolled horizontally, text
290 lines are truncated rather than continued (@pxref{Line Truncation}).
291 If a window shows truncated lines, Emacs performs automatic horizontal
292 scrolling whenever point moves off the left or right edge of the
293 screen. To disable automatic horizontal scrolling, set the variable
294 @code{auto-hscroll-mode} to @code{nil}. Note that when the automatic
295 horizontal scrolling is turned off, if point moves off the edge of the
296 screen, the cursor disappears to indicate that. (On text terminals,
297 the cursor is left at the edge instead.)
298
299 @vindex hscroll-margin
300 The variable @code{hscroll-margin} controls how close point can get
301 to the window's left and right edges before automatic scrolling
302 occurs. It is measured in columns. For example, if the value is 5,
303 then moving point within 5 columns of an edge causes horizontal
304 scrolling away from that edge.
305
306 @vindex hscroll-step
307 The variable @code{hscroll-step} determines how many columns to
308 scroll the window when point gets too close to the edge. Zero, the
309 default value, means to center point horizontally within the window.
310 A positive integer value specifies the number of columns to scroll by.
311 A floating-point number specifies the fraction of the window's width
312 to scroll by.
313
314 You can also perform explicit horizontal scrolling with the
315 following commands:
316
317 @table @kbd
318 @item C-x <
319 Scroll text in current window to the left (@code{scroll-left}).
320 @item C-x >
321 Scroll to the right (@code{scroll-right}).
322 @end table
323
324 @kindex C-x <
325 @kindex C-x >
326 @findex scroll-left
327 @findex scroll-right
328 @kbd{C-x <} (@code{scroll-left}) scrolls text in the selected window
329 to the left by the full width of the window, less two columns. (In
330 other words, the text in the window moves left relative to the
331 window.) With a numeric argument @var{n}, it scrolls by @var{n}
332 columns.
333
334 If the text is scrolled to the left, and point moves off the left
335 edge of the window, the cursor will freeze at the left edge of the
336 window, until point moves back to the displayed portion of the text.
337 This is independent of the current setting of
338 @code{auto-hscroll-mode}, which, for text scrolled to the left, only
339 affects the behavior at the right edge of the window.
340
341 @kbd{C-x >} (@code{scroll-right}) scrolls similarly to the right.
342 The window cannot be scrolled any farther to the right once it is
343 displayed normally, with each line starting at the window's left
344 margin; attempting to do so has no effect. This means that you don't
345 have to calculate the argument precisely for @w{@kbd{C-x >}}; any
346 sufficiently large argument will restore the normal display.
347
348 If you use those commands to scroll a window horizontally, that sets
349 a lower bound for automatic horizontal scrolling. Automatic scrolling
350 will continue to scroll the window, but never farther to the right
351 than the amount you previously set by @code{scroll-left}.
352
353 @node Narrowing
354 @section Narrowing
355 @cindex widening
356 @cindex restriction
357 @cindex narrowing
358 @cindex accessible portion
359
360 @dfn{Narrowing} means focusing in on some portion of the buffer,
361 making the rest temporarily inaccessible. The portion which you can
362 still get to is called the @dfn{accessible portion}. Canceling the
363 narrowing, which makes the entire buffer once again accessible, is
364 called @dfn{widening}. The bounds of narrowing in effect in a buffer
365 are called the buffer's @dfn{restriction}.
366
367 Narrowing can make it easier to concentrate on a single subroutine or
368 paragraph by eliminating clutter. It can also be used to limit the
369 range of operation of a replace command or repeating keyboard macro.
370
371 @table @kbd
372 @item C-x n n
373 Narrow down to between point and mark (@code{narrow-to-region}).
374 @item C-x n w
375 Widen to make the entire buffer accessible again (@code{widen}).
376 @item C-x n p
377 Narrow down to the current page (@code{narrow-to-page}).
378 @item C-x n d
379 Narrow down to the current defun (@code{narrow-to-defun}).
380 @end table
381
382 When you have narrowed down to a part of the buffer, that part appears
383 to be all there is. You can't see the rest, you can't move into it
384 (motion commands won't go outside the accessible part), you can't change
385 it in any way. However, it is not gone, and if you save the file all
386 the inaccessible text will be saved. The word @samp{Narrow} appears in
387 the mode line whenever narrowing is in effect.
388
389 @kindex C-x n n
390 @findex narrow-to-region
391 The primary narrowing command is @kbd{C-x n n} (@code{narrow-to-region}).
392 It sets the current buffer's restrictions so that the text in the current
393 region remains accessible, but all text before the region or after the
394 region is inaccessible. Point and mark do not change.
395
396 @kindex C-x n p
397 @findex narrow-to-page
398 @kindex C-x n d
399 @findex narrow-to-defun
400 Alternatively, use @kbd{C-x n p} (@code{narrow-to-page}) to narrow
401 down to the current page. @xref{Pages}, for the definition of a page.
402 @kbd{C-x n d} (@code{narrow-to-defun}) narrows down to the defun
403 containing point (@pxref{Defuns}).
404
405 @kindex C-x n w
406 @findex widen
407 The way to cancel narrowing is to widen with @kbd{C-x n w}
408 (@code{widen}). This makes all text in the buffer accessible again.
409
410 You can get information on what part of the buffer you are narrowed down
411 to using the @kbd{C-x =} command. @xref{Position Info}.
412
413 Because narrowing can easily confuse users who do not understand it,
414 @code{narrow-to-region} is normally a disabled command. Attempting to use
415 this command asks for confirmation and gives you the option of enabling it;
416 if you enable the command, confirmation will no longer be required for
417 it. @xref{Disabling}.
418
419 @node View Mode
420 @section View Mode
421 @cindex View mode
422 @cindex mode, View
423
424 @kindex s @r{(View mode)}
425 @kindex SPC @r{(View mode)}
426 @kindex DEL @r{(View mode)}
427 View mode is a minor mode that lets you scan a buffer by sequential
428 screenfuls. It provides commands for scrolling through the buffer
429 conveniently but not for changing it. Apart from the usual Emacs
430 cursor motion commands, you can type @key{SPC} to scroll forward one
431 windowful, @key{S-@key{SPC}} or @key{DEL} to scroll backward, and @kbd{s} to
432 start an incremental search.
433
434 @kindex q @r{(View mode)}
435 @kindex e @r{(View mode)}
436 @findex View-quit
437 @findex View-exit
438 Typing @kbd{q} (@code{View-quit}) disables View mode, and switches
439 back to the buffer and position before View mode was enabled. Typing
440 @kbd{e} (@code{View-exit}) disables View mode, keeping the current
441 buffer and position.
442
443 @findex view-buffer
444 @findex view-file
445 @kbd{M-x view-buffer} prompts for an existing Emacs buffer, switches
446 to it, and enables View mode. @kbd{M-x view-file} prompts for a file
447 and visits it with View mode enabled.
448
449 @node Follow Mode
450 @section Follow Mode
451 @cindex Follow mode
452 @cindex mode, Follow
453 @findex follow-mode
454 @cindex windows, synchronizing
455 @cindex synchronizing windows
456
457 @dfn{Follow mode} is a minor mode that makes two windows, both
458 showing the same buffer, scroll as a single tall ``virtual window''.
459 To use Follow mode, go to a frame with just one window, split it into
460 two side-by-side windows using @kbd{C-x 3}, and then type @kbd{M-x
461 follow-mode}. From then on, you can edit the buffer in either of the
462 two windows, or scroll either one; the other window follows it.
463
464 In Follow mode, if you move point outside the portion visible in one
465 window and into the portion visible in the other window, that selects
466 the other window---again, treating the two as if they were parts of
467 one large window.
468
469 To turn off Follow mode, type @kbd{M-x follow-mode} a second time.
470
471 @node Faces
472 @section Text Faces
473 @cindex faces
474
475 Emacs can display text in several different styles, called
476 @dfn{faces}. Each face can specify various @dfn{face attributes},
477 such as the font, height, weight, slant, foreground and background
478 color, and underlining or overlining. Most major modes assign faces
479 to the text automatically, via Font Lock mode. @xref{Font Lock}, for
480 more information about how these faces are assigned.
481
482 @findex list-faces-display
483 To see what faces are currently defined, and what they look like,
484 type @kbd{M-x list-faces-display}. With a prefix argument, this
485 prompts for a regular expression, and displays only faces with names
486 matching that regular expression (@pxref{Regexps}).
487
488 @vindex frame-background-mode
489 It's possible for a given face to look different in different
490 frames. For instance, some text terminals do not support all face
491 attributes, particularly font, height, and width, and some support a
492 limited range of colors. In addition, most Emacs faces are defined so
493 that their attributes are different on light and dark frame
494 backgrounds, for reasons of legibility. By default, Emacs
495 automatically chooses which set of face attributes to display on each
496 frame, based on the frame's current background color. However, you
497 can override this by giving the variable @code{frame-background-mode}
498 a non-@code{nil} value. A value of @code{dark} makes Emacs treat all
499 frames as if they have a dark background, whereas a value of
500 @code{light} makes it treat all frames as if they have a light
501 background.
502
503 @cindex background color
504 @cindex default face
505 You can customize a face to alter its attributes, and save those
506 customizations for future Emacs sessions. @xref{Face Customization},
507 for details.
508
509 The @code{default} face is the default for displaying text, and all
510 of its attributes are specified. Its background color is also used as
511 the frame's background color. @xref{Colors}.
512
513 @cindex cursor face
514 Another special face is the @code{cursor} face. On graphical
515 displays, the background color of this face is used to draw the text
516 cursor. None of the other attributes of this face have any effect;
517 the foreground color for text under the cursor is taken from the
518 background color of the underlying text. On text terminals, the
519 appearance of the text cursor is determined by the terminal, not by
520 the @code{cursor} face.
521
522 You can also use X resources to specify attributes of any particular
523 face. @xref{Resources}.
524
525 Emacs can display variable-width fonts, but some Emacs commands,
526 particularly indentation commands, do not account for variable
527 character display widths. Therefore, we recommend not using
528 variable-width fonts for most faces, particularly those assigned by
529 Font Lock mode.
530
531 @node Colors
532 @section Colors for Faces
533 @cindex color name
534 @cindex RGB triplet
535
536 Faces can have various foreground and background colors. When you
537 specify a color for a face---for instance, when customizing the face
538 (@pxref{Face Customization})---you can use either a @dfn{color name}
539 or an @dfn{RGB triplet}.
540
541 @findex list-colors-display
542 @vindex list-colors-sort
543 A color name is a pre-defined name, such as @samp{dark orange} or
544 @samp{medium sea green}. To view a list of color names, type @kbd{M-x
545 list-colors-display}. To control the order in which colors are shown,
546 customize @code{list-colors-sort}. If you run this command on a
547 graphical display, it shows the full range of color names known to
548 Emacs (these are the standard X11 color names, defined in X's
549 @file{rgb.txt} file). If you run the command on a text terminal, it
550 shows only a small subset of colors that can be safely displayed on
551 such terminals. However, Emacs understands X11 color names even on
552 text terminals; if a face is given a color specified by an X11 color
553 name, it is displayed using the closest-matching terminal color.
554
555 An RGB triplet is a string of the form @samp{#RRGGBB}. Each of the
556 R, G, and B components is a hexadecimal number specifying the
557 component's relative intensity, one to four digits long (usually two
558 digits are used). The components must have the same number of digits.
559 For hexadecimal values A to F, either upper or lower case are
560 acceptable.
561
562 The @kbd{M-x list-colors-display} command also shows the equivalent
563 RGB triplet for each named color. For instance, @samp{medium sea
564 green} is equivalent to @samp{#3CB371}.
565
566 @cindex face colors, setting
567 @findex set-face-foreground
568 @findex set-face-background
569 You can change the foreground and background colors of a face with
570 @kbd{M-x set-face-foreground} and @kbd{M-x set-face-background}.
571 These commands prompt in the minibuffer for a face name and a color,
572 with completion, and then set that face to use the specified color.
573 They affect the face colors on all frames, but their effects do not
574 persist for future Emacs sessions, unlike using the customization
575 buffer or X resources. You can also use frame parameters to set
576 foreground and background colors for a specific frame; @xref{Frame
577 Parameters}.
578
579 @node Standard Faces
580 @section Standard Faces
581
582 Here are the standard faces for specifying text appearance. You can
583 apply them to specific text when you want the effects they produce.
584
585 @table @code
586 @item default
587 This face is used for ordinary text that doesn't specify any face.
588 Its background color is used as the frame's background color.
589 @item bold
590 This face uses a bold variant of the default font.
591 @item italic
592 This face uses an italic variant of the default font.
593 @item bold-italic
594 This face uses a bold italic variant of the default font.
595 @item underline
596 This face underlines text.
597 @item fixed-pitch
598 This face forces use of a fixed-width font. It's reasonable to
599 customize this face to use a different fixed-width font, if you like,
600 but you should not make it a variable-width font.
601 @item variable-pitch
602 This face forces use of a variable-width font.
603 @item shadow
604 This face is used for making the text less noticeable than the surrounding
605 ordinary text. Usually this can be achieved by using shades of gray in
606 contrast with either black or white default foreground color.
607 @end table
608
609 Here's an incomplete list of faces used to highlight parts of the
610 text temporarily for specific purposes. (Many other modes define
611 their own faces for this purpose.)
612
613 @table @code
614 @item highlight
615 This face is used for text highlighting in various contexts, such as
616 when the mouse cursor is moved over a hyperlink.
617 @item isearch
618 This face is used to highlight the current Isearch match
619 (@pxref{Incremental Search}).
620 @item query-replace
621 This face is used to highlight the current Query Replace match
622 (@pxref{Replace}).
623 @item lazy-highlight
624 This face is used to highlight ``lazy matches'' for Isearch and Query
625 Replace (matches other than the current one).
626 @item region
627 This face is used for displaying an active region (@pxref{Mark}).
628 When Emacs is built with GTK support, its colors are taken from the
629 current GTK theme.
630 @item secondary-selection
631 This face is used for displaying a secondary X selection (@pxref{Secondary
632 Selection}).
633 @item trailing-whitespace
634 The face for highlighting excess spaces and tabs at the end of a line
635 when @code{show-trailing-whitespace} is non-@code{nil} (@pxref{Useless
636 Whitespace}).
637 @item escape-glyph
638 The face for displaying control characters and escape sequences
639 (@pxref{Text Display}).
640 @item nobreak-space
641 The face for displaying ``no-break'' space characters (@pxref{Text
642 Display}).
643 @end table
644
645 The following faces control the appearance of parts of the Emacs
646 frame:
647
648 @table @code
649 @item mode-line
650 This face is used for the mode line of the currently selected window,
651 and for menu bars when toolkit menus are not used. By default, it's
652 drawn with shadows for a ``raised'' effect on graphical displays, and
653 drawn as the inverse of the default face on non-windowed terminals.
654 @item mode-line-inactive
655 Like @code{mode-line}, but used for mode lines of the windows other
656 than the selected one (if @code{mode-line-in-non-selected-windows} is
657 non-@code{nil}). This face inherits from @code{mode-line}, so changes
658 in that face affect mode lines in all windows.
659 @item mode-line-highlight
660 Like @code{highlight}, but used for portions of text on mode lines.
661 @item mode-line-buffer-id
662 This face is used for buffer identification parts in the mode line.
663 @item header-line
664 Similar to @code{mode-line} for a window's header line, which appears
665 at the top of a window just as the mode line appears at the bottom.
666 Most windows do not have a header line---only some special modes, such
667 Info mode, create one.
668 @item vertical-border
669 This face is used for the vertical divider between windows on text
670 terminals.
671 @item minibuffer-prompt
672 @cindex @code{minibuffer-prompt} face
673 @vindex minibuffer-prompt-properties
674 This face is used for the prompt strings displayed in the minibuffer.
675 By default, Emacs automatically adds this face to the value of
676 @code{minibuffer-prompt-properties}, which is a list of text
677 properties used to display the prompt text. (This variable takes
678 effect when you enter the minibuffer.)
679 @item fringe
680 @cindex @code{fringe} face
681 The face for the fringes to the left and right of windows on graphic
682 displays. (The fringes are the narrow portions of the Emacs frame
683 between the text area and the window's right and left borders.)
684 @xref{Fringes}.
685 @item cursor
686 The @code{:background} attribute of this face specifies the color of
687 the text cursor. @xref{Cursor Display}.
688 @item tooltip
689 This face is used for tooltip text. By default, if Emacs is built
690 with GTK support, tooltips are drawn via GTK and this face has no
691 effect. @xref{Tooltips}.
692 @item mouse
693 This face determines the color of the mouse pointer.
694 @end table
695
696 The following faces likewise control the appearance of parts of the
697 Emacs frame, but only on text terminals, or when Emacs is built on X
698 with no toolkit support. (For all other cases, the appearance of the
699 respective frame elements is determined by system-wide settings.)
700
701 @table @code
702 @item scroll-bar
703 This face determines the visual appearance of the scroll bar.
704 @xref{Scroll Bars}.
705 @item tool-bar
706 This face determines the color of tool bar icons. @xref{Tool Bars}.
707 @item menu
708 @cindex menu bar appearance
709 @cindex @code{menu} face, no effect if customized
710 @cindex customization of @code{menu} face
711 This face determines the colors and font of Emacs's menus. @xref{Menu
712 Bars}.
713 @item tty-menu-enabled-face
714 @cindex faces for text-mode menus
715 @cindex TTY menu faces
716 This face is used to display enabled menu items on text-mode
717 terminals.
718 @item tty-menu-disabled-face
719 This face is used to display disabled menu items on text-mode
720 terminals.
721 @item tty-menu-selected-face
722 This face is used to display on text-mode terminals the menu item that
723 would be selected if you click a mouse or press @key{RET}.
724 @end table
725
726 @node Text Scale
727 @section Text Scale
728
729 @cindex adjust buffer face height
730 @findex text-scale-adjust
731 @kindex C-x C-+
732 @kindex C-x C--
733 @kindex C-x C-=
734 @kindex C-x C-0
735 To increase the height of the default face in the current buffer,
736 type @kbd{C-x C-+} or @kbd{C-x C-=}. To decrease it, type @kbd{C-x
737 C--}. To restore the default (global) face height, type @kbd{C-x
738 C-0}. These keys are all bound to the same command,
739 @code{text-scale-adjust}, which looks at the last key typed to
740 determine which action to take.
741
742 The final key of these commands may be repeated without the leading
743 @kbd{C-x}. For instance, @kbd{C-x C-= C-= C-=} increases the face
744 height by three steps. Each step scales the text height by a factor
745 of 1.2; to change this factor, customize the variable
746 @code{text-scale-mode-step}. A numeric argument of 0
747 to the @code{text-scale-adjust} command restores the default height,
748 the same as typing @kbd{C-x C-0}.
749
750 @cindex increase buffer face height
751 @findex text-scale-increase
752 @cindex decrease buffer face height
753 @findex text-scale-decrease
754 The commands @code{text-scale-increase} and
755 @code{text-scale-decrease} increase or decrease the height of the
756 default face, just like @kbd{C-x C-+} and @kbd{C-x C--} respectively.
757 You may find it convenient to bind to these commands, rather than
758 @code{text-scale-adjust}.
759
760 @cindex set buffer face height
761 @findex text-scale-set
762 The command @code{text-scale-set} scales the height of the default
763 face in the current buffer to an absolute level specified by its
764 prefix argument.
765
766 @findex text-scale-mode
767 The above commands automatically enable the minor mode
768 @code{text-scale-mode} if the current font scaling is other than 1,
769 and disable it otherwise.
770
771 @node Font Lock
772 @section Font Lock mode
773 @cindex Font Lock mode
774 @cindex mode, Font Lock
775 @cindex syntax highlighting and coloring
776
777 Font Lock mode is a minor mode, always local to a particular buffer,
778 which assigns faces to (or @dfn{fontifies}) the text in the buffer.
779 Each buffer's major mode tells Font Lock mode which text to fontify;
780 for instance, programming language modes fontify syntactically
781 relevant constructs like comments, strings, and function names.
782
783 @findex font-lock-mode
784 Font Lock mode is enabled by default. To toggle it in the current
785 buffer, type @kbd{M-x font-lock-mode}. A positive numeric argument
786 unconditionally enables Font Lock mode, and a negative or zero
787 argument disables it.
788
789 @findex global-font-lock-mode
790 @vindex global-font-lock-mode
791 Type @kbd{M-x global-font-lock-mode} to toggle Font Lock mode in all
792 buffers. To impose this setting for future Emacs sessions, customize
793 the variable @code{global-font-lock-mode} (@pxref{Easy
794 Customization}), or add the following line to your init file:
795
796 @example
797 (global-font-lock-mode 0)
798 @end example
799
800 @noindent
801 If you have disabled Global Font Lock mode, you can still enable Font
802 Lock for specific major modes by adding the function
803 @code{font-lock-mode} to the mode hooks (@pxref{Hooks}). For example,
804 to enable Font Lock mode for editing C files, you can do this:
805
806 @example
807 (add-hook 'c-mode-hook 'font-lock-mode)
808 @end example
809
810 Font Lock mode uses several specifically named faces to do its job,
811 including @code{font-lock-string-face}, @code{font-lock-comment-face},
812 and others. The easiest way to find them all is to use @kbd{M-x
813 customize-group @key{RET} font-lock-faces @key{RET}}. You can then
814 use that customization buffer to customize the appearance of these
815 faces. @xref{Face Customization}.
816
817 @vindex font-lock-maximum-decoration
818 You can customize the variable @code{font-lock-maximum-decoration}
819 to alter the amount of fontification applied by Font Lock mode, for
820 major modes that support this feature. The value should be a number
821 (with 1 representing a minimal amount of fontification; some modes
822 support levels as high as 3); or @code{t}, meaning ``as high as
823 possible'' (the default). You can also specify different numbers for
824 particular major modes; for example, to use level 1 for C/C++ modes,
825 and the default level otherwise, use the value
826
827 @example
828 '((c-mode . 1) (c++-mode . 1)))
829 @end example
830
831 @vindex font-lock-beginning-of-syntax-function
832 @cindex incorrect fontification
833 @cindex parenthesis in column zero and fontification
834 @cindex brace in column zero and fontification
835 Comment and string fontification (or ``syntactic'' fontification)
836 relies on analysis of the syntactic structure of the buffer text. For
837 the sake of speed, some modes, including Lisp mode, rely on a special
838 convention: an open-parenthesis or open-brace in the leftmost column
839 always defines the beginning of a defun, and is thus always outside
840 any string or comment. Therefore, you should avoid placing an
841 open-parenthesis or open-brace in the leftmost column, if it is inside
842 a string or comment. @xref{Left Margin Paren}, for details.
843
844 @cindex slow display during scrolling
845 The variable @code{font-lock-beginning-of-syntax-function}, which is
846 always buffer-local, specifies how Font Lock mode can find a position
847 guaranteed to be outside any comment or string. In modes which use
848 the leftmost column parenthesis convention, the default value of the
849 variable is @code{beginning-of-defun}---that tells Font Lock mode to
850 use the convention. If you set this variable to @code{nil}, Font Lock
851 no longer relies on the convention. This avoids incorrect results,
852 but the price is that, in some cases, fontification for a changed text
853 must rescan buffer text from the beginning of the buffer. This can
854 considerably slow down redisplay while scrolling, particularly if you
855 are close to the end of a large buffer.
856
857 @findex font-lock-add-keywords
858 Font Lock highlighting patterns already exist for most modes, but
859 you may want to fontify additional patterns. You can use the function
860 @code{font-lock-add-keywords}, to add your own highlighting patterns
861 for a particular mode. For example, to highlight @samp{FIXME:} words
862 in C comments, use this:
863
864 @example
865 (add-hook 'c-mode-hook
866 (lambda ()
867 (font-lock-add-keywords nil
868 '(("\\<\\(FIXME\\):" 1
869 font-lock-warning-face t)))))
870 @end example
871
872 @findex font-lock-remove-keywords
873 @noindent
874 To remove keywords from the font-lock highlighting patterns, use the
875 function @code{font-lock-remove-keywords}. @xref{Search-based
876 Fontification,,, elisp, The Emacs Lisp Reference Manual}.
877
878 @cindex just-in-time (JIT) font-lock
879 @cindex background syntax highlighting
880 Fontifying large buffers can take a long time. To avoid large
881 delays when a file is visited, Emacs initially fontifies only the
882 visible portion of a buffer. As you scroll through the buffer, each
883 portion that becomes visible is fontified as soon as it is displayed;
884 this type of Font Lock is called @dfn{Just-In-Time} (or @dfn{JIT})
885 Lock. You can control how JIT Lock behaves, including telling it to
886 perform fontification while idle, by customizing variables in the
887 customization group @samp{jit-lock}. @xref{Specific Customization}.
888
889 @node Highlight Interactively
890 @section Interactive Highlighting
891 @cindex highlighting by matching
892 @cindex interactive highlighting
893 @cindex Highlight Changes mode
894
895 @findex highlight-changes-mode
896 Highlight Changes mode is a minor mode that @dfn{highlights} the parts
897 of the buffer that were changed most recently, by giving that text a
898 different face. To enable or disable Highlight Changes mode, use
899 @kbd{M-x highlight-changes-mode}.
900
901 @cindex Hi Lock mode
902 @findex hi-lock-mode
903 Hi Lock mode is a minor mode that highlights text that matches
904 regular expressions you specify. For example, you can use it to
905 highlight all the references to a certain variable in a program source
906 file, highlight certain parts in a voluminous output of some program,
907 or highlight certain names in an article. To enable or disable Hi
908 Lock mode, use the command @kbd{M-x hi-lock-mode}. To enable Hi Lock
909 mode for all buffers, use @kbd{M-x global-hi-lock-mode} or place
910 @code{(global-hi-lock-mode 1)} in your @file{.emacs} file.
911
912 Hi Lock mode works like Font Lock mode (@pxref{Font Lock}), except
913 that you specify explicitly the regular expressions to highlight. You
914 control them with these commands:
915
916 @table @kbd
917 @item M-s h r @var{regexp} @key{RET} @var{face} @key{RET}
918 @itemx C-x w h @var{regexp} @key{RET} @var{face} @key{RET}
919 @kindex M-s h r
920 @kindex C-x w h
921 @findex highlight-regexp
922 Highlight text that matches @var{regexp} using face @var{face}
923 (@code{highlight-regexp}). The highlighting will remain as long as
924 the buffer is loaded. For example, to highlight all occurrences of
925 the word ``whim'' using the default face (a yellow background)
926 @kbd{M-s h r whim @key{RET} @key{RET}}. Any face can be used for
927 highlighting, Hi Lock provides several of its own and these are
928 pre-loaded into a list of default values. While being prompted
929 for a face use @kbd{M-n} and @kbd{M-p} to cycle through them.
930
931 @vindex hi-lock-auto-select-face
932 Setting the option @code{hi-lock-auto-select-face} to a non-@code{nil}
933 value causes this command (and other Hi Lock commands that read faces)
934 to automatically choose the next face from the default list without
935 prompting.
936
937 You can use this command multiple times, specifying various regular
938 expressions to highlight in different ways.
939
940 @item M-s h u @var{regexp} @key{RET}
941 @itemx C-x w r @var{regexp} @key{RET}
942 @kindex M-s h u
943 @kindex C-x w r
944 @findex unhighlight-regexp
945 Unhighlight @var{regexp} (@code{unhighlight-regexp}).
946
947 If you invoke this from the menu, you select the expression to
948 unhighlight from a list. If you invoke this from the keyboard, you
949 use the minibuffer. It will show the most recently added regular
950 expression; use @kbd{M-n} to show the next older expression and
951 @kbd{M-p} to select the next newer expression. (You can also type the
952 expression by hand, with completion.) When the expression you want to
953 unhighlight appears in the minibuffer, press @kbd{@key{RET}} to exit
954 the minibuffer and unhighlight it.
955
956 @item M-s h l @var{regexp} @key{RET} @var{face} @key{RET}
957 @itemx C-x w l @var{regexp} @key{RET} @var{face} @key{RET}
958 @kindex M-s h l
959 @kindex C-x w l
960 @findex highlight-lines-matching-regexp
961 @cindex lines, highlighting
962 @cindex highlighting lines of text
963 Highlight entire lines containing a match for @var{regexp}, using face
964 @var{face} (@code{highlight-lines-matching-regexp}).
965
966 @item M-s h p @var{phrase} @key{RET} @var{face} @key{RET}
967 @itemx C-x w p @var{phrase} @key{RET} @var{face} @key{RET}
968 @kindex M-s h p
969 @kindex C-x w p
970 @findex highlight-phrase
971 @cindex phrase, highlighting
972 @cindex highlighting phrase
973 Highlight matches of @var{phrase}, using face @var{face}
974 (@code{highlight-phrase}). @var{phrase} can be any regexp,
975 but spaces will be replaced by matches to whitespace and
976 initial lower-case letters will become case insensitive.
977
978 @item M-s h .
979 @itemx C-x w .
980 @kindex M-s h .
981 @kindex C-x w .
982 @findex highlight-symbol-at-point
983 @cindex symbol, highlighting
984 @cindex highlighting symbol at point
985 Highlight the symbol found near point, using the next available face
986 (@code{highlight-symbol-at-point}).
987
988 @item M-s h w
989 @itemx C-x w b
990 @kindex M-s h w
991 @kindex C-x w b
992 @findex hi-lock-write-interactive-patterns
993 Insert all the current highlighting regexp/face pairs into the buffer
994 at point, with comment delimiters to prevent them from changing your
995 program. (This key binding runs the
996 @code{hi-lock-write-interactive-patterns} command.)
997
998 These patterns are extracted from the comments, if appropriate, if you
999 invoke @kbd{M-x hi-lock-find-patterns}, or if you visit the file while
1000 Hi Lock mode is enabled (since that runs @code{hi-lock-find-patterns}).
1001
1002 @item M-s h f
1003 @itemx C-x w i
1004 @kindex M-s h f
1005 @kindex C-x w i
1006 @findex hi-lock-find-patterns
1007 Extract regexp/face pairs from comments in the current buffer
1008 (@code{hi-lock-find-patterns}). Thus, you can enter patterns
1009 interactively with @code{highlight-regexp}, store them into the file
1010 with @code{hi-lock-write-interactive-patterns}, edit them (perhaps
1011 including different faces for different parenthesized parts of the
1012 match), and finally use this command (@code{hi-lock-find-patterns}) to
1013 have Hi Lock highlight the edited patterns.
1014
1015 @vindex hi-lock-file-patterns-policy
1016 The variable @code{hi-lock-file-patterns-policy} controls whether Hi
1017 Lock mode should automatically extract and highlight patterns found in a
1018 file when it is visited. Its value can be @code{nil} (never highlight),
1019 @code{ask} (query the user), or a function. If it is a function,
1020 @code{hi-lock-find-patterns} calls it with the patterns as argument; if
1021 the function returns non-@code{nil}, the patterns are used. The default
1022 is @code{ask}. Note that patterns are always highlighted if you call
1023 @code{hi-lock-find-patterns} directly, regardless of the value of this
1024 variable.
1025
1026 @vindex hi-lock-exclude-modes
1027 Also, @code{hi-lock-find-patterns} does nothing if the current major
1028 mode's symbol is a member of the list @code{hi-lock-exclude-modes}.
1029 @end table
1030
1031 @node Fringes
1032 @section Window Fringes
1033 @cindex fringes
1034
1035 @findex set-fringe-style
1036 @findex fringe-mode
1037 @vindex fringe-mode @r{(variable)}
1038 On graphical displays, each Emacs window normally has narrow
1039 @dfn{fringes} on the left and right edges. The fringes are used to
1040 display symbols that provide information about the text in the window.
1041 You can type @kbd{M-x fringe-mode} to disable the fringes, or modify
1042 their width. This command affects fringes in all frames; to modify
1043 fringes on the selected frame only, use @kbd{M-x set-fringe-style}.
1044 You can make your changes to the fringes permanent by customizing the
1045 variable @code{fringe-mode}.
1046
1047 The most common use of the fringes is to indicate a continuation
1048 line (@pxref{Continuation Lines}). When one line of text is split
1049 into multiple screen lines, the left fringe shows a curving arrow for
1050 each screen line except the first, indicating that ``this is not the
1051 real beginning''. The right fringe shows a curving arrow for each
1052 screen line except the last, indicating that ``this is not the real
1053 end''. If the line's direction is right-to-left (@pxref{Bidirectional
1054 Editing}), the meanings of the curving arrows in the fringes are
1055 swapped.
1056
1057 The fringes indicate line truncation with short horizontal arrows
1058 meaning ``there's more text on this line which is scrolled
1059 horizontally out of view''. Clicking the mouse on one of the arrows
1060 scrolls the display horizontally in the direction of the arrow.
1061
1062 The fringes can also indicate other things, such as buffer
1063 boundaries (@pxref{Displaying Boundaries}), and where a program you
1064 are debugging is executing (@pxref{Debuggers}).
1065
1066 @vindex overflow-newline-into-fringe
1067 The fringe is also used for drawing the cursor, if the current line
1068 is exactly as wide as the window and point is at the end of the line.
1069 To disable this, change the variable
1070 @code{overflow-newline-into-fringe} to @code{nil}; this causes Emacs
1071 to continue or truncate lines that are exactly as wide as the window.
1072
1073 @node Displaying Boundaries
1074 @section Displaying Boundaries
1075
1076 @vindex indicate-buffer-boundaries
1077 On graphical displays, Emacs can indicate the buffer boundaries in
1078 the fringes. If you enable this feature, the first line and the last
1079 line are marked with angle images in the fringes. This can be
1080 combined with up and down arrow images which say whether it is
1081 possible to scroll the window.
1082
1083 The buffer-local variable @code{indicate-buffer-boundaries} controls
1084 how the buffer boundaries and window scrolling is indicated in the
1085 fringes. If the value is @code{left} or @code{right}, both angle and
1086 arrow bitmaps are displayed in the left or right fringe, respectively.
1087
1088 If value is an alist, each element @code{(@var{indicator} .
1089 @var{position})} specifies the position of one of the indicators.
1090 The @var{indicator} must be one of @code{top}, @code{bottom},
1091 @code{up}, @code{down}, or @code{t} which specifies the default
1092 position for the indicators not present in the alist.
1093 The @var{position} is one of @code{left}, @code{right}, or @code{nil}
1094 which specifies not to show this indicator.
1095
1096 For example, @code{((top . left) (t . right))} places the top angle
1097 bitmap in left fringe, the bottom angle bitmap in right fringe, and
1098 both arrow bitmaps in right fringe. To show just the angle bitmaps in
1099 the left fringe, but no arrow bitmaps, use @code{((top . left)
1100 (bottom . left))}.
1101
1102 @node Useless Whitespace
1103 @section Useless Whitespace
1104
1105 @cindex trailing whitespace
1106 @cindex whitespace, trailing
1107 @vindex show-trailing-whitespace
1108 It is easy to leave unnecessary spaces at the end of a line, or
1109 empty lines at the end of a buffer, without realizing it. In most
1110 cases, this @dfn{trailing whitespace} has no effect, but sometimes it
1111 can be a nuisance.
1112
1113 You can make trailing whitespace at the end of a line visible by
1114 setting the buffer-local variable @code{show-trailing-whitespace} to
1115 @code{t}. Then Emacs displays trailing whitespace, using the face
1116 @code{trailing-whitespace}.
1117
1118 This feature does not apply when point is at the end of the line
1119 containing the whitespace. Strictly speaking, that is ``trailing
1120 whitespace'' nonetheless, but displaying it specially in that case
1121 looks ugly while you are typing in new text. In this special case,
1122 the location of point is enough to show you that the spaces are
1123 present.
1124
1125 @findex delete-trailing-whitespace
1126 @vindex delete-trailing-lines
1127 Type @kbd{M-x delete-trailing-whitespace} to delete all trailing
1128 whitespace. This command deletes all extra spaces at the end of each
1129 line in the buffer, and all empty lines at the end of the buffer; to
1130 ignore the latter, change the variable @code{delete-trailing-lines} to
1131 @code{nil}. If the region is active, the command instead deletes
1132 extra spaces at the end of each line in the region.
1133
1134 @vindex indicate-empty-lines
1135 @cindex unused lines
1136 @cindex fringes, and unused line indication
1137 On graphical displays, Emacs can indicate unused lines at the end of
1138 the window with a small image in the left fringe (@pxref{Fringes}).
1139 The image appears for screen lines that do not correspond to any
1140 buffer text, so blank lines at the end of the buffer stand out because
1141 they lack this image. To enable this feature, set the buffer-local
1142 variable @code{indicate-empty-lines} to a non-@code{nil} value. You
1143 can enable or disable this feature for all new buffers by setting the
1144 default value of this variable, e.g., @code{(setq-default
1145 indicate-empty-lines t)}.
1146
1147 @cindex Whitespace mode
1148 @cindex mode, Whitespace
1149 @findex whitespace-mode
1150 @vindex whitespace-style
1151 Whitespace mode is a buffer-local minor mode that lets you
1152 ``visualize'' many kinds of whitespace in the buffer, by either
1153 drawing the whitespace characters with a special face or displaying
1154 them as special glyphs. To toggle this mode, type @kbd{M-x
1155 whitespace-mode}. The kinds of whitespace visualized are determined
1156 by the list variable @code{whitespace-style}. Here is a partial list
1157 of possible elements (see the variable's documentation for the full
1158 list):
1159
1160 @table @code
1161 @item face
1162 Enable all visualizations which use special faces. This element has a
1163 special meaning: if it is absent from the list, none of the other
1164 visualizations take effect except @code{space-mark}, @code{tab-mark},
1165 and @code{newline-mark}.
1166
1167 @item trailing
1168 Highlight trailing whitespace.
1169
1170 @item tabs
1171 Highlight tab characters.
1172
1173 @item spaces
1174 Highlight space and non-breaking space characters.
1175
1176 @item lines
1177 @vindex whitespace-line-column
1178 Highlight lines longer than 80 lines. To change the column limit,
1179 customize the variable @code{whitespace-line-column}.
1180
1181 @item newline
1182 Highlight newlines.
1183
1184 @item empty
1185 Highlight empty lines.
1186
1187 @item space-mark
1188 Draw space and non-breaking characters with a special glyph.
1189
1190 @item tab-mark
1191 Draw tab characters with a special glyph.
1192
1193 @item newline-mark
1194 Draw newline characters with a special glyph.
1195 @end table
1196
1197 @node Selective Display
1198 @section Selective Display
1199 @cindex selective display
1200 @findex set-selective-display
1201 @kindex C-x $
1202
1203 Emacs has the ability to hide lines indented more than a given
1204 number of columns. You can use this to get an overview of a part of a
1205 program.
1206
1207 To hide lines in the current buffer, type @kbd{C-x $}
1208 (@code{set-selective-display}) with a numeric argument @var{n}. Then
1209 lines with at least @var{n} columns of indentation disappear from the
1210 screen. The only indication of their presence is that three dots
1211 (@samp{@dots{}}) appear at the end of each visible line that is
1212 followed by one or more hidden ones.
1213
1214 The commands @kbd{C-n} and @kbd{C-p} move across the hidden lines as
1215 if they were not there.
1216
1217 The hidden lines are still present in the buffer, and most editing
1218 commands see them as usual, so you may find point in the middle of the
1219 hidden text. When this happens, the cursor appears at the end of the
1220 previous line, after the three dots. If point is at the end of the
1221 visible line, before the newline that ends it, the cursor appears before
1222 the three dots.
1223
1224 To make all lines visible again, type @kbd{C-x $} with no argument.
1225
1226 @vindex selective-display-ellipses
1227 If you set the variable @code{selective-display-ellipses} to
1228 @code{nil}, the three dots do not appear at the end of a line that
1229 precedes hidden lines. Then there is no visible indication of the
1230 hidden lines. This variable becomes local automatically when set.
1231
1232 See also @ref{Outline Mode} for another way to hide part of
1233 the text in a buffer.
1234
1235 @node Optional Mode Line
1236 @section Optional Mode Line Features
1237
1238 @cindex buffer size display
1239 @cindex display of buffer size
1240 @findex size-indication-mode
1241 The buffer percentage @var{pos} indicates the percentage of the
1242 buffer above the top of the window. You can additionally display the
1243 size of the buffer by typing @kbd{M-x size-indication-mode} to turn on
1244 Size Indication mode. The size will be displayed immediately
1245 following the buffer percentage like this:
1246
1247 @example
1248 @var{POS} of @var{SIZE}
1249 @end example
1250
1251 @noindent
1252 Here @var{SIZE} is the human readable representation of the number of
1253 characters in the buffer, which means that @samp{k} for 10^3, @samp{M}
1254 for 10^6, @samp{G} for 10^9, etc., are used to abbreviate.
1255
1256 @cindex line number display
1257 @cindex display of line number
1258 @findex line-number-mode
1259 The current line number of point appears in the mode line when Line
1260 Number mode is enabled. Use the command @kbd{M-x line-number-mode} to
1261 turn this mode on and off; normally it is on. The line number appears
1262 after the buffer percentage @var{pos}, with the letter @samp{L} to
1263 indicate what it is.
1264
1265 @cindex Column Number mode
1266 @cindex mode, Column Number
1267 @findex column-number-mode
1268 Similarly, you can display the current column number by turning on
1269 Column number mode with @kbd{M-x column-number-mode}. The column
1270 number is indicated by the letter @samp{C}. However, when both of
1271 these modes are enabled, the line and column numbers are displayed in
1272 parentheses, the line number first, rather than with @samp{L} and
1273 @samp{C}. For example: @samp{(561,2)}. @xref{Minor Modes}, for more
1274 information about minor modes and about how to use these commands.
1275
1276 @cindex narrowing, and line number display
1277 If you have narrowed the buffer (@pxref{Narrowing}), the displayed
1278 line number is relative to the accessible portion of the buffer.
1279 Thus, it isn't suitable as an argument to @code{goto-line}. (Use
1280 @code{what-line} command to see the line number relative to the whole
1281 file.)
1282
1283 @vindex line-number-display-limit
1284 If the buffer is very large (larger than the value of
1285 @code{line-number-display-limit}), Emacs won't compute the line
1286 number, because that would be too slow; therefore, the line number
1287 won't appear on the mode-line. To remove this limit, set
1288 @code{line-number-display-limit} to @code{nil}.
1289
1290 @vindex line-number-display-limit-width
1291 Line-number computation can also be slow if the lines in the buffer
1292 are too long. For this reason, Emacs doesn't display line numbers if
1293 the average width, in characters, of lines near point is larger than
1294 the value of @code{line-number-display-limit-width}. The default
1295 value is 200 characters.
1296
1297 @findex display-time
1298 @cindex time (on mode line)
1299 Emacs can optionally display the time and system load in all mode
1300 lines. To enable this feature, type @kbd{M-x display-time} or customize
1301 the option @code{display-time-mode}. The information added to the mode
1302 line looks like this:
1303
1304 @example
1305 @var{hh}:@var{mm}pm @var{l.ll}
1306 @end example
1307
1308 @noindent
1309 @vindex display-time-24hr-format
1310 Here @var{hh} and @var{mm} are the hour and minute, followed always by
1311 @samp{am} or @samp{pm}. @var{l.ll} is the average number, collected
1312 for the last few minutes, of processes in the whole system that were
1313 either running or ready to run (i.e., were waiting for an available
1314 processor). (Some fields may be missing if your operating system
1315 cannot support them.) If you prefer time display in 24-hour format,
1316 set the variable @code{display-time-24hr-format} to @code{t}.
1317
1318 @cindex mail (on mode line)
1319 @vindex display-time-use-mail-icon
1320 @vindex display-time-mail-face
1321 @vindex display-time-mail-file
1322 @vindex display-time-mail-directory
1323 The word @samp{Mail} appears after the load level if there is mail
1324 for you that you have not read yet. On graphical displays, you can
1325 use an icon instead of @samp{Mail} by customizing
1326 @code{display-time-use-mail-icon}; this may save some space on the
1327 mode line. You can customize @code{display-time-mail-face} to make
1328 the mail indicator prominent. Use @code{display-time-mail-file} to
1329 specify the mail file to check, or set
1330 @code{display-time-mail-directory} to specify the directory to check
1331 for incoming mail (any nonempty regular file in the directory is
1332 considered as ``newly arrived mail'').
1333
1334 @cindex battery status (on mode line)
1335 @findex display-battery-mode
1336 @vindex display-battery-mode
1337 @vindex battery-mode-line-format
1338 When running Emacs on a laptop computer, you can display the battery
1339 charge on the mode-line, by using the command
1340 @code{display-battery-mode} or customizing the variable
1341 @code{display-battery-mode}. The variable
1342 @code{battery-mode-line-format} determines the way the battery charge
1343 is displayed; the exact mode-line message depends on the operating
1344 system, and it usually shows the current battery charge as a
1345 percentage of the total charge.
1346
1347 @cindex mode line, 3D appearance
1348 @cindex attributes of mode line, changing
1349 @cindex non-integral number of lines in a window
1350 On graphical displays, the mode line is drawn as a 3D box. If you
1351 don't like this effect, you can disable it by customizing the
1352 @code{mode-line} face and setting its @code{box} attribute to
1353 @code{nil}. @xref{Face Customization}.
1354
1355 @cindex non-selected windows, mode line appearance
1356 By default, the mode line of nonselected windows is displayed in a
1357 different face, called @code{mode-line-inactive}. Only the selected
1358 window is displayed in the @code{mode-line} face. This helps show
1359 which window is selected. When the minibuffer is selected, since
1360 it has no mode line, the window from which you activated the minibuffer
1361 has its mode line displayed using @code{mode-line}; as a result,
1362 ordinary entry to the minibuffer does not change any mode lines.
1363
1364 @vindex mode-line-in-non-selected-windows
1365 You can disable use of @code{mode-line-inactive} by setting variable
1366 @code{mode-line-in-non-selected-windows} to @code{nil}; then all mode
1367 lines are displayed in the @code{mode-line} face.
1368
1369 @vindex eol-mnemonic-unix
1370 @vindex eol-mnemonic-dos
1371 @vindex eol-mnemonic-mac
1372 @vindex eol-mnemonic-undecided
1373 You can customize the mode line display for each of the end-of-line
1374 formats by setting each of the variables @code{eol-mnemonic-unix},
1375 @code{eol-mnemonic-dos}, @code{eol-mnemonic-mac}, and
1376 @code{eol-mnemonic-undecided} to the strings you prefer.
1377
1378 @node Text Display
1379 @section How Text Is Displayed
1380 @cindex characters (in text)
1381 @cindex printing character
1382
1383 Most characters are @dfn{printing characters}: when they appear in a
1384 buffer, they are displayed literally on the screen. Printing
1385 characters include @acronym{ASCII} numbers, letters, and punctuation
1386 characters, as well as many non-@acronym{ASCII} characters.
1387
1388 @vindex tab-width
1389 @cindex control characters on display
1390 The @acronym{ASCII} character set contains non-printing @dfn{control
1391 characters}. Two of these are displayed specially: the newline
1392 character (Unicode code point @code{U+000A}) is displayed by starting
1393 a new line, while the tab character (@code{U+0009}) is displayed as a
1394 space that extends to the next tab stop column (normally every 8
1395 columns). The number of spaces per tab is controlled by the
1396 buffer-local variable @code{tab-width}, which must have an integer
1397 value between 1 and 1000, inclusive. Note that how the tab character
1398 in the buffer is displayed has nothing to do with the definition of
1399 @key{TAB} as a command.
1400
1401 Other @acronym{ASCII} control characters, whose codes are below
1402 @code{U+0020} (octal 40, decimal 32), are displayed as a caret
1403 (@samp{^}) followed by the non-control version of the character, with
1404 the @code{escape-glyph} face. For instance, the @samp{control-A}
1405 character, @code{U+0001}, is displayed as @samp{^A}.
1406
1407 @cindex octal escapes
1408 @vindex ctl-arrow
1409 The raw bytes with codes @code{U+0080} (octal 200) through
1410 @code{U+009F} (octal 237) are displayed as @dfn{octal escape
1411 sequences}, with the @code{escape-glyph} face. For instance,
1412 character code @code{U+0098} (octal 230) is displayed as @samp{\230}.
1413 If you change the buffer-local variable @code{ctl-arrow} to
1414 @code{nil}, the @acronym{ASCII} control characters are also displayed
1415 as octal escape sequences instead of caret escape sequences.
1416
1417 @vindex nobreak-char-display
1418 @cindex non-breaking space
1419 @cindex non-breaking hyphen
1420 @cindex soft hyphen
1421 Some non-@acronym{ASCII} characters have the same appearance as an
1422 @acronym{ASCII} space or hyphen (minus) character. Such characters
1423 can cause problems if they are entered into a buffer without your
1424 realization, e.g., by yanking; for instance, source code compilers
1425 typically do not treat non-@acronym{ASCII} spaces as whitespace
1426 characters. To deal with this problem, Emacs displays such characters
1427 specially: it displays @code{U+00A0} (no-break space) with the
1428 @code{nobreak-space} face, and it displays @code{U+00AD} (soft
1429 hyphen), @code{U+2010} (hyphen), and @code{U+2011} (non-breaking
1430 hyphen) with the @code{escape-glyph} face. To disable this, change
1431 the variable @code{nobreak-char-display} to @code{nil}. If you give
1432 this variable a non-@code{nil} and non-@code{t} value, Emacs instead
1433 displays such characters as a highlighted backslash followed by a
1434 space or hyphen.
1435
1436 You can customize the way any particular character code is displayed
1437 by means of a display table. @xref{Display Tables,, Display Tables,
1438 elisp, The Emacs Lisp Reference Manual}.
1439
1440 @cindex glyphless characters
1441 @cindex characters with no font glyphs
1442 On graphical displays, some characters may have no glyphs in any of
1443 the fonts available to Emacs. These @dfn{glyphless characters} are
1444 normally displayed as boxes containing the hexadecimal character code.
1445 Similarly, on text terminals, characters that cannot be displayed
1446 using the terminal encoding (@pxref{Terminal Coding}) are normally
1447 displayed as question signs. You can control the display method by
1448 customizing the variable @code{glyphless-char-display-control}.
1449 @xref{Glyphless Chars,, Glyphless Character Display, elisp, The Emacs
1450 Lisp Reference Manual}, for details.
1451
1452 @node Cursor Display
1453 @section Displaying the Cursor
1454 @cindex text cursor
1455
1456 @vindex visible-cursor
1457 On a text terminal, the cursor's appearance is controlled by the
1458 terminal, largely out of the control of Emacs. Some terminals offer
1459 two different cursors: a ``visible'' static cursor, and a ``very
1460 visible'' blinking cursor. By default, Emacs uses the very visible
1461 cursor, and switches to it when you start or resume Emacs. If the
1462 variable @code{visible-cursor} is @code{nil} when Emacs starts or
1463 resumes, it uses the normal cursor.
1464
1465 @cindex cursor face
1466 @vindex cursor-type
1467 On a graphical display, many more properties of the text cursor can
1468 be altered. To customize its color, change the @code{:background}
1469 attribute of the face named @code{cursor} (@pxref{Face
1470 Customization}). (The other attributes of this face have no effect;
1471 the text shown under the cursor is drawn using the frame's background
1472 color.) To change its shape, customize the buffer-local variable
1473 @code{cursor-type}; possible values are @code{box} (the default),
1474 @code{hollow} (a hollow box), @code{bar} (a vertical bar), @code{(bar
1475 . @var{n})} (a vertical bar @var{n} pixels wide), @code{hbar} (a
1476 horizontal bar), @code{(hbar . @var{n})} (a horizontal bar @var{n}
1477 pixels tall), or @code{nil} (no cursor at all).
1478
1479 @findex blink-cursor-mode
1480 @cindex cursor, blinking
1481 @cindex blinking cursor
1482 @vindex blink-cursor-mode
1483 @vindex blink-cursor-blinks
1484 @vindex blink-cursor-alist
1485 By default, the cursor stops blinking after 10 blinks, if Emacs does
1486 not get any input during that time; any input event restarts the
1487 count. You can customize the variable @code{blink-cursor-blinks} to
1488 control that: its value says how many times to blink without input
1489 before stopping. Setting that variable to a zero or negative value
1490 will make the cursor blink forever. To disable cursor blinking
1491 altogether, change the variable @code{blink-cursor-mode} to @code{nil}
1492 (@pxref{Easy Customization}), or add the line
1493
1494 @lisp
1495 (blink-cursor-mode 0)
1496 @end lisp
1497
1498 @noindent
1499 to your init file. Alternatively, you can change how the cursor
1500 looks when it ``blinks off'' by customizing the list variable
1501 @code{blink-cursor-alist}. Each element in the list should have the
1502 form @code{(@var{on-type} . @var{off-type})}; this means that if the
1503 cursor is displayed as @var{on-type} when it blinks on (where
1504 @var{on-type} is one of the cursor types described above), then it is
1505 displayed as @var{off-type} when it blinks off.
1506
1507 @vindex x-stretch-cursor
1508 @cindex wide block cursor
1509 Some characters, such as tab characters, are ``extra wide''. When
1510 the cursor is positioned over such a character, it is normally drawn
1511 with the default character width. You can make the cursor stretch to
1512 cover wide characters, by changing the variable
1513 @code{x-stretch-cursor} to a non-@code{nil} value.
1514
1515 @cindex cursor in non-selected windows
1516 @vindex cursor-in-non-selected-windows
1517 The cursor normally appears in non-selected windows as a
1518 non-blinking hollow box. (For a bar cursor, it instead appears as a
1519 thinner bar.) To turn off cursors in non-selected windows, change the
1520 variable @code{cursor-in-non-selected-windows} to @code{nil}.
1521
1522 @findex hl-line-mode
1523 @findex global-hl-line-mode
1524 @cindex highlight current line
1525 To make the cursor even more visible, you can use HL Line mode, a
1526 minor mode that highlights the line containing point. Use @kbd{M-x
1527 hl-line-mode} to enable or disable it in the current buffer. @kbd{M-x
1528 global-hl-line-mode} enables or disables the same mode globally.
1529
1530 @node Line Truncation
1531 @section Line Truncation
1532
1533 @cindex truncation
1534 @cindex line truncation, and fringes
1535 As an alternative to continuation (@pxref{Continuation Lines}),
1536 Emacs can display long lines by @dfn{truncation}. This means that all
1537 the characters that do not fit in the width of the screen or window do
1538 not appear at all. On graphical displays, a small straight arrow in
1539 the fringe indicates truncation at either end of the line. On text
1540 terminals, this is indicated with @samp{$} signs in the leftmost
1541 and/or rightmost columns.
1542
1543 @vindex truncate-lines
1544 @findex toggle-truncate-lines
1545 Horizontal scrolling automatically causes line truncation
1546 (@pxref{Horizontal Scrolling}). You can explicitly enable line
1547 truncation for a particular buffer with the command @kbd{M-x
1548 toggle-truncate-lines}. This works by locally changing the variable
1549 @code{truncate-lines}. If that variable is non-@code{nil}, long lines
1550 are truncated; if it is @code{nil}, they are continued onto multiple
1551 screen lines. Setting the variable @code{truncate-lines} in any way
1552 makes it local to the current buffer; until that time, the default
1553 value, which is normally @code{nil}, is in effect.
1554
1555 @vindex truncate-partial-width-windows
1556 If a split window becomes too narrow, Emacs may automatically enable
1557 line truncation. @xref{Split Window}, for the variable
1558 @code{truncate-partial-width-windows} which controls this.
1559
1560 @node Visual Line Mode
1561 @section Visual Line Mode
1562
1563 @cindex word wrap
1564 Another alternative to ordinary line continuation is to use
1565 @dfn{word wrap}. Here, each long logical line is divided into two or
1566 more screen lines, like in ordinary line continuation. However, Emacs
1567 attempts to wrap the line at word boundaries near the right window
1568 edge. This makes the text easier to read, as wrapping does not occur
1569 in the middle of words.
1570
1571 @cindex mode, Visual Line
1572 @cindex Visual Line mode
1573 @findex visual-line-mode
1574 @findex global-visual-line-mode
1575 Word wrap is enabled by Visual Line mode, an optional minor mode.
1576 To turn on Visual Line mode in the current buffer, type @kbd{M-x
1577 visual-line-mode}; repeating this command turns it off. You can also
1578 turn on Visual Line mode using the menu bar: in the Options menu,
1579 select the @samp{Line Wrapping in this Buffer} submenu, followed by
1580 the @samp{Word Wrap (Visual Line Mode)} menu item. While Visual Line
1581 mode is enabled, the mode-line shows the string @samp{wrap} in the
1582 mode display. The command @kbd{M-x global-visual-line-mode} toggles
1583 Visual Line mode in all buffers.
1584
1585 @findex beginning-of-visual-line
1586 @findex end-of-visual-line
1587 @findex next-logical-line
1588 @findex previous-logical-line
1589 In Visual Line mode, some editing commands work on screen lines
1590 instead of logical lines: @kbd{C-a} (@code{beginning-of-visual-line})
1591 moves to the beginning of the screen line, @kbd{C-e}
1592 (@code{end-of-visual-line}) moves to the end of the screen line, and
1593 @kbd{C-k} (@code{kill-visual-line}) kills text to the end of the
1594 screen line.
1595
1596 To move by logical lines, use the commands @kbd{M-x
1597 next-logical-line} and @kbd{M-x previous-logical-line}. These move
1598 point to the next logical line and the previous logical line
1599 respectively, regardless of whether Visual Line mode is enabled. If
1600 you use these commands frequently, it may be convenient to assign key
1601 bindings to them. @xref{Init Rebinding}.
1602
1603 By default, word-wrapped lines do not display fringe indicators.
1604 Visual Line mode is often used to edit files that contain many long
1605 logical lines, so having a fringe indicator for each wrapped line
1606 would be visually distracting. You can change this by customizing the
1607 variable @code{visual-line-fringe-indicators}.
1608
1609 @node Display Custom
1610 @section Customization of Display
1611
1612 This section describes variables that control miscellaneous aspects
1613 of the appearance of the Emacs screen. Beginning users can skip it.
1614
1615 @vindex visible-bell
1616 If the variable @code{visible-bell} is non-@code{nil}, Emacs attempts
1617 to make the whole screen blink when it would normally make an audible bell
1618 sound. This variable has no effect if your terminal does not have a way
1619 to make the screen blink.
1620
1621 @vindex echo-keystrokes
1622 The variable @code{echo-keystrokes} controls the echoing of multi-character
1623 keys; its value is the number of seconds of pause required to cause echoing
1624 to start, or zero, meaning don't echo at all. The value takes effect when
1625 there is something to echo. @xref{Echo Area}.
1626
1627 @cindex mouse pointer
1628 @cindex hourglass pointer display
1629 @vindex display-hourglass
1630 @vindex hourglass-delay
1631 On graphical displays, Emacs displays the mouse pointer as an
1632 hourglass if Emacs is busy. To disable this feature, set the variable
1633 @code{display-hourglass} to @code{nil}. The variable
1634 @code{hourglass-delay} determines the number of seconds of ``busy
1635 time'' before the hourglass is shown; the default is 1.
1636
1637 @vindex make-pointer-invisible
1638 If the mouse pointer lies inside an Emacs frame, Emacs makes it
1639 invisible each time you type a character to insert text, to prevent it
1640 from obscuring the text. (To be precise, the hiding occurs when you
1641 type a ``self-inserting'' character. @xref{Inserting Text}.) Moving
1642 the mouse pointer makes it visible again. To disable this feature,
1643 set the variable @code{make-pointer-invisible} to @code{nil}.
1644
1645 @vindex underline-minimum-offset
1646 @vindex x-underline-at-descent-line
1647 On graphical displays, the variable @code{underline-minimum-offset}
1648 determines the minimum distance between the baseline and underline, in
1649 pixels, for underlined text. By default, the value is 1; increasing
1650 it may improve the legibility of underlined text for certain fonts.
1651 (However, Emacs will never draw the underline below the current line
1652 area.) The variable @code{x-underline-at-descent-line} determines how
1653 to draw underlined text. The default is @code{nil}, which means to
1654 draw it at the baseline level of the font; if you change it to
1655 @code{nil}, Emacs draws the underline at the same height as the font's
1656 descent line.
1657
1658 @vindex overline-margin
1659 The variable @code{overline-margin} specifies the vertical position
1660 of an overline above the text, including the height of the overline
1661 itself, in pixels; the default is 2.
1662
1663 @findex tty-suppress-bold-inverse-default-colors
1664 On some text terminals, bold face and inverse video together result
1665 in text that is hard to read. Call the function
1666 @code{tty-suppress-bold-inverse-default-colors} with a non-@code{nil}
1667 argument to suppress the effect of bold-face in this case.