]> code.delx.au - gnu-emacs/blob - man/display.texi
(Font Lock): Mention jit-lock and its customization group.
[gnu-emacs] / man / display.texi
1 @c This is part of the Emacs manual.
2 @c Copyright (C) 1985, 86, 87, 93, 94, 95, 1997, 2000, 2001
3 @c Free Software Foundation, Inc.
4 @c See file emacs.texi for copying conditions.
5 @node Display, Search, Registers, Top
6 @chapter Controlling the Display
7
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 commands
10 allow you to specify which part of the text you want to see, and how to
11 display it.
12
13 @menu
14 * Faces:: How to change the display style using faces.
15 * Font Lock:: Minor mode for syntactic highlighting using faces.
16 * Highlight Changes:: Using colors to show where you changed the buffer.
17 * Highlight Interactively:: Tell Emacs what text to highlight.
18 * Trailing Whitespace:: Showing possibly-spurious trailing whitespace.
19 * Scrolling:: Moving text up and down in a window.
20 * Horizontal Scrolling:: Moving text left and right in a window.
21 * Follow Mode:: Follow mode lets two windows scroll as one.
22 * Selective Display:: Hiding lines with lots of indentation.
23 * Optional Mode Line:: Optional mode line display features.
24 * Text Display:: How text characters are normally displayed.
25 * Display Custom:: Information on variables for customizing display.
26 * Cursor Display:: Features for displaying the cursor.
27 @end menu
28
29 @node Faces
30 @section Using Multiple Typefaces
31 @cindex faces
32
33 When using Emacs with a window system, you can set up multiple
34 styles of displaying characters. Each style is called a @dfn{face}.
35 Each face can specify various attributes, such as the height, weight
36 and slant of the characters, the foreground and background color, and
37 underlining. But it does not have to specify all of them.
38
39 Features which rely on text in multiple faces (such as Font Lock mode)
40 will also work on non-windowed terminals that can display more than one
41 face, whether by colors or underlining and emboldening. This includes
42 the console on GNU/Linux, an @code{xterm} which supports colors, the
43 MS-DOS display (@pxref{MS-DOS}), and the MS-Windows version invoked with
44 the @option{-nw} option. Emacs determines automatically whether the
45 terminal has this capability.
46
47 You control the appearance of a part of the text in the buffer by
48 specifying the face or faces to use for it. The style of display used
49 for any given character is determined by combining the attributes of
50 all the applicable faces specified for that character. Any attribute
51 that isn't specified by these faces is taken from the @code{default} face,
52 whose attributes reflect the default settings of the frame itself.
53
54 Enriched mode, the mode for editing formatted text, includes several
55 commands and menus for specifying faces for text in the buffer.
56 @xref{Format Faces}, for how to specify the font for text in the
57 buffer. @xref{Format Colors}, for how to specify the foreground and
58 background color.
59
60 @cindex face colors, setting
61 @findex set-face-foreground
62 @findex set-face-background
63 To alter the appearance of a face, use the customization buffer.
64 @xref{Face Customization}. You can also use X resources to specify
65 attributes of particular faces (@pxref{Resources}). Alternatively,
66 you can change the foreground and background colors of a specific face
67 with @kbd{M-x set-face-foreground} and @kbd{M-x set-face-background}.
68 These commands prompt in the minibuffer for a face name and a color
69 name, with completion, and then set that face to use the specified
70 color. Changing the colors of the @code{default} face also changes
71 the foreground and background colors on all frames, both existing and
72 those to be created in the future. (You can also set foreground and
73 background colors for the current frame only; see @ref{Frame
74 Parameters}.)
75
76 Emacs 21 can correctly display variable-width fonts, but Emacs
77 commands that calculate width and indentation do not know how to
78 calculate variable widths. This can sometimes lead to incorrect
79 results when you use variable-width fonts. In particular, indentation
80 commands can give inconsistent results, so we recommend you avoid
81 variable-width fonts for editing program source code. Filling will
82 sometimes make lines too long or too short. We plan to address these
83 issues in future Emacs versions.
84
85 @findex list-faces-display
86 To see what faces are currently defined, and what they look like, type
87 @kbd{M-x list-faces-display}. It's possible for a given face to look
88 different in different frames; this command shows the appearance in the
89 frame in which you type it. Here's a list of the standard defined
90 faces:
91
92 @table @code
93 @item default
94 This face is used for ordinary text that doesn't specify any other face.
95 @item mode-line
96 This face is used for mode lines. By default, it's drawn with shadows
97 for a ``raised'' effect on window systems, and drawn as the inverse of
98 the default face on non-windowed terminals. @xref{Display Custom}.
99 @item header-line
100 Similar to @code{mode-line} for a window's header line. Most modes
101 don't use the header line, but the Info mode does.
102 @item highlight
103 This face is used for highlighting portions of text, in various modes.
104 For example, mouse-sensitive text is highlighted using this face.
105 @item isearch
106 This face is used for highlighting Isearch matches.
107 @item isearch-lazy-highlight-face
108 This face is used for lazy highlighting of Isearch matches other than
109 the current one.
110 @item region
111 This face is used for displaying a selected region (when Transient Mark
112 mode is enabled---see below).
113 @item secondary-selection
114 This face is used for displaying a secondary X selection (@pxref{Secondary
115 Selection}).
116 @item bold
117 This face uses a bold variant of the default font, if it has one.
118 @item italic
119 This face uses an italic variant of the default font, if it has one.
120 @item bold-italic
121 This face uses a bold italic variant of the default font, if it has one.
122 @item underline
123 This face underlines text.
124 @item fixed-pitch
125 The basic fixed-pitch face.
126 @item fringe
127 @cindex fringe
128 The face for the fringes to the left and right of windows on graphic
129 displays. (The fringes are the narrow portions of the Emacs frame
130 between the text area and the window's right and left borders.)
131 @item scroll-bar
132 This face determines the visual appearance of the scroll bar.
133 @item border
134 This face determines the color of the frame border.
135 @item cursor
136 This face determines the color of the cursor.
137 @item mouse
138 This face determines the color of the mouse pointer.
139 @item tool-bar
140 This is the basic tool-bar face. No text appears in the tool bar, but the
141 colors of this face affect the appearance of tool bar icons.
142 @item tooltip
143 This face is used for tooltips.
144 @item menu
145 This face determines the colors and font of Emacs's menus. Setting the
146 font of LessTif/Motif menus is currently not supported; attempts to set
147 the font are ignored in this case.
148 @item trailing-whitespace
149 The face for highlighting trailing whitespace when
150 @code{show-trailing-whitespace} is non-nil; see @ref{Trailing Whitespace}.
151 @item variable-pitch
152 The basic variable-pitch face.
153 @end table
154
155 @cindex @code{region} face
156 When Transient Mark mode is enabled, the text of the region is
157 highlighted when the mark is active. This uses the face named
158 @code{region}; you can control the style of highlighting by changing the
159 style of this face (@pxref{Face Customization}). @xref{Transient Mark},
160 for more information about Transient Mark mode and activation and
161 deactivation of the mark.
162
163 One easy way to use faces is to turn on Font Lock mode. This minor
164 mode, which is always local to a particular buffer, arranges to
165 choose faces according to the syntax of the text you are editing. It
166 can recognize comments and strings in most languages; in several
167 languages, it can also recognize and properly highlight various other
168 important constructs. @xref{Font Lock}, for more information about
169 Font Lock mode and syntactic highlighting.
170
171 You can print out the buffer with the highlighting that appears
172 on your screen using the command @code{ps-print-buffer-with-faces}.
173 @xref{PostScript}.
174
175 @node Font Lock
176 @section Font Lock mode
177 @cindex Font Lock mode
178 @cindex mode, Font Lock
179 @cindex syntax highlighting and coloring
180
181 Font Lock mode is a minor mode, always local to a particular
182 buffer, which highlights (or ``fontifies'') using various faces
183 according to the syntax of the text you are editing. It can
184 recognize comments and strings in most languages; in several
185 languages, it can also recognize and properly highlight various other
186 important constructs---for example, names of functions being defined
187 or reserved keywords.
188
189 @findex font-lock-mode
190 @findex turn-on-font-lock
191 The command @kbd{M-x font-lock-mode} turns Font Lock mode on or off
192 according to the argument, and toggles the mode when it has no argument.
193 The function @code{turn-on-font-lock} unconditionally enables Font Lock
194 mode. This is useful in mode-hook functions. For example, to enable
195 Font Lock mode whenever you edit a C file, you can do this:
196
197 @example
198 (add-hook 'c-mode-hook 'turn-on-font-lock)
199 @end example
200
201 @findex global-font-lock-mode
202 @vindex global-font-lock-mode
203 To turn on Font Lock mode automatically in all modes which support
204 it, customize the user option @code{global-font-lock-mode} or use the
205 function @code{global-font-lock-mode} in your @file{.emacs} file, like
206 this:
207
208 @example
209 (global-font-lock-mode 1)
210 @end example
211
212 Font Lock mode uses several specifically named faces to do its job,
213 including @code{font-lock-string-face}, @code{font-lock-comment-face},
214 and others. The easiest way to find them all is to use completion
215 on the face name in @code{set-face-foreground}.
216
217 To change the colors or the fonts used by Font Lock mode to fontify
218 different parts of text, just change these faces. There are
219 two ways to do it:
220
221 @itemize @bullet
222 @item
223 Invoke @kbd{M-x set-face-foreground} or @kbd{M-x set-face-background}
224 to change the colors of a particular face used by Font Lock.
225 @xref{Faces}. The command @kbd{M-x list-faces-display} displays all
226 the faces currently known to Emacs, including those used by Font Lock.
227
228 @item
229 Customize the faces interactively with @kbd{M-x customize-face}, as
230 described in @ref{Face Customization}.
231 @end itemize
232
233 To get the full benefit of Font Lock mode, you need to choose a
234 default font which has bold, italic, and bold-italic variants; or else
235 you need to have a color or gray-scale screen.
236
237 @vindex font-lock-maximum-decoration
238 The variable @code{font-lock-maximum-decoration} specifies the
239 preferred level of fontification, for modes that provide multiple
240 levels. Level 1 is the least amount of fontification; some modes
241 support levels as high as 3. The normal default is ``as high as
242 possible.'' You can specify an integer, which applies to all modes, or
243 you can specify different numbers for particular major modes; for
244 example, to use level 1 for C/C++ modes, and the default level
245 otherwise, use this:
246
247 @example
248 (setq font-lock-maximum-decoration
249 '((c-mode . 1) (c++-mode . 1)))
250 @end example
251
252 @vindex font-lock-maximum-size
253 Fontification can be too slow for large buffers, so you can suppress
254 it. The variable @code{font-lock-maximum-size} specifies a buffer size,
255 beyond which buffer fontification is suppressed.
256
257 @c @w is used below to prevent a bad page-break.
258 @vindex font-lock-beginning-of-syntax-function
259 @cindex incorrect fontification
260 @cindex parenthesis in column zero and fontification
261 @cindex brace in column zero and fontification
262 Comment and string fontification (or ``syntactic'' fontification)
263 relies on analysis of the syntactic structure of the buffer text. For
264 the sake of speed, some modes, including C mode and Lisp mode,
265 rely on a special convention: an open-parenthesis or open-brace in the
266 leftmost column always defines the @w{beginning} of a defun, and is
267 thus always outside any string or comment. (@xref{Left Margin
268 Paren}.) If you don't follow this convention, Font Lock mode can
269 misfontify the text that follows an open-parenthesis or open-brace in
270 the leftmost column that is inside a string or comment.
271
272 @cindex slow display during scrolling
273 The variable @code{font-lock-beginning-of-syntax-function} (always
274 buffer-local) specifies how Font Lock mode can find a position
275 guaranteed to be outside any comment or string. In modes which use the
276 leftmost column parenthesis convention, the default value of the variable
277 is @code{beginning-of-defun}---that tells Font Lock mode to use the
278 convention. If you set this variable to @code{nil}, Font Lock no longer
279 relies on the convention. This avoids incorrect results, but the price
280 is that, in some cases, fontification for a changed text must rescan
281 buffer text from the beginning of the buffer. This can considerably
282 slow down redisplay while scrolling, particularly if you are close to
283 the end of a large buffer.
284
285 @findex font-lock-add-keywords
286 Font Lock highlighting patterns already exist for many modes, but you
287 may want to fontify additional patterns. You can use the function
288 @code{font-lock-add-keywords}, to add your own highlighting patterns for
289 a particular mode. For example, to highlight @samp{FIXME:} words in C
290 comments, use this:
291
292 @example
293 (font-lock-add-keywords
294 'c-mode
295 '(("\\<\\(FIXME\\):" 1 font-lock-warning-face t)))
296 @end example
297
298 @findex font-lock-remove-keywords
299 To remove keywords from the font-lock highlighting patterns, use the
300 function @code{font-lock-remove-keywords}.
301
302 @cindex just-in-time (JIT) font-lock
303 @cindex background syntax highlighting
304 Fontifying large buffers can take a long time. To avoid large
305 delays when a file is visited, Emacs fontifies only the visible
306 portion of a buffer. As you scroll through the buffer, each portion
307 that becomes visible is fontified as soon as it is displayed. The
308 parts of the buffer that are not displayed are fontified
309 ``stealthily'', in the background, i.e.@: when Emacs is idle. You can
310 control this background fontification, called @dfn{Just-In-Time}, or
311 @dfn{JIT} Font Lock, by customizing various options in the
312 customization group @samp{jit-lock}. @xref{Specific Customization}.
313
314 @node Highlight Changes
315 @section Highlight Changes Mode
316
317 @findex highlight-changes-mode
318 Use @kbd{M-x highlight-changes-mode} to enable a minor mode
319 that uses faces (colors, typically) to indicate which parts of
320 the buffer were changed most recently.
321
322 @node Highlight Interactively
323 @section Interactive Highlighting by Matching
324 @cindex highlighting by matching
325 @cindex interactive highlighting
326
327 It is sometimes useful to highlight the strings that match a certain
328 regular expression. For example, you might wish to see all the
329 references to a certain variable in a program source file, or highlight
330 certain parts in a voluminous output of some program, or make certain
331 cliches stand out in an article.
332
333 @findex hi-lock-mode
334 Use the @kbd{M-x hi-lock-mode} command to turn on a minor mode that
335 allows you to specify regular expressions of the text to be
336 highlighted. Hi-lock mode works like Font Lock (@pxref{Font Lock}),
337 except that it lets you specify explicitly what parts of text to
338 highlight. You control Hi-lock mode with these commands:
339
340 @table @kbd
341 @item C-x w h @var{regexp} @key{RET} @var{face} @key{RET}
342 @kindex C-x w h
343 @findex highlight-regexp
344 Highlight text that matches
345 @var{regexp} using face @var{face} (@code{highlight-regexp}).
346 By using this command more than once, you can highlight various
347 parts of the text in different ways.
348
349 @item C-x w r @var{regexp} @key{RET}
350 @kindex C-x w r
351 @findex unhighlight-regexp
352 Unhighlight @var{regexp} (@code{unhighlight-regexp}). You must enter
353 one of the regular expressions currently specified for highlighting.
354 (You can use completion, or choose from a menu, to enter one of them
355 conveniently.)
356
357 @item C-x w l @var{regexp} @key{RET} @var{face} @key{RET}
358 @kindex C-x w l
359 @findex highlight-lines-matching-regexp
360 @cindex lines, highlighting
361 @cindex highlighting lines of text
362 Highlight entire lines containing a match for @var{regexp}, using face
363 @var{face} (@code{highlight-lines-matching-regexp}).
364
365 @item C-x w b
366 @kindex C-x w b
367 @findex hi-lock-write-interactive-patterns
368 Insert all the current highlighting regexp/face pairs into the buffer
369 at point, with comment delimiters to prevent them from changing your
370 program. This key binding runs the
371 @code{hi-lock-write-interactive-patterns} command.
372
373 These patterns will be read the next time you visit the file while
374 Hi-lock mode is enabled, or whenever you use the @kbd{M-x
375 hi-lock-find-patterns} command.
376
377 @item C-x w i
378 @kindex C-x w i
379 @findex hi-lock-find-patterns
380 @vindex hi-lock-exclude-modes
381 Re-read regexp/face pairs in the current buffer
382 (@code{hi-lock-write-interactive-patterns}). The list of pairs is
383 found no matter where in the buffer it may be.
384
385 This command does nothing if the major mode is a member of the list
386 @code{hi-lock-exclude-modes}.
387 @end table
388
389 @node Trailing Whitespace
390 @section Trailing Whitespace
391
392 @cindex trailing whitespace
393 @cindex whitespace, trailing
394 @vindex show-trailing-whitespace
395 It is easy to leave unnecessary spaces at the end of a line without
396 realizing it. In most cases, this @dfn{trailing whitespace} has no
397 effect, but there are special circumstances where it matters.
398
399 You can make trailing whitespace visible on the screen by setting the
400 buffer-local variable @code{show-trailing-whitespace} to @code{t}. Then
401 Emacs displays trailing whitespace in the face
402 @code{trailing-whitespace}.
403
404 Trailing whitespace is defined as spaces or tabs at the end of a
405 line. But trailing whitespace is not displayed specially if point is
406 at the end of the line containing the whitespace. (Doing that looks
407 ugly while you are typing in new text, and the location of point is
408 enough in that case to show you that the spaces are present.)
409
410 @findex delete-trailing-whitespace
411 To delete all trailing whitespace within the current buffer's
412 restriction (@pxref{Narrowing}), type @kbd{M-x
413 delete-trailing-whitespace @key{RET}}. (This command does not remove
414 the form-feed characters.)
415
416 @vindex indicate-empty-lines
417 @vindex default-indicate-empty-lines
418 @cindex empty lines
419 Emacs can indicate empty lines at the end of the buffer with a
420 special bitmap on the left fringe of the window. To enable this
421 feature, set the buffer-local variable @code{indicate-empty-lines} to
422 a non-@code{nil} value. The default value of this variable is
423 controlled by the variable @code{default-indicate-empty-lines};
424 by setting that variable, you can enable or disable this feature
425 for all new buffers.
426
427 @node Scrolling
428 @section Scrolling
429
430 If a buffer contains text that is too large to fit entirely within a
431 window that is displaying the buffer, Emacs shows a contiguous portion of
432 the text. The portion shown always contains point.
433
434 @cindex scrolling
435 @dfn{Scrolling} means moving text up or down in the window so that
436 different parts of the text are visible. Scrolling forward means that text
437 moves up, and new text appears at the bottom. Scrolling backward moves
438 text down and new text appears at the top.
439
440 Scrolling happens automatically if you move point past the bottom or top
441 of the window. You can also explicitly request scrolling with the commands
442 in this section.
443
444 @table @kbd
445 @item C-l
446 Clear screen and redisplay, scrolling the selected window to center
447 point vertically within it (@code{recenter}).
448 @item C-v
449 Scroll forward (a windowful or a specified number of lines) (@code{scroll-up}).
450 @item @key{NEXT}
451 @itemx @key{PAGEDOWN}
452 Likewise, scroll forward.
453 @item M-v
454 Scroll backward (@code{scroll-down}).
455 @item @key{PRIOR}
456 @itemx @key{PAGEUP}
457 Likewise, scroll backward.
458 @item @var{arg} C-l
459 Scroll so point is on line @var{arg} (@code{recenter}).
460 @item C-M-l
461 Scroll heuristically to bring useful information onto the screen
462 (@code{reposition-window}).
463 @end table
464
465 @kindex C-l
466 @findex recenter
467 The most basic scrolling command is @kbd{C-l} (@code{recenter}) with
468 no argument. It clears the entire screen and redisplays all windows.
469 In addition, it scrolls the selected window so that point is halfway
470 down from the top of the window.
471
472 @kindex C-v
473 @kindex M-v
474 @kindex NEXT
475 @kindex PRIOR
476 @kindex PAGEDOWN
477 @kindex PAGEUP
478 @findex scroll-up
479 @findex scroll-down
480 @vindex next-screen-context-lines
481 To read the buffer a windowful at a time, use @kbd{C-v}
482 (@code{scroll-up}) with no argument. This scrolls forward by nearly
483 the whole window height. The effect is to take the two lines at the
484 bottom of the window and put them at the top, followed by nearly a
485 whole windowful of lines that were not previously visible. If point
486 was in the text that scrolled off the top, it ends up at the new top
487 of the window.
488
489 @kbd{M-v} (@code{scroll-down}) with no argument scrolls backward in
490 a similar way, also with overlap. The number of lines of overlap
491 across a @kbd{C-v} or @kbd{M-v} is controlled by the variable
492 @code{next-screen-context-lines}; by default, it is 2. The function
493 keys @key{NEXT} and @key{PRIOR}, or @key{PAGEDOWN} and @key{PAGEUP},
494 are equivalent to @kbd{C-v} and @kbd{M-v}.
495
496 The commands @kbd{C-v} and @kbd{M-v} with a numeric argument scroll
497 the text in the selected window up or down a few lines. @kbd{C-v}
498 with an argument moves the text and point up, together, that many
499 lines; it brings the same number of new lines into view at the bottom
500 of the window. @kbd{M-v} with numeric argument scrolls the text
501 downward, bringing that many new lines into view at the top of the
502 window. @kbd{C-v} with a negative argument is like @kbd{M-v} and vice
503 versa.
504
505 The names of scroll commands are based on the direction that the
506 text moves in the window. Thus, the command to scroll forward is
507 called @code{scroll-up} because it moves the text upward on the
508 screen. The keys @key{PAGEDOWN} and @key{PAGEUP} derive their names
509 and customary meanings from a different convention that developed
510 elsewhere; hence the strange result that @key{PAGEDOWN} runs
511 @code{scroll-up}.
512
513 @vindex scroll-preserve-screen-position
514 Some users like the full-screen scroll commands to keep point at the
515 same screen line. To enable this behavior, set the variable
516 @code{scroll-preserve-screen-position} to a non-@code{nil} value. This
517 mode is convenient for browsing through a file by scrolling by
518 screenfuls; if you come back to the screen where you started, point goes
519 back to the line where it started. However, this mode is inconvenient
520 when you move to the next screen in order to move point to the text
521 there.
522
523 Another way to do scrolling is with @kbd{C-l} with a numeric argument.
524 @kbd{C-l} does not clear the screen when given an argument; it only scrolls
525 the selected window. With a positive argument @var{n}, it repositions text
526 to put point @var{n} lines down from the top. An argument of zero puts
527 point on the very top line. Point does not move with respect to the text;
528 rather, the text and point move rigidly on the screen. @kbd{C-l} with a
529 negative argument puts point that many lines from the bottom of the window.
530 For example, @kbd{C-u - 1 C-l} puts point on the bottom line, and @kbd{C-u
531 - 5 C-l} puts it five lines from the bottom. @kbd{C-u C-l} scrolls to put
532 point at the center (vertically) of the selected window.
533
534 @kindex C-M-l
535 @findex reposition-window
536 The @kbd{C-M-l} command (@code{reposition-window}) scrolls the current
537 window heuristically in a way designed to get useful information onto
538 the screen. For example, in a Lisp file, this command tries to get the
539 entire current defun onto the screen if possible.
540
541 @vindex scroll-conservatively
542 Scrolling happens automatically when point moves out of the visible
543 portion of the text. Normally, automatic scrolling centers point
544 vertically within the window. However, if you set
545 @code{scroll-conservatively} to a small number @var{n}, then if you
546 move point just a little off the screen---less than @var{n}
547 lines---then Emacs scrolls the text just far enough to bring point
548 back on screen. By default, @code{scroll-conservatively} is 0.
549
550 @cindex aggressive scrolling
551 @vindex scroll-up-aggressively
552 @vindex scroll-down-aggressively
553 When the window does scroll by a longer distance, you can control
554 how aggressively it scrolls, by setting the variables
555 @code{scroll-up-aggressively} and @code{scroll-down-aggressively}.
556 The value of @code{scroll-up-aggressively} should be either
557 @code{nil}, or a fraction @var{f} between 0 and 1. A fraction
558 specifies where on the screen to put point when scrolling upward.
559 More precisely, when a window scrolls up because point is above the
560 window start, the new start position is chosen to put point @var{f}
561 part of the window height from the top. The larger @var{f}, the more
562 aggressive the scrolling.
563
564 @code{nil}, which is the default, scrolls to put point at the center.
565 So it is equivalent to .5.
566
567 Likewise, @code{scroll-down-aggressively} is used for scrolling
568 down. The value, @var{f}, specifies how far point should be placed
569 from the bottom of the window; thus, as with
570 @code{scroll-up-aggressively}, a larger value is more aggressive.
571
572 @vindex scroll-margin
573 The variable @code{scroll-margin} restricts how close point can come
574 to the top or bottom of a window. Its value is a number of screen
575 lines; if point comes within that many lines of the top or bottom of the
576 window, Emacs recenters the window. By default, @code{scroll-margin} is
577 0.
578
579 @node Horizontal Scrolling
580 @section Horizontal Scrolling
581 @cindex horizontal scrolling
582
583 @dfn{Horizontal scrolling} means shifting all the lines sideways
584 within a window---so that some of the text near the left margin is not
585 displayed at all. Emacs does this automatically in any window that
586 uses line truncation rather than continuation: whenever point moves
587 off the left or right edge of the screen, Emacs scrolls the buffer
588 horizontally to make point visible.
589
590 When a window has been scrolled horizontally, text lines are truncated
591 rather than continued (@pxref{Continuation Lines}), with a @samp{$}
592 appearing in the first column when there is text truncated to the left,
593 and in the last column when there is text truncated to the right.
594
595 You can use these commands to do explicit horizontal scrolling.
596
597 @table @kbd
598 @item C-x <
599 Scroll text in current window to the left (@code{scroll-left}).
600 @item C-x >
601 Scroll to the right (@code{scroll-right}).
602 @end table
603
604 @kindex C-x <
605 @kindex C-x >
606 @findex scroll-left
607 @findex scroll-right
608 The command @kbd{C-x <} (@code{scroll-left}) scrolls the selected
609 window to the left by @var{n} columns with argument @var{n}. This moves
610 part of the beginning of each line off the left edge of the window.
611 With no argument, it scrolls by almost the full width of the window (two
612 columns less, to be precise).
613
614 @kbd{C-x >} (@code{scroll-right}) scrolls similarly to the right. The
615 window cannot be scrolled any farther to the right once it is displayed
616 normally (with each line starting at the window's left margin);
617 attempting to do so has no effect. This means that you don't have to
618 calculate the argument precisely for @w{@kbd{C-x >}}; any sufficiently large
619 argument will restore the normal display.
620
621 If you scroll a window horizontally by hand, that sets a lower bound
622 for automatic horizontal scrolling. Automatic scrolling will continue
623 to scroll the window, but never farther to the right than the amount
624 you previously set by @code{scroll-left}.
625
626 @vindex automatic-hscrolling
627 To disable automatic horizontal scrolling, set the variable
628 @code{automatic-hscrolling} to @code{nil}.
629
630 @node Follow Mode
631 @section Follow Mode
632 @cindex Follow mode
633 @cindex mode, Follow
634 @findex follow-mode
635 @cindex windows, synchronizing
636 @cindex synchronizing windows
637
638 @dfn{Follow mode} is a minor mode that makes two windows showing the
639 same buffer scroll as one tall ``virtual window.'' To use Follow mode,
640 go to a frame with just one window, split it into two side-by-side
641 windows using @kbd{C-x 3}, and then type @kbd{M-x follow-mode}. From
642 then on, you can edit the buffer in either of the two windows, or scroll
643 either one; the other window follows it.
644
645 In Follow mode, if you move point outside the portion visible in one
646 window and into the portion visible in the other window, that selects
647 the other window---again, treating the two as if they were parts of
648 one large window.
649
650 To turn off Follow mode, type @kbd{M-x follow-mode} a second time.
651
652 @node Selective Display
653 @section Selective Display
654 @cindex selective display
655 @findex set-selective-display
656 @kindex C-x $
657
658 Emacs has the ability to hide lines indented more than a certain number
659 of columns (you specify how many columns). You can use this to get an
660 overview of a part of a program.
661
662 To hide lines, type @kbd{C-x $} (@code{set-selective-display}) with a
663 numeric argument @var{n}. Then lines with at least @var{n} columns of
664 indentation disappear from the screen. The only indication of their
665 presence is that three dots (@samp{@dots{}}) appear at the end of each
666 visible line that is followed by one or more hidden ones.
667
668 The commands @kbd{C-n} and @kbd{C-p} move across the hidden lines as
669 if they were not there.
670
671 The hidden lines are still present in the buffer, and most editing
672 commands see them as usual, so you may find point in the middle of the
673 hidden text. When this happens, the cursor appears at the end of the
674 previous line, after the three dots. If point is at the end of the
675 visible line, before the newline that ends it, the cursor appears before
676 the three dots.
677
678 To make all lines visible again, type @kbd{C-x $} with no argument.
679
680 @vindex selective-display-ellipses
681 If you set the variable @code{selective-display-ellipses} to
682 @code{nil}, the three dots do not appear at the end of a line that
683 precedes hidden lines. Then there is no visible indication of the
684 hidden lines. This variable becomes local automatically when set.
685
686 @node Optional Mode Line
687 @section Optional Mode Line Features
688
689 @cindex line number display
690 @cindex display of line number
691 @findex line-number-mode
692 The current line number of point appears in the mode line when Line
693 Number mode is enabled. Use the command @kbd{M-x line-number-mode} to
694 turn this mode on and off; normally it is on. The line number appears
695 before the buffer percentage @var{pos}, with the letter @samp{L} to
696 indicate what it is. @xref{Minor Modes}, for more information about
697 minor modes and about how to use this command.
698
699 @cindex narrowing, and line number display
700 If you have narrowed the buffer (@pxref{Narrowing}), the displayed
701 line number is relative to the accessible portion of the buffer.
702
703 @vindex line-number-display-limit
704 If the buffer is very large (larger than the value of
705 @code{line-number-display-limit}), then the line number doesn't appear.
706 Emacs doesn't compute the line number when the buffer is large, because
707 that would be too slow. Set it to @code{nil} to remove the limit.
708
709 @vindex line-number-display-limit-width
710 Line-number computation can also be slow if the lines in the buffer
711 are too long. For this reason, Emacs normally doesn't display line
712 numbers if the average width, in characters, of lines near point is
713 larger than the value of the variable
714 @code{line-number-display-limit-width}. The default value is 200
715 characters.
716
717 @cindex Column Number mode
718 @cindex mode, Column Number
719 @findex column-number-mode
720 You can also display the current column number by turning on Column
721 Number mode. It displays the current column number preceded by the
722 letter @samp{C}. Type @kbd{M-x column-number-mode} to toggle this mode.
723
724 @findex display-time
725 @cindex time (on mode line)
726 Emacs can optionally display the time and system load in all mode
727 lines. To enable this feature, type @kbd{M-x display-time} or customize
728 the option @code{display-time-mode}. The information added to the mode
729 line usually appears after the buffer name, before the mode names and
730 their parentheses. It looks like this:
731
732 @example
733 @var{hh}:@var{mm}pm @var{l.ll}
734 @end example
735
736 @noindent
737 @vindex display-time-24hr-format
738 Here @var{hh} and @var{mm} are the hour and minute, followed always by
739 @samp{am} or @samp{pm}. @var{l.ll} is the average number of running
740 processes in the whole system recently. (Some fields may be missing if
741 your operating system cannot support them.) If you prefer time display
742 in 24-hour format, set the variable @code{display-time-24hr-format}
743 to @code{t}.
744
745 @cindex mail (on mode line)
746 @vindex display-time-use-mail-icon
747 @vindex display-time-mail-face
748 The word @samp{Mail} appears after the load level if there is mail
749 for you that you have not read yet. On a graphical display you can use
750 an icon instead of @samp{Mail} by customizing
751 @code{display-time-use-mail-icon}; this may save some space on the mode
752 line. You can customize @code{display-time-mail-face} to make the mail
753 indicator prominent.
754
755 @cindex mode line, 3D appearance
756 @cindex attributes of mode line, changing
757 @cindex non-integral number of lines in a window
758 By default, the mode line is drawn on graphics displays with
759 3D-style highlighting, like that of a button when it is not being
760 pressed. If you don't like this effect, you can disable the 3D
761 highlighting of the mode line, by customizing the attributes of the
762 @code{mode-line} face in your @file{.emacs} init file, like this:
763
764 @example
765 (set-face-attribute 'mode-line nil :box nil)
766 @end example
767
768 @noindent
769 Alternatively, you can turn off the box attribute in your
770 @file{.Xdefaults} file:
771
772 @example
773 Emacs.mode-line.AttributeBox: off
774 @end example
775
776 @node Text Display
777 @section How Text Is Displayed
778 @cindex characters (in text)
779
780 ASCII printing characters (octal codes 040 through 0176) in Emacs
781 buffers are displayed with their graphics, as are non-ASCII multibyte
782 printing characters (octal codes above 0400).
783
784 Some ASCII control characters are displayed in special ways. The
785 newline character (octal code 012) is displayed by starting a new line.
786 The tab character (octal code 011) is displayed by moving to the next
787 tab stop column (normally every 8 columns).
788
789 Other ASCII control characters are normally displayed as a caret
790 (@samp{^}) followed by the non-control version of the character; thus,
791 control-A is displayed as @samp{^A}.
792
793 Non-ASCII characters 0200 through 0237 (octal) are displayed with
794 octal escape sequences; thus, character code 0230 (octal) is displayed
795 as @samp{\230}. The display of character codes 0240 through 0377
796 (octal) may be either as escape sequences or as graphics. They do not
797 normally occur in multibyte buffers, but if they do, they are displayed
798 as Latin-1 graphics. In unibyte mode, if you enable European display
799 they are displayed using their graphics (assuming your terminal supports
800 them), otherwise as escape sequences. @xref{Single-Byte Character
801 Support}.
802
803 @node Display Custom
804 @section Customization of Display
805
806 This section contains information for customization only. Beginning
807 users should skip it.
808
809 @vindex mode-line-inverse-video
810 The variable @code{mode-line-inverse-video} is an obsolete way of
811 controlling whether the mode line is displayed in inverse video; the
812 preferred way of doing this is to change the @code{mode-line} face.
813 @xref{Mode Line}. However, if @code{mode-line-inverse-video} has a
814 value of @code{nil}, then the @code{mode-line} face will be ignored,
815 and mode-lines will be drawn using the default text face.
816 @xref{Faces}.
817
818 @vindex inverse-video
819 If the variable @code{inverse-video} is non-@code{nil}, Emacs attempts
820 to invert all the lines of the display from what they normally are.
821
822 @vindex visible-bell
823 If the variable @code{visible-bell} is non-@code{nil}, Emacs attempts
824 to make the whole screen blink when it would normally make an audible bell
825 sound. This variable has no effect if your terminal does not have a way
826 to make the screen blink.@refill
827
828 @vindex no-redraw-on-reenter
829 When you reenter Emacs after suspending, Emacs normally clears the
830 screen and redraws the entire display. On some terminals with more than
831 one page of memory, it is possible to arrange the termcap entry so that
832 the @samp{ti} and @samp{te} strings (output to the terminal when Emacs
833 is entered and exited, respectively) switch between pages of memory so
834 as to use one page for Emacs and another page for other output. Then
835 you might want to set the variable @code{no-redraw-on-reenter}
836 non-@code{nil}; this tells Emacs to assume, when resumed, that the
837 screen page it is using still contains what Emacs last wrote there.
838
839 @vindex echo-keystrokes
840 The variable @code{echo-keystrokes} controls the echoing of multi-character
841 keys; its value is the number of seconds of pause required to cause echoing
842 to start, or zero meaning don't echo at all. @xref{Echo Area}.
843
844 @vindex ctl-arrow
845 If the variable @code{ctl-arrow} is @code{nil}, all control characters in
846 the buffer are displayed with octal escape sequences, except for newline
847 and tab. Altering the value of @code{ctl-arrow} makes it local to the
848 current buffer; until that time, the default value is in effect. The
849 default is initially @code{t}. @xref{Display Tables,, Display Tables,
850 elisp, The Emacs Lisp Reference Manual}.
851
852 @vindex tab-width
853 Normally, a tab character in the buffer is displayed as whitespace which
854 extends to the next display tab stop position, and display tab stops come
855 at intervals equal to eight spaces. The number of spaces per tab is
856 controlled by the variable @code{tab-width}, which is made local by
857 changing it, just like @code{ctl-arrow}. Note that how the tab character
858 in the buffer is displayed has nothing to do with the definition of
859 @key{TAB} as a command. The variable @code{tab-width} must have an
860 integer value between 1 and 1000, inclusive.
861
862 @c @vindex truncate-lines @c No index entry here, because we have one
863 @c in the continuation section.
864 If the variable @code{truncate-lines} is non-@code{nil}, then each
865 line of text gets just one screen line for display; if the text line is
866 too long, display shows only the part that fits. If
867 @code{truncate-lines} is @code{nil}, then long text lines display as
868 more than one screen line, enough to show the whole text of the line.
869 @xref{Continuation Lines}. Altering the value of @code{truncate-lines}
870 makes it local to the current buffer; until that time, the default value
871 is in effect. The default is initially @code{nil}.
872
873 @c @vindex truncate-partial-width-windows @c Idx entry is in Split Windows.
874 If the variable @code{truncate-partial-width-windows} is
875 non-@code{nil}, it forces truncation rather than continuation in any
876 window less than the full width of the screen or frame, regardless of
877 the value of @code{truncate-lines}. For information about side-by-side
878 windows, see @ref{Split Window}. See also @ref{Display,, Display,
879 elisp, The Emacs Lisp Reference Manual}.
880
881 @vindex baud-rate
882 The variable @code{baud-rate} holds the output speed of the
883 terminal, as far as Emacs knows. Setting this variable does not
884 change the speed of actual data transmission, but the value is used
885 for calculations. On terminals, it affects padding, and decisions
886 about whether to scroll part of the screen or redraw it instead.
887 It also affects the behavior of incremental search.
888
889 On window-systems, @code{baud-rate} is only used to determine how
890 frequently to look for pending input during display updating. A
891 higher value of @code{baud-rate} means that check for pending input
892 will be done less frequently.
893
894 You can customize the way any particular character code is displayed
895 by means of a display table. @xref{Display Tables,, Display Tables,
896 elisp, The Emacs Lisp Reference Manual}.
897
898 @cindex hourglass pointer display
899 @vindex hourglass-delay
900 On a window system, Emacs can optionally display the mouse pointer
901 in a special shape to say that Emacs is busy. To turn this feature on
902 or off, customize the group @code{cursor}. You can also control the
903 amount of time Emacs must remain busy before the busy indicator is
904 displayed, by setting the variable @code{hourglass-delay}.
905
906 @findex tty-suppress-bold-inverse-default-colors
907 On some text-only terminals, bold face and inverse video together
908 result in text that is hard to read. Call the function
909 @code{tty-suppress-bold-inverse-default-colors} with a non-@code{nil}
910 argument to suppress the effect of bold-face in this case.
911
912 @node Cursor Display
913 @section Displaying the Cursor
914
915 @findex hl-line-mode
916 @cindex highlight current line
917 @findex blink-cursor-mode
918 @cindex cursor, locating visually
919 @cindex cursor, blinking
920 There are a number of ways to customize the display of the cursor.
921 @kbd{M-x hl-line-mode} enables or disables a minor mode which
922 highlights the line containing point. On window systems, the command
923 @kbd{M-x blink-cursor-mode} turns on or off the blinking of the
924 cursor. (On terminals, the terminal itself blinks the cursor, and
925 Emacs has no control over it.)
926
927 You can customize the cursor's color, and whether it blinks, using
928 the @code{cursor} Custom group (@pxref{Easy Customization}).
929
930 @vindex x-stretch-cursor
931 @cindex wide block cursor
932 When displaying on a window system, Emacs can optionally draw the
933 block cursor as wide as the character under the cursor---for example,
934 if the cursor is on a tab character, it would cover the full width
935 occupied by that tab character. To enable this feature, set the
936 variable @code{x-stretch-cursor} to a non-@code{nil} value.
937
938 @cindex cursor in non-selected windows
939 @vindex cursor-in-non-selected-windows
940 Normally, the cursor in non-selected windows is shown as a hollow box.
941 To turn off cursor display in non-selected windows, customize the option
942 @code{cursor-in-non-selected-windows} to assign it a @code{nil} value.