annotate man/display.texi @ 37308:bcbc0628e2e5

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