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