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