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