annotate man/display.texi @ 43425:943d6207cba5

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