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