annotate man/display.texi @ 63354:2fb5b66e31bf

*** empty log message ***
author Lute Kamstra <lute@gnu.org>
date Sun, 12 Jun 2005 23:46:50 +0000
parents c7fbb48387a4
children 4c33b0ac74a3 173dee4e2611
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.
47071
695d2a421704 @cindex{...} -> @code{...}
Miles Bader <miles@gnu.org>
parents: 47064
diff changeset
2 @c Copyright (C) 1985, 86, 87, 93, 94, 95, 1997, 2000, 2001, 2002
36554
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.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
18 * Scrolling:: Moving text up and down in a window.
Dave Love <fx@gnu.org>
parents:
diff changeset
19 * Horizontal Scrolling:: Moving text left and right in a window.
45877
74f67ed375f0 Rename Trailing Whitespace to Useless Whitespace
Richard M. Stallman <rms@gnu.org>
parents: 43664
diff changeset
20 * Fringes:: Enabling or disabling window fringes.
74f67ed375f0 Rename Trailing Whitespace to Useless Whitespace
Richard M. Stallman <rms@gnu.org>
parents: 43664
diff changeset
21 * Useless Whitespace:: Showing possibly-spurious trailing whitespace.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
22 * Follow Mode:: Follow mode lets two windows scroll as one.
Dave Love <fx@gnu.org>
parents:
diff changeset
23 * Selective Display:: Hiding lines with lots of indentation.
Dave Love <fx@gnu.org>
parents:
diff changeset
24 * Optional Mode Line:: Optional mode line display features.
Dave Love <fx@gnu.org>
parents:
diff changeset
25 * Text Display:: How text characters are normally displayed.
60104
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
26 * Cursor Display:: Features for displaying the cursor.
36150
46e59561af4c Display Vars node renamed Display Custom.
Richard M. Stallman <rms@gnu.org>
parents: 35433
diff changeset
27 * Display Custom:: Information on variables for customizing display.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
28 @end menu
Dave Love <fx@gnu.org>
parents:
diff changeset
29
36554
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
30 @node Faces
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
31 @section Using Multiple Typefaces
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
32 @cindex faces
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
33
60104
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
34 You can specify various styles for displaying text using
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
35 @dfn{faces}. Each face can specify various @dfn{face attributes},
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
36 such as the font family, the height, weight and slant of the
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
37 characters, the foreground and background color, and underlining or
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
38 overlining. A face does not have to specify all of these attributes;
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
39 often it inherits most of them from another face.
36554
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
40
42668
64f73b2b1f0e (Faces): More updates for faces on character terminals.
Richard M. Stallman <rms@gnu.org>
parents: 42655
diff changeset
41 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
42 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
43 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
44 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
45 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
46
36719
ff26f01b3c8d (Faces): Fix description of terminals which support faces.
Eli Zaretskii <eliz@gnu.org>
parents: 36554
diff changeset
47 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
48 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
49 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
50 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
51 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
52 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
53 terminal has this capability.
36554
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
54
37485
12064cf8f86f Explain better what a face is and what it does.
Richard M. Stallman <rms@gnu.org>
parents: 37229
diff changeset
55 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
56 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
57 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
58 all the applicable faces specified for that character. Any attribute
38745
5464ee1ba8e2 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 38671
diff changeset
59 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
60 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
61
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
62 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
63 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
64 @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
65 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
66 background color.
36554
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
67
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
68 @cindex face colors, setting
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
69 @findex set-face-foreground
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
70 @findex set-face-background
37485
12064cf8f86f Explain better what a face is and what it does.
Richard M. Stallman <rms@gnu.org>
parents: 37229
diff changeset
71 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
72 @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
73 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
74 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
75 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
76 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
77 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
78 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
79 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
80 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
81 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
82 Parameters}.)
37485
12064cf8f86f Explain better what a face is and what it does.
Richard M. Stallman <rms@gnu.org>
parents: 37229
diff changeset
83
60424
6aa27b8c405e (Faces): Delete "Emacs 21".
Richard M. Stallman <rms@gnu.org>
parents: 60104
diff changeset
84 Emacs can correctly display variable-width fonts, but Emacs commands
6aa27b8c405e (Faces): Delete "Emacs 21".
Richard M. Stallman <rms@gnu.org>
parents: 60104
diff changeset
85 that calculate width and indentation do not know how to calculate
6aa27b8c405e (Faces): Delete "Emacs 21".
Richard M. Stallman <rms@gnu.org>
parents: 60104
diff changeset
86 variable widths. This can sometimes lead to incorrect results when
6aa27b8c405e (Faces): Delete "Emacs 21".
Richard M. Stallman <rms@gnu.org>
parents: 60104
diff changeset
87 you use variable-width fonts. In particular, indentation commands can
6aa27b8c405e (Faces): Delete "Emacs 21".
Richard M. Stallman <rms@gnu.org>
parents: 60104
diff changeset
88 give inconsistent results, so we recommend you avoid variable-width
6aa27b8c405e (Faces): Delete "Emacs 21".
Richard M. Stallman <rms@gnu.org>
parents: 60104
diff changeset
89 fonts for editing program source code. Filling will sometimes make
6aa27b8c405e (Faces): Delete "Emacs 21".
Richard M. Stallman <rms@gnu.org>
parents: 60104
diff changeset
90 lines too long or too short. We plan to address these issues in
6aa27b8c405e (Faces): Delete "Emacs 21".
Richard M. Stallman <rms@gnu.org>
parents: 60104
diff changeset
91 future Emacs versions.
36554
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
92
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
93 @findex list-faces-display
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
94 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
95 @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
96 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
97 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
98 faces:
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
99
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
100 @table @code
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
101 @item default
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
102 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
103 @item mode-line
43260
59e700c2760c (Faces): Document the mode-line-inactive face.
Eli Zaretskii <eliz@gnu.org>
parents: 43101
diff changeset
104 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
105 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
106 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
107 terminals. @xref{Display Custom}.
59e700c2760c (Faces): Document the mode-line-inactive face.
Eli Zaretskii <eliz@gnu.org>
parents: 43101
diff changeset
108 @item mode-line-inactive
59e700c2760c (Faces): Document the mode-line-inactive face.
Eli Zaretskii <eliz@gnu.org>
parents: 43101
diff changeset
109 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
110 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
111 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
112 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
113 @item header-line
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
114 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
115 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
116 @item minibuffer-prompt
ecebf8a90c3a (Faces): Document the minibuffer-prompt face.
Eli Zaretskii <eliz@gnu.org>
parents: 42903
diff changeset
117 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
118 @item highlight
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
119 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
120 For example, mouse-sensitive text is highlighted using this face.
63107
f3551fda8850 * display.texi (Faces): Write about mode-line-highlight.
Masatake YAMATO <jet@gyve.org>
parents: 62571
diff changeset
121 @item mode-line-highlight
f3551fda8850 * display.texi (Faces): Write about mode-line-highlight.
Masatake YAMATO <jet@gyve.org>
parents: 62571
diff changeset
122 Like @code{highlight}, but used for portions of text on mode lines.
36554
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
123 @item isearch
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
124 This face is used for highlighting Isearch matches.
59429
d189a9fc6e5b (Faces): isearch-lazy-highlight-face renamed to lazy-highlight.
Richard M. Stallman <rms@gnu.org>
parents: 59259
diff changeset
125 @item lazy-highlight
d189a9fc6e5b (Faces): isearch-lazy-highlight-face renamed to lazy-highlight.
Richard M. Stallman <rms@gnu.org>
parents: 59259
diff changeset
126 This face is used for lazy highlighting of Isearch and Query Replace
d189a9fc6e5b (Faces): isearch-lazy-highlight-face renamed to lazy-highlight.
Richard M. Stallman <rms@gnu.org>
parents: 59259
diff changeset
127 matches other than the current one.
36554
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
128 @item region
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
129 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
130 mode is enabled---see below).
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
131 @item secondary-selection
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
132 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
133 Selection}).
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
134 @item bold
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
135 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
136 @item italic
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
137 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
138 @item bold-italic
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
139 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
140 @item underline
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
141 This face underlines text.
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
142 @item fixed-pitch
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
143 The basic fixed-pitch face.
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
144 @item fringe
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
145 @cindex fringe
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
146 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
147 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
148 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
149 @item scroll-bar
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
150 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
151 @item border
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
152 This face determines the color of the frame border.
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
153 @item cursor
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
154 This face determines the color of the cursor.
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
155 @item mouse
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
156 This face determines the color of the mouse pointer.
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
157 @item tool-bar
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
158 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
159 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
160 @item tooltip
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
161 This face is used for tooltips.
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
162 @item menu
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
163 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
164 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
165 the font are ignored in this case.
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
166 @item trailing-whitespace
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
167 The face for highlighting trailing whitespace when
45955
e4997ff1b0f4 Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 45889
diff changeset
168 @code{show-trailing-whitespace} is non-@code{nil}; see @ref{Useless
e4997ff1b0f4 Minor fixes.
Richard M. Stallman <rms@gnu.org>
parents: 45889
diff changeset
169 Whitespace}.
36554
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
170 @item variable-pitch
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
171 The basic variable-pitch face.
63118
c7fbb48387a4 (Faces): Add `shadow' face.
Juri Linkov <juri@jurta.org>
parents: 63107
diff changeset
172 @item shadow
c7fbb48387a4 (Faces): Add `shadow' face.
Juri Linkov <juri@jurta.org>
parents: 63107
diff changeset
173 The basic face for making the text less noticeable than the surrounding
c7fbb48387a4 (Faces): Add `shadow' face.
Juri Linkov <juri@jurta.org>
parents: 63107
diff changeset
174 ordinary text. Usually this is achieved by using shades of grey in
c7fbb48387a4 (Faces): Add `shadow' face.
Juri Linkov <juri@jurta.org>
parents: 63107
diff changeset
175 contrast with either black or white default foreground color.
36554
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
176 @end table
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 @cindex @code{region} face
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
179 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
180 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
181 @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
182 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
183 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
184 deactivation of the mark.
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
185
62417
6d49a2df78a7 Various minor changes.
Luc Teirlinck <teirllm@auburn.edu>
parents: 61411
diff changeset
186 One easy way to use faces is to turn on Font Lock mode. @xref{Font
6d49a2df78a7 Various minor changes.
Luc Teirlinck <teirllm@auburn.edu>
parents: 61411
diff changeset
187 Lock}, for more information about Font Lock mode and syntactic
6d49a2df78a7 Various minor changes.
Luc Teirlinck <teirllm@auburn.edu>
parents: 61411
diff changeset
188 highlighting.
36554
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 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
191 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
192 @xref{PostScript}.
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
193
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
194 @node Font Lock
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
195 @section Font Lock mode
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
196 @cindex Font Lock mode
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
197 @cindex mode, Font Lock
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
198 @cindex syntax highlighting and coloring
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
199
46036
dd119e0d1cea Explain that Font Lock controls fontification of special modes.
Richard M. Stallman <rms@gnu.org>
parents: 45955
diff changeset
200 Font Lock mode is a minor mode, always local to a particular buffer,
60104
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
201 which highlights (or ``fontifies'') the buffer contents according to
46036
dd119e0d1cea Explain that Font Lock controls fontification of special modes.
Richard M. Stallman <rms@gnu.org>
parents: 45955
diff changeset
202 the syntax of the text you are editing. It can recognize comments and
dd119e0d1cea Explain that Font Lock controls fontification of special modes.
Richard M. Stallman <rms@gnu.org>
parents: 45955
diff changeset
203 strings in most languages; in several languages, it can also recognize
dd119e0d1cea Explain that Font Lock controls fontification of special modes.
Richard M. Stallman <rms@gnu.org>
parents: 45955
diff changeset
204 and properly highlight various other important constructs---for
dd119e0d1cea Explain that Font Lock controls fontification of special modes.
Richard M. Stallman <rms@gnu.org>
parents: 45955
diff changeset
205 example, names of functions being defined or reserved keywords.
dd119e0d1cea Explain that Font Lock controls fontification of special modes.
Richard M. Stallman <rms@gnu.org>
parents: 45955
diff changeset
206 Some special modes, such as Occur mode and Info mode, have completely
dd119e0d1cea Explain that Font Lock controls fontification of special modes.
Richard M. Stallman <rms@gnu.org>
parents: 45955
diff changeset
207 specialized ways of assigning fonts for Font Lock mode.
36554
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
208
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
209 @findex font-lock-mode
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
210 @findex turn-on-font-lock
62417
6d49a2df78a7 Various minor changes.
Luc Teirlinck <teirllm@auburn.edu>
parents: 61411
diff changeset
211 The command @kbd{M-x font-lock-mode} turns Font Lock mode on with
6d49a2df78a7 Various minor changes.
Luc Teirlinck <teirllm@auburn.edu>
parents: 61411
diff changeset
212 positive argument, off with negative or zero argument, and toggles the
6d49a2df78a7 Various minor changes.
Luc Teirlinck <teirllm@auburn.edu>
parents: 61411
diff changeset
213 mode when it has no argument. The function @code{turn-on-font-lock}
6d49a2df78a7 Various minor changes.
Luc Teirlinck <teirllm@auburn.edu>
parents: 61411
diff changeset
214 unconditionally enables Font Lock mode. This is useful in mode-hook
6d49a2df78a7 Various minor changes.
Luc Teirlinck <teirllm@auburn.edu>
parents: 61411
diff changeset
215 functions. For example, to enable Font Lock mode whenever you edit a
6d49a2df78a7 Various minor changes.
Luc Teirlinck <teirllm@auburn.edu>
parents: 61411
diff changeset
216 C file, you can do this:
36554
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
217
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
218 @example
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
219 (add-hook 'c-mode-hook 'turn-on-font-lock)
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
220 @end example
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
221
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
222 @findex global-font-lock-mode
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
223 @vindex global-font-lock-mode
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
224 To turn on Font Lock mode automatically in all modes which support
62417
6d49a2df78a7 Various minor changes.
Luc Teirlinck <teirllm@auburn.edu>
parents: 61411
diff changeset
225 it, customize the variable @code{global-font-lock-mode} using the
6d49a2df78a7 Various minor changes.
Luc Teirlinck <teirllm@auburn.edu>
parents: 61411
diff changeset
226 Customize interface (@pxref{Easy Customization}) or use the function
6d49a2df78a7 Various minor changes.
Luc Teirlinck <teirllm@auburn.edu>
parents: 61411
diff changeset
227 @code{global-font-lock-mode} in your @file{.emacs} file, like this:
36554
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
228
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
229 @example
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
230 (global-font-lock-mode 1)
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
231 @end example
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
232
60104
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
233 @noindent
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
234 You can also specify this using the menu bar Options menu, specifying
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
235 first Syntax Highlighting and then Save Options.
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
236
36554
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
237 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
238 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
239 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
240 on the face name in @code{set-face-foreground}.
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
241
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
242 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
243 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
244 two ways to do it:
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
245
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
246 @itemize @bullet
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
247 @item
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
248 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
249 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
250 @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
251 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
252
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
253 @item
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
254 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
255 described in @ref{Face Customization}.
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
256 @end itemize
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
257
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
258 @vindex font-lock-maximum-decoration
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
259 The variable @code{font-lock-maximum-decoration} specifies the
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
260 preferred level of fontification, for modes that provide multiple
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
261 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
262 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
263 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
264 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
265 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
266 otherwise, use this:
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
267
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
268 @example
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
269 (setq font-lock-maximum-decoration
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
270 '((c-mode . 1) (c++-mode . 1)))
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
271 @end example
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
272
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
273 @vindex font-lock-maximum-size
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
274 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
275 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
276 beyond which buffer fontification is suppressed.
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
277
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
278 @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
279 @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
280 @cindex incorrect fontification
f6a4184f6285 (Font Lock): Add index entries for paren-in-column-zero problems.
Eli Zaretskii <eliz@gnu.org>
parents: 39267
diff changeset
281 @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
282 @cindex brace in column zero and fontification
36554
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
283 Comment and string fontification (or ``syntactic'' fontification)
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
284 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
285 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
286 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
287 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
288 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
289 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
290 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
291 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
292
36719
ff26f01b3c8d (Faces): Fix description of terminals which support faces.
Eli Zaretskii <eliz@gnu.org>
parents: 36554
diff changeset
293 @cindex slow display during scrolling
36554
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
294 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
295 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
296 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
297 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
298 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
299 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
300 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
301 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
302 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
303 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
304 the end of a large buffer.
36554
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
305
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
306 @findex font-lock-add-keywords
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
307 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
308 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
309 @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
310 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
311 comments, use this:
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
312
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
313 @example
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
314 (font-lock-add-keywords
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
315 'c-mode
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
316 '(("\\<\\(FIXME\\):" 1 font-lock-warning-face t)))
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
317 @end example
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
318
38923
62061f910492 (Font Lock): Document font-lock-remove-keywords.
Eli Zaretskii <eliz@gnu.org>
parents: 38921
diff changeset
319 @findex font-lock-remove-keywords
62061f910492 (Font Lock): Document font-lock-remove-keywords.
Eli Zaretskii <eliz@gnu.org>
parents: 38921
diff changeset
320 To remove keywords from the font-lock highlighting patterns, use the
51792
8896f8091409 (Font Lock): Add xref for format info on font-lock-remove-keywords.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
321 function @code{font-lock-remove-keywords}. @xref{Search-based
56779
7594fd57477f (Font Lock): Correct invalid @xref.
Luc Teirlinck <teirllm@auburn.edu>
parents: 52979
diff changeset
322 Fontification,,, elisp, The Emacs Lisp Reference Manual}, for
7594fd57477f (Font Lock): Correct invalid @xref.
Luc Teirlinck <teirllm@auburn.edu>
parents: 52979
diff changeset
323 documentation of the format of this list.
38923
62061f910492 (Font Lock): Document font-lock-remove-keywords.
Eli Zaretskii <eliz@gnu.org>
parents: 38921
diff changeset
324
42234
64fa0eed5865 (Font Lock): Mention jit-lock and its customization group.
Eli Zaretskii <eliz@gnu.org>
parents: 41374
diff changeset
325 @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
326 @cindex background syntax highlighting
64fa0eed5865 (Font Lock): Mention jit-lock and its customization group.
Eli Zaretskii <eliz@gnu.org>
parents: 41374
diff changeset
327 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
328 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
329 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
330 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
331 parts of the buffer that are not displayed are fontified
60857
87594637fb45 (Font Lock): Put commas inside closequotes.
Richard M. Stallman <rms@gnu.org>
parents: 60424
diff changeset
332 ``stealthily,'' in the background, i.e.@: when Emacs is idle. You can
59796
48aa868cde0b Don't say just "option" when talking about variables.
Richard M. Stallman <rms@gnu.org>
parents: 59429
diff changeset
333 control this background fontification, also called @dfn{Just-In-Time}
48aa868cde0b Don't say just "option" when talking about variables.
Richard M. Stallman <rms@gnu.org>
parents: 59429
diff changeset
334 (or @dfn{JIT}) Lock, by customizing variables in the customization
48aa868cde0b Don't say just "option" when talking about variables.
Richard M. Stallman <rms@gnu.org>
parents: 59429
diff changeset
335 group @samp{jit-lock}. @xref{Specific Customization}.
42234
64fa0eed5865 (Font Lock): Mention jit-lock and its customization group.
Eli Zaretskii <eliz@gnu.org>
parents: 41374
diff changeset
336
36554
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
337 @node Highlight Changes
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
338 @section Highlight Changes Mode
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
339
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
340 @findex highlight-changes-mode
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
341 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
342 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
343 the buffer were changed most recently.
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
344
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
345 @node Highlight Interactively
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
346 @section Interactive Highlighting by Matching
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
347 @cindex highlighting by matching
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
348 @cindex interactive highlighting
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
349
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
350 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
351 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
352 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
353 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
354 cliches stand out in an article.
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
355
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
356 @findex hi-lock-mode
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
357 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
358 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
359 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
360 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
361 highlight. You control Hi-lock mode with these commands:
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
362
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
363 @table @kbd
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
364 @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
365 @kindex C-x w h
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
366 @findex highlight-regexp
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
367 Highlight text that matches
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
368 @var{regexp} using face @var{face} (@code{highlight-regexp}).
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
369 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
370 parts of the text in different ways.
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 r @var{regexp} @key{RET}
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
373 @kindex C-x w r
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
374 @findex unhighlight-regexp
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
375 Unhighlight @var{regexp} (@code{unhighlight-regexp}). You must enter
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
376 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
377 (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
378 conveniently.)
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 l @var{regexp} @key{RET} @var{face} @key{RET}
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
381 @kindex C-x w l
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
382 @findex highlight-lines-matching-regexp
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
383 @cindex lines, highlighting
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
384 @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
385 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
386 @var{face} (@code{highlight-lines-matching-regexp}).
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 @item C-x w b
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
389 @kindex C-x w b
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
390 @findex hi-lock-write-interactive-patterns
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
391 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
392 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
393 program. This key binding runs the
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
394 @code{hi-lock-write-interactive-patterns} command.
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
395
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
396 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
397 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
398 hi-lock-find-patterns} command.
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 @item C-x w i
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
401 @kindex C-x w i
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
402 @findex hi-lock-find-patterns
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
403 @vindex hi-lock-exclude-modes
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
404 Re-read regexp/face pairs in the current buffer
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
405 (@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
406 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
407
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
408 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
409 @code{hi-lock-exclude-modes}.
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
410 @end table
9904afd52408 (Faces, Font Lock, Highlight Changes)
Gerd Moellmann <gerd@gnu.org>
parents: 36263
diff changeset
411
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
412 @node Scrolling
Dave Love <fx@gnu.org>
parents:
diff changeset
413 @section Scrolling
Dave Love <fx@gnu.org>
parents:
diff changeset
414
Dave Love <fx@gnu.org>
parents:
diff changeset
415 If a buffer contains text that is too large to fit entirely within a
Dave Love <fx@gnu.org>
parents:
diff changeset
416 window that is displaying the buffer, Emacs shows a contiguous portion of
Dave Love <fx@gnu.org>
parents:
diff changeset
417 the text. The portion shown always contains point.
Dave Love <fx@gnu.org>
parents:
diff changeset
418
Dave Love <fx@gnu.org>
parents:
diff changeset
419 @cindex scrolling
Dave Love <fx@gnu.org>
parents:
diff changeset
420 @dfn{Scrolling} means moving text up or down in the window so that
Dave Love <fx@gnu.org>
parents:
diff changeset
421 different parts of the text are visible. Scrolling forward means that text
Dave Love <fx@gnu.org>
parents:
diff changeset
422 moves up, and new text appears at the bottom. Scrolling backward moves
Dave Love <fx@gnu.org>
parents:
diff changeset
423 text down and new text appears at the top.
Dave Love <fx@gnu.org>
parents:
diff changeset
424
Dave Love <fx@gnu.org>
parents:
diff changeset
425 Scrolling happens automatically if you move point past the bottom or top
Dave Love <fx@gnu.org>
parents:
diff changeset
426 of the window. You can also explicitly request scrolling with the commands
Dave Love <fx@gnu.org>
parents:
diff changeset
427 in this section.
Dave Love <fx@gnu.org>
parents:
diff changeset
428
Dave Love <fx@gnu.org>
parents:
diff changeset
429 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
430 @item C-l
Dave Love <fx@gnu.org>
parents:
diff changeset
431 Clear screen and redisplay, scrolling the selected window to center
Dave Love <fx@gnu.org>
parents:
diff changeset
432 point vertically within it (@code{recenter}).
Dave Love <fx@gnu.org>
parents:
diff changeset
433 @item C-v
Dave Love <fx@gnu.org>
parents:
diff changeset
434 Scroll forward (a windowful or a specified number of lines) (@code{scroll-up}).
Dave Love <fx@gnu.org>
parents:
diff changeset
435 @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
436 @itemx @key{PAGEDOWN}
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
437 Likewise, scroll forward.
Dave Love <fx@gnu.org>
parents:
diff changeset
438 @item M-v
Dave Love <fx@gnu.org>
parents:
diff changeset
439 Scroll backward (@code{scroll-down}).
Dave Love <fx@gnu.org>
parents:
diff changeset
440 @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
441 @itemx @key{PAGEUP}
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
442 Likewise, scroll backward.
Dave Love <fx@gnu.org>
parents:
diff changeset
443 @item @var{arg} C-l
Dave Love <fx@gnu.org>
parents:
diff changeset
444 Scroll so point is on line @var{arg} (@code{recenter}).
Dave Love <fx@gnu.org>
parents:
diff changeset
445 @item C-M-l
Dave Love <fx@gnu.org>
parents:
diff changeset
446 Scroll heuristically to bring useful information onto the screen
Dave Love <fx@gnu.org>
parents:
diff changeset
447 (@code{reposition-window}).
Dave Love <fx@gnu.org>
parents:
diff changeset
448 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
449
Dave Love <fx@gnu.org>
parents:
diff changeset
450 @kindex C-l
Dave Love <fx@gnu.org>
parents:
diff changeset
451 @findex recenter
Dave Love <fx@gnu.org>
parents:
diff changeset
452 The most basic scrolling command is @kbd{C-l} (@code{recenter}) with
60104
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
453 no argument. It scrolls the selected window so that point is halfway
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
454 down from the top of the window. On a text terminal, it also clears
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
455 the screen and redisplays all windows. That is useful in case the
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
456 screen is garbled (@pxref{Screen Garbled}).
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
457
Dave Love <fx@gnu.org>
parents:
diff changeset
458 @kindex C-v
Dave Love <fx@gnu.org>
parents:
diff changeset
459 @kindex M-v
Dave Love <fx@gnu.org>
parents:
diff changeset
460 @kindex NEXT
Dave Love <fx@gnu.org>
parents:
diff changeset
461 @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
462 @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
463 @kindex PAGEUP
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
464 @findex scroll-up
Dave Love <fx@gnu.org>
parents:
diff changeset
465 @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
466 @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
467 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
468 (@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
469 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
470 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
471 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
472 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
473 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
474
38745
5464ee1ba8e2 Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 38671
diff changeset
475 @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
476 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
477 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
478 @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
479 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
480 are equivalent to @kbd{C-v} and @kbd{M-v}.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
481
38115
c75a19b1930f Local rewrites. Describe basic no-argument C-v and M-v first,
Richard M. Stallman <rms@gnu.org>
parents: 38048
diff changeset
482 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
483 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
484 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
485 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
486 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
487 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
488 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
489 versa.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
490
38115
c75a19b1930f Local rewrites. Describe basic no-argument C-v and M-v first,
Richard M. Stallman <rms@gnu.org>
parents: 38048
diff changeset
491 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
492 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
493 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
494 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
495 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
496 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
497 @code{scroll-up}.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
498
Dave Love <fx@gnu.org>
parents:
diff changeset
499 @vindex scroll-preserve-screen-position
Dave Love <fx@gnu.org>
parents:
diff changeset
500 Some users like the full-screen scroll commands to keep point at the
Dave Love <fx@gnu.org>
parents:
diff changeset
501 same screen line. To enable this behavior, set the variable
59259
07897e1a19b5 (Scrolling): Correct scroll-preserve-screen-position.
Richard M. Stallman <rms@gnu.org>
parents: 57251
diff changeset
502 @code{scroll-preserve-screen-position} to a non-@code{nil} value. In
07897e1a19b5 (Scrolling): Correct scroll-preserve-screen-position.
Richard M. Stallman <rms@gnu.org>
parents: 57251
diff changeset
503 this mode, when scrolling shifts point off the screen, or into the
07897e1a19b5 (Scrolling): Correct scroll-preserve-screen-position.
Richard M. Stallman <rms@gnu.org>
parents: 57251
diff changeset
504 scrolling margins, Emacs moves point to keep the same vertical
07897e1a19b5 (Scrolling): Correct scroll-preserve-screen-position.
Richard M. Stallman <rms@gnu.org>
parents: 57251
diff changeset
505 position within the window. This mode is convenient for browsing
07897e1a19b5 (Scrolling): Correct scroll-preserve-screen-position.
Richard M. Stallman <rms@gnu.org>
parents: 57251
diff changeset
506 through a file by scrolling by screenfuls; if you come back to the
07897e1a19b5 (Scrolling): Correct scroll-preserve-screen-position.
Richard M. Stallman <rms@gnu.org>
parents: 57251
diff changeset
507 screen where you started, point goes back to the line where it
07897e1a19b5 (Scrolling): Correct scroll-preserve-screen-position.
Richard M. Stallman <rms@gnu.org>
parents: 57251
diff changeset
508 started. However, this mode is inconvenient when you move to the next
07897e1a19b5 (Scrolling): Correct scroll-preserve-screen-position.
Richard M. Stallman <rms@gnu.org>
parents: 57251
diff changeset
509 screen in order to move point to the text there.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
510
Dave Love <fx@gnu.org>
parents:
diff changeset
511 Another way to do scrolling is with @kbd{C-l} with a numeric argument.
Dave Love <fx@gnu.org>
parents:
diff changeset
512 @kbd{C-l} does not clear the screen when given an argument; it only scrolls
Dave Love <fx@gnu.org>
parents:
diff changeset
513 the selected window. With a positive argument @var{n}, it repositions text
Dave Love <fx@gnu.org>
parents:
diff changeset
514 to put point @var{n} lines down from the top. An argument of zero puts
Dave Love <fx@gnu.org>
parents:
diff changeset
515 point on the very top line. Point does not move with respect to the text;
Dave Love <fx@gnu.org>
parents:
diff changeset
516 rather, the text and point move rigidly on the screen. @kbd{C-l} with a
Dave Love <fx@gnu.org>
parents:
diff changeset
517 negative argument puts point that many lines from the bottom of the window.
Dave Love <fx@gnu.org>
parents:
diff changeset
518 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
519 - 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
520 point at the center (vertically) of the selected window.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
521
Dave Love <fx@gnu.org>
parents:
diff changeset
522 @kindex C-M-l
Dave Love <fx@gnu.org>
parents:
diff changeset
523 @findex reposition-window
Dave Love <fx@gnu.org>
parents:
diff changeset
524 The @kbd{C-M-l} command (@code{reposition-window}) scrolls the current
Dave Love <fx@gnu.org>
parents:
diff changeset
525 window heuristically in a way designed to get useful information onto
Dave Love <fx@gnu.org>
parents:
diff changeset
526 the screen. For example, in a Lisp file, this command tries to get the
Dave Love <fx@gnu.org>
parents:
diff changeset
527 entire current defun onto the screen if possible.
Dave Love <fx@gnu.org>
parents:
diff changeset
528
Dave Love <fx@gnu.org>
parents:
diff changeset
529 @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
530 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
531 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
532 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
533 @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
534 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
535 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
536 back on screen. By default, @code{scroll-conservatively} is 0.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
537
31126
66e5313fd5bc Document scroll-up-aggressively and scroll-down-aggressively.
Eli Zaretskii <eliz@gnu.org>
parents: 31041
diff changeset
538 @cindex aggressive scrolling
66e5313fd5bc Document scroll-up-aggressively and scroll-down-aggressively.
Eli Zaretskii <eliz@gnu.org>
parents: 31041
diff changeset
539 @vindex scroll-up-aggressively
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 48534
diff changeset
540 @vindex scroll-down-aggressively
36150
46e59561af4c Display Vars node renamed Display Custom.
Richard M. Stallman <rms@gnu.org>
parents: 35433
diff changeset
541 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
542 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
543 @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
544 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
545 @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
546 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
547 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
548 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
549 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
550 aggressive the scrolling.
31126
66e5313fd5bc Document scroll-up-aggressively and scroll-down-aggressively.
Eli Zaretskii <eliz@gnu.org>
parents: 31041
diff changeset
551
36150
46e59561af4c Display Vars node renamed Display Custom.
Richard M. Stallman <rms@gnu.org>
parents: 35433
diff changeset
552 @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
553 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
554
36150
46e59561af4c Display Vars node renamed Display Custom.
Richard M. Stallman <rms@gnu.org>
parents: 35433
diff changeset
555 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
556 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
557 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
558 @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
559
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
560 @vindex scroll-margin
Dave Love <fx@gnu.org>
parents:
diff changeset
561 The variable @code{scroll-margin} restricts how close point can come
Dave Love <fx@gnu.org>
parents:
diff changeset
562 to the top or bottom of a window. Its value is a number of screen
Dave Love <fx@gnu.org>
parents:
diff changeset
563 lines; if point comes within that many lines of the top or bottom of the
Dave Love <fx@gnu.org>
parents:
diff changeset
564 window, Emacs recenters the window. By default, @code{scroll-margin} is
Dave Love <fx@gnu.org>
parents:
diff changeset
565 0.
Dave Love <fx@gnu.org>
parents:
diff changeset
566
Dave Love <fx@gnu.org>
parents:
diff changeset
567 @node Horizontal Scrolling
Dave Love <fx@gnu.org>
parents:
diff changeset
568 @section Horizontal Scrolling
Dave Love <fx@gnu.org>
parents:
diff changeset
569 @cindex horizontal scrolling
Dave Love <fx@gnu.org>
parents:
diff changeset
570
Dave Love <fx@gnu.org>
parents:
diff changeset
571 @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
572 within a window---so that some of the text near the left margin is not
60104
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
573 displayed at all. When the text in a window is scrolled horizontally,
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
574 text lines are truncated rather than continued (@pxref{Display
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
575 Custom}). Whenever a window shows truncated lines, Emacs
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
576 automatically updates its horizontal scrolling whenever point moves
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
577 off the left or right edge of the screen. You can also use these
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
578 commands to do explicit horizontal scrolling.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
579
Dave Love <fx@gnu.org>
parents:
diff changeset
580 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
581 @item C-x <
Dave Love <fx@gnu.org>
parents:
diff changeset
582 Scroll text in current window to the left (@code{scroll-left}).
Dave Love <fx@gnu.org>
parents:
diff changeset
583 @item C-x >
Dave Love <fx@gnu.org>
parents:
diff changeset
584 Scroll to the right (@code{scroll-right}).
Dave Love <fx@gnu.org>
parents:
diff changeset
585 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
586
Dave Love <fx@gnu.org>
parents:
diff changeset
587 @kindex C-x <
Dave Love <fx@gnu.org>
parents:
diff changeset
588 @kindex C-x >
Dave Love <fx@gnu.org>
parents:
diff changeset
589 @findex scroll-left
Dave Love <fx@gnu.org>
parents:
diff changeset
590 @findex scroll-right
Dave Love <fx@gnu.org>
parents:
diff changeset
591 The command @kbd{C-x <} (@code{scroll-left}) scrolls the selected
Dave Love <fx@gnu.org>
parents:
diff changeset
592 window to the left by @var{n} columns with argument @var{n}. This moves
Dave Love <fx@gnu.org>
parents:
diff changeset
593 part of the beginning of each line off the left edge of the window.
Dave Love <fx@gnu.org>
parents:
diff changeset
594 With no argument, it scrolls by almost the full width of the window (two
Dave Love <fx@gnu.org>
parents:
diff changeset
595 columns less, to be precise).
Dave Love <fx@gnu.org>
parents:
diff changeset
596
Dave Love <fx@gnu.org>
parents:
diff changeset
597 @kbd{C-x >} (@code{scroll-right}) scrolls similarly to the right. The
Dave Love <fx@gnu.org>
parents:
diff changeset
598 window cannot be scrolled any farther to the right once it is displayed
Dave Love <fx@gnu.org>
parents:
diff changeset
599 normally (with each line starting at the window's left margin);
Dave Love <fx@gnu.org>
parents:
diff changeset
600 attempting to do so has no effect. This means that you don't have to
Dave Love <fx@gnu.org>
parents:
diff changeset
601 calculate the argument precisely for @w{@kbd{C-x >}}; any sufficiently large
Dave Love <fx@gnu.org>
parents:
diff changeset
602 argument will restore the normal display.
Dave Love <fx@gnu.org>
parents:
diff changeset
603
60104
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
604 If you use those commands to scroll a window horizontally, that sets
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
605 a lower bound for automatic horizontal scrolling. Automatic scrolling
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
606 will continue to scroll the window, but never farther to the right
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
607 than the amount you previously set by @code{scroll-left}.
36150
46e59561af4c Display Vars node renamed Display Custom.
Richard M. Stallman <rms@gnu.org>
parents: 35433
diff changeset
608
43664
e2407682df3e (Horizontal Scrolling): Rename automatic-hscrolling, automatic-hscroll-step
Eli Zaretskii <eliz@gnu.org>
parents: 43386
diff changeset
609 @vindex hscroll-margin
e2407682df3e (Horizontal Scrolling): Rename automatic-hscrolling, automatic-hscroll-step
Eli Zaretskii <eliz@gnu.org>
parents: 43386
diff changeset
610 The value of the variable @code{hscroll-margin} controls how close
e2407682df3e (Horizontal Scrolling): Rename automatic-hscrolling, automatic-hscroll-step
Eli Zaretskii <eliz@gnu.org>
parents: 43386
diff changeset
611 to the window's edges point is allowed to get before the window will
e2407682df3e (Horizontal Scrolling): Rename automatic-hscrolling, automatic-hscroll-step
Eli Zaretskii <eliz@gnu.org>
parents: 43386
diff changeset
612 be automatically scrolled. It is measured in columns. If the value
e2407682df3e (Horizontal Scrolling): Rename automatic-hscrolling, automatic-hscroll-step
Eli Zaretskii <eliz@gnu.org>
parents: 43386
diff changeset
613 is 5, then moving point within 5 columns of the edge causes horizontal
e2407682df3e (Horizontal Scrolling): Rename automatic-hscrolling, automatic-hscroll-step
Eli Zaretskii <eliz@gnu.org>
parents: 43386
diff changeset
614 scrolling away from that edge.
43355
60d8b3e0e785 (Horizontal Scrolling): Document automatic-hscroll-margin and
Eli Zaretskii <eliz@gnu.org>
parents: 43289
diff changeset
615
43664
e2407682df3e (Horizontal Scrolling): Rename automatic-hscrolling, automatic-hscroll-step
Eli Zaretskii <eliz@gnu.org>
parents: 43386
diff changeset
616 @vindex hscroll-step
e2407682df3e (Horizontal Scrolling): Rename automatic-hscrolling, automatic-hscroll-step
Eli Zaretskii <eliz@gnu.org>
parents: 43386
diff changeset
617 The variable @code{hscroll-step} determines how many columns to
e2407682df3e (Horizontal Scrolling): Rename automatic-hscrolling, automatic-hscroll-step
Eli Zaretskii <eliz@gnu.org>
parents: 43386
diff changeset
618 scroll the window when point gets too close to the edge. If it's
e2407682df3e (Horizontal Scrolling): Rename automatic-hscrolling, automatic-hscroll-step
Eli Zaretskii <eliz@gnu.org>
parents: 43386
diff changeset
619 zero, horizontal scrolling centers point horizontally within the
e2407682df3e (Horizontal Scrolling): Rename automatic-hscrolling, automatic-hscroll-step
Eli Zaretskii <eliz@gnu.org>
parents: 43386
diff changeset
620 window. If it's a positive integer, it specifies the number of
43386
250dde622cec Minor rewrites.
Richard M. Stallman <rms@gnu.org>
parents: 43355
diff changeset
621 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
622 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
623
43664
e2407682df3e (Horizontal Scrolling): Rename automatic-hscrolling, automatic-hscroll-step
Eli Zaretskii <eliz@gnu.org>
parents: 43386
diff changeset
624 @vindex auto-hscroll-mode
36150
46e59561af4c Display Vars node renamed Display Custom.
Richard M. Stallman <rms@gnu.org>
parents: 35433
diff changeset
625 To disable automatic horizontal scrolling, set the variable
43664
e2407682df3e (Horizontal Scrolling): Rename automatic-hscrolling, automatic-hscroll-step
Eli Zaretskii <eliz@gnu.org>
parents: 43386
diff changeset
626 @code{auto-hscroll-mode} to @code{nil}.
34749
3a0a4c2b6633 *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 33744
diff changeset
627
45877
74f67ed375f0 Rename Trailing Whitespace to Useless Whitespace
Richard M. Stallman <rms@gnu.org>
parents: 43664
diff changeset
628 @node Fringes
74f67ed375f0 Rename Trailing Whitespace to Useless Whitespace
Richard M. Stallman <rms@gnu.org>
parents: 43664
diff changeset
629 @section Window Fringes
74f67ed375f0 Rename Trailing Whitespace to Useless Whitespace
Richard M. Stallman <rms@gnu.org>
parents: 43664
diff changeset
630 @cindex fringes
74f67ed375f0 Rename Trailing Whitespace to Useless Whitespace
Richard M. Stallman <rms@gnu.org>
parents: 43664
diff changeset
631
74f67ed375f0 Rename Trailing Whitespace to Useless Whitespace
Richard M. Stallman <rms@gnu.org>
parents: 43664
diff changeset
632 On a graphical display, each Emacs window normally has narrow
74f67ed375f0 Rename Trailing Whitespace to Useless Whitespace
Richard M. Stallman <rms@gnu.org>
parents: 43664
diff changeset
633 @dfn{fringes} on the left and right edges. The fringes display
74f67ed375f0 Rename Trailing Whitespace to Useless Whitespace
Richard M. Stallman <rms@gnu.org>
parents: 43664
diff changeset
634 indications about the text in the window.
74f67ed375f0 Rename Trailing Whitespace to Useless Whitespace
Richard M. Stallman <rms@gnu.org>
parents: 43664
diff changeset
635
74f67ed375f0 Rename Trailing Whitespace to Useless Whitespace
Richard M. Stallman <rms@gnu.org>
parents: 43664
diff changeset
636 The most common use of the fringes is to indicate a continuation
74f67ed375f0 Rename Trailing Whitespace to Useless Whitespace
Richard M. Stallman <rms@gnu.org>
parents: 43664
diff changeset
637 line, when one line of text is split into multiple lines on the
74f67ed375f0 Rename Trailing Whitespace to Useless Whitespace
Richard M. Stallman <rms@gnu.org>
parents: 43664
diff changeset
638 screen. The left fringe shows a curving arrow for each screen line
74f67ed375f0 Rename Trailing Whitespace to Useless Whitespace
Richard M. Stallman <rms@gnu.org>
parents: 43664
diff changeset
639 except the first, indicating that ``this is not the real beginning.''
74f67ed375f0 Rename Trailing Whitespace to Useless Whitespace
Richard M. Stallman <rms@gnu.org>
parents: 43664
diff changeset
640 The right fringe shows a curving arrow for each screen line except the
74f67ed375f0 Rename Trailing Whitespace to Useless Whitespace
Richard M. Stallman <rms@gnu.org>
parents: 43664
diff changeset
641 last, indicating that ``this is not the real end.''
74f67ed375f0 Rename Trailing Whitespace to Useless Whitespace
Richard M. Stallman <rms@gnu.org>
parents: 43664
diff changeset
642
45889
0d2a977d3d32 (Fringes): Fix a typo. Mention the fact that arrows on the fringes are
Eli Zaretskii <eliz@gnu.org>
parents: 45883
diff changeset
643 The fringes indicate line truncation with short horizontal arrows
45877
74f67ed375f0 Rename Trailing Whitespace to Useless Whitespace
Richard M. Stallman <rms@gnu.org>
parents: 43664
diff changeset
644 meaning ``there's more text on this line which is scrolled
45889
0d2a977d3d32 (Fringes): Fix a typo. Mention the fact that arrows on the fringes are
Eli Zaretskii <eliz@gnu.org>
parents: 45883
diff changeset
645 horizontally out of view;'' clicking the mouse on one of the arrows
0d2a977d3d32 (Fringes): Fix a typo. Mention the fact that arrows on the fringes are
Eli Zaretskii <eliz@gnu.org>
parents: 45883
diff changeset
646 scrolls the display horizontally in the direction of the arrow. The
62417
6d49a2df78a7 Various minor changes.
Luc Teirlinck <teirllm@auburn.edu>
parents: 61411
diff changeset
647 fringes can also indicate other things, such as empty lines, or where a
45889
0d2a977d3d32 (Fringes): Fix a typo. Mention the fact that arrows on the fringes are
Eli Zaretskii <eliz@gnu.org>
parents: 45883
diff changeset
648 program you are debugging is executing (@pxref{Debuggers}).
45877
74f67ed375f0 Rename Trailing Whitespace to Useless Whitespace
Richard M. Stallman <rms@gnu.org>
parents: 43664
diff changeset
649
74f67ed375f0 Rename Trailing Whitespace to Useless Whitespace
Richard M. Stallman <rms@gnu.org>
parents: 43664
diff changeset
650 @findex set-fringe-style
74f67ed375f0 Rename Trailing Whitespace to Useless Whitespace
Richard M. Stallman <rms@gnu.org>
parents: 43664
diff changeset
651 @findex fringe-mode
74f67ed375f0 Rename Trailing Whitespace to Useless Whitespace
Richard M. Stallman <rms@gnu.org>
parents: 43664
diff changeset
652 You can enable and disable the fringes for all frames using
74f67ed375f0 Rename Trailing Whitespace to Useless Whitespace
Richard M. Stallman <rms@gnu.org>
parents: 43664
diff changeset
653 @kbd{M-x fringe-mode}. To enable and disable the fringes
74f67ed375f0 Rename Trailing Whitespace to Useless Whitespace
Richard M. Stallman <rms@gnu.org>
parents: 43664
diff changeset
654 for the selected frame, use @kbd{M-x set-fringe-style}.
74f67ed375f0 Rename Trailing Whitespace to Useless Whitespace
Richard M. Stallman <rms@gnu.org>
parents: 43664
diff changeset
655
74f67ed375f0 Rename Trailing Whitespace to Useless Whitespace
Richard M. Stallman <rms@gnu.org>
parents: 43664
diff changeset
656 @node Useless Whitespace
74f67ed375f0 Rename Trailing Whitespace to Useless Whitespace
Richard M. Stallman <rms@gnu.org>
parents: 43664
diff changeset
657 @section Useless Whitespace
74f67ed375f0 Rename Trailing Whitespace to Useless Whitespace
Richard M. Stallman <rms@gnu.org>
parents: 43664
diff changeset
658
74f67ed375f0 Rename Trailing Whitespace to Useless Whitespace
Richard M. Stallman <rms@gnu.org>
parents: 43664
diff changeset
659 @cindex trailing whitespace
74f67ed375f0 Rename Trailing Whitespace to Useless Whitespace
Richard M. Stallman <rms@gnu.org>
parents: 43664
diff changeset
660 @cindex whitespace, trailing
74f67ed375f0 Rename Trailing Whitespace to Useless Whitespace
Richard M. Stallman <rms@gnu.org>
parents: 43664
diff changeset
661 @vindex show-trailing-whitespace
74f67ed375f0 Rename Trailing Whitespace to Useless Whitespace
Richard M. Stallman <rms@gnu.org>
parents: 43664
diff changeset
662 It is easy to leave unnecessary spaces at the end of a line, or
74f67ed375f0 Rename Trailing Whitespace to Useless Whitespace
Richard M. Stallman <rms@gnu.org>
parents: 43664
diff changeset
663 empty lines at the end of a file, without realizing it. In most
74f67ed375f0 Rename Trailing Whitespace to Useless Whitespace
Richard M. Stallman <rms@gnu.org>
parents: 43664
diff changeset
664 cases, this @dfn{trailing whitespace} has no effect, but there are
74f67ed375f0 Rename Trailing Whitespace to Useless Whitespace
Richard M. Stallman <rms@gnu.org>
parents: 43664
diff changeset
665 special circumstances where it matters.
74f67ed375f0 Rename Trailing Whitespace to Useless Whitespace
Richard M. Stallman <rms@gnu.org>
parents: 43664
diff changeset
666
74f67ed375f0 Rename Trailing Whitespace to Useless Whitespace
Richard M. Stallman <rms@gnu.org>
parents: 43664
diff changeset
667 You can make trailing whitespace at the end of a line visible on the
74f67ed375f0 Rename Trailing Whitespace to Useless Whitespace
Richard M. Stallman <rms@gnu.org>
parents: 43664
diff changeset
668 screen by setting the buffer-local variable
74f67ed375f0 Rename Trailing Whitespace to Useless Whitespace
Richard M. Stallman <rms@gnu.org>
parents: 43664
diff changeset
669 @code{show-trailing-whitespace} to @code{t}. Then Emacs displays
74f67ed375f0 Rename Trailing Whitespace to Useless Whitespace
Richard M. Stallman <rms@gnu.org>
parents: 43664
diff changeset
670 trailing whitespace in the face @code{trailing-whitespace}.
74f67ed375f0 Rename Trailing Whitespace to Useless Whitespace
Richard M. Stallman <rms@gnu.org>
parents: 43664
diff changeset
671
74f67ed375f0 Rename Trailing Whitespace to Useless Whitespace
Richard M. Stallman <rms@gnu.org>
parents: 43664
diff changeset
672 This feature does not apply when point is at the end of the line
74f67ed375f0 Rename Trailing Whitespace to Useless Whitespace
Richard M. Stallman <rms@gnu.org>
parents: 43664
diff changeset
673 containing the whitespace. Strictly speaking, that is ``trailing
74f67ed375f0 Rename Trailing Whitespace to Useless Whitespace
Richard M. Stallman <rms@gnu.org>
parents: 43664
diff changeset
674 whitespace'' nonetheless, but displaying it specially in that case
74f67ed375f0 Rename Trailing Whitespace to Useless Whitespace
Richard M. Stallman <rms@gnu.org>
parents: 43664
diff changeset
675 looks ugly while you are typing in new text. In this special case,
74f67ed375f0 Rename Trailing Whitespace to Useless Whitespace
Richard M. Stallman <rms@gnu.org>
parents: 43664
diff changeset
676 the location of point is enough to show you that the spaces are
74f67ed375f0 Rename Trailing Whitespace to Useless Whitespace
Richard M. Stallman <rms@gnu.org>
parents: 43664
diff changeset
677 present.
74f67ed375f0 Rename Trailing Whitespace to Useless Whitespace
Richard M. Stallman <rms@gnu.org>
parents: 43664
diff changeset
678
74f67ed375f0 Rename Trailing Whitespace to Useless Whitespace
Richard M. Stallman <rms@gnu.org>
parents: 43664
diff changeset
679 @findex delete-trailing-whitespace
74f67ed375f0 Rename Trailing Whitespace to Useless Whitespace
Richard M. Stallman <rms@gnu.org>
parents: 43664
diff changeset
680 To delete all trailing whitespace within the current buffer's
74f67ed375f0 Rename Trailing Whitespace to Useless Whitespace
Richard M. Stallman <rms@gnu.org>
parents: 43664
diff changeset
681 accessible portion (@pxref{Narrowing}), type @kbd{M-x
74f67ed375f0 Rename Trailing Whitespace to Useless Whitespace
Richard M. Stallman <rms@gnu.org>
parents: 43664
diff changeset
682 delete-trailing-whitespace @key{RET}}. (This command does not remove
74f67ed375f0 Rename Trailing Whitespace to Useless Whitespace
Richard M. Stallman <rms@gnu.org>
parents: 43664
diff changeset
683 the form-feed characters.)
74f67ed375f0 Rename Trailing Whitespace to Useless Whitespace
Richard M. Stallman <rms@gnu.org>
parents: 43664
diff changeset
684
61411
432f333b0501 (Useless Whitespace): `indicate-unused-lines' is now called
Luc Teirlinck <teirllm@auburn.edu>
parents: 60988
diff changeset
685 @vindex indicate-empty-lines
45877
74f67ed375f0 Rename Trailing Whitespace to Useless Whitespace
Richard M. Stallman <rms@gnu.org>
parents: 43664
diff changeset
686 @vindex default-indicate-empty-lines
48534
4128ae2ce141 indicate-empty-lines => indicate-unused-lines, etc.
Richard M. Stallman <rms@gnu.org>
parents: 47071
diff changeset
687 @cindex unused lines
4128ae2ce141 indicate-empty-lines => indicate-unused-lines, etc.
Richard M. Stallman <rms@gnu.org>
parents: 47071
diff changeset
688 @cindex fringes, and unused line indication
4128ae2ce141 indicate-empty-lines => indicate-unused-lines, etc.
Richard M. Stallman <rms@gnu.org>
parents: 47071
diff changeset
689 Emacs can indicate unused lines at the end of the window with a
4128ae2ce141 indicate-empty-lines => indicate-unused-lines, etc.
Richard M. Stallman <rms@gnu.org>
parents: 47071
diff changeset
690 small image in the left fringe (@pxref{Fringes}). The image appears
4128ae2ce141 indicate-empty-lines => indicate-unused-lines, etc.
Richard M. Stallman <rms@gnu.org>
parents: 47071
diff changeset
691 for window lines that do not correspond to any buffer text. Blank
4128ae2ce141 indicate-empty-lines => indicate-unused-lines, etc.
Richard M. Stallman <rms@gnu.org>
parents: 47071
diff changeset
692 lines at the end of the buffer then stand out because they do not have
4128ae2ce141 indicate-empty-lines => indicate-unused-lines, etc.
Richard M. Stallman <rms@gnu.org>
parents: 47071
diff changeset
693 this image in the fringe.
4128ae2ce141 indicate-empty-lines => indicate-unused-lines, etc.
Richard M. Stallman <rms@gnu.org>
parents: 47071
diff changeset
694
4128ae2ce141 indicate-empty-lines => indicate-unused-lines, etc.
Richard M. Stallman <rms@gnu.org>
parents: 47071
diff changeset
695 To enable this feature, set the buffer-local variable
61411
432f333b0501 (Useless Whitespace): `indicate-unused-lines' is now called
Luc Teirlinck <teirllm@auburn.edu>
parents: 60988
diff changeset
696 @code{indicate-empty-lines} to a non-@code{nil} value. The default
48534
4128ae2ce141 indicate-empty-lines => indicate-unused-lines, etc.
Richard M. Stallman <rms@gnu.org>
parents: 47071
diff changeset
697 value of this variable is controlled by the variable
61411
432f333b0501 (Useless Whitespace): `indicate-unused-lines' is now called
Luc Teirlinck <teirllm@auburn.edu>
parents: 60988
diff changeset
698 @code{default-indicate-empty-lines}; by setting that variable, you
48534
4128ae2ce141 indicate-empty-lines => indicate-unused-lines, etc.
Richard M. Stallman <rms@gnu.org>
parents: 47071
diff changeset
699 can enable or disable this feature for all new buffers. (This feature
4128ae2ce141 indicate-empty-lines => indicate-unused-lines, etc.
Richard M. Stallman <rms@gnu.org>
parents: 47071
diff changeset
700 currently doesn't work on character terminals.)
45877
74f67ed375f0 Rename Trailing Whitespace to Useless Whitespace
Richard M. Stallman <rms@gnu.org>
parents: 43664
diff changeset
701
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
702 @node Follow Mode
Dave Love <fx@gnu.org>
parents:
diff changeset
703 @section Follow Mode
Dave Love <fx@gnu.org>
parents:
diff changeset
704 @cindex Follow mode
Dave Love <fx@gnu.org>
parents:
diff changeset
705 @cindex mode, Follow
36246
fd61c05ce91c Add index entries for Follow mode.
Richard M. Stallman <rms@gnu.org>
parents: 36245
diff changeset
706 @findex follow-mode
fd61c05ce91c Add index entries for Follow mode.
Richard M. Stallman <rms@gnu.org>
parents: 36245
diff changeset
707 @cindex windows, synchronizing
fd61c05ce91c Add index entries for Follow mode.
Richard M. Stallman <rms@gnu.org>
parents: 36245
diff changeset
708 @cindex synchronizing windows
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
709
60104
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
710 @dfn{Follow mode} is a minor mode that makes two windows, both
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
711 showing the same buffer, scroll as a single tall ``virtual window.''
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
712 To use Follow mode, go to a frame with just one window, split it into
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
713 two side-by-side windows using @kbd{C-x 3}, and then type @kbd{M-x
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
714 follow-mode}. From then on, you can edit the buffer in either of the
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
715 two windows, or scroll either one; the other window follows it.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
716
36245
88b40e620f22 Clarify Follow mode.
Richard M. Stallman <rms@gnu.org>
parents: 36181
diff changeset
717 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
718 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
719 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
720 one large window.
88b40e620f22 Clarify Follow mode.
Richard M. Stallman <rms@gnu.org>
parents: 36181
diff changeset
721
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
722 To turn off Follow mode, type @kbd{M-x follow-mode} a second time.
Dave Love <fx@gnu.org>
parents:
diff changeset
723
Dave Love <fx@gnu.org>
parents:
diff changeset
724 @node Selective Display
Dave Love <fx@gnu.org>
parents:
diff changeset
725 @section Selective Display
36263
11db0318031d Remove redundant index entries.
Eli Zaretskii <eliz@gnu.org>
parents: 36260
diff changeset
726 @cindex selective display
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
727 @findex set-selective-display
Dave Love <fx@gnu.org>
parents:
diff changeset
728 @kindex C-x $
Dave Love <fx@gnu.org>
parents:
diff changeset
729
Dave Love <fx@gnu.org>
parents:
diff changeset
730 Emacs has the ability to hide lines indented more than a certain number
Dave Love <fx@gnu.org>
parents:
diff changeset
731 of columns (you specify how many columns). You can use this to get an
Dave Love <fx@gnu.org>
parents:
diff changeset
732 overview of a part of a program.
Dave Love <fx@gnu.org>
parents:
diff changeset
733
62417
6d49a2df78a7 Various minor changes.
Luc Teirlinck <teirllm@auburn.edu>
parents: 61411
diff changeset
734 To hide lines in the current buffer, type @kbd{C-x $}
6d49a2df78a7 Various minor changes.
Luc Teirlinck <teirllm@auburn.edu>
parents: 61411
diff changeset
735 (@code{set-selective-display}) with a numeric argument @var{n}. Then
6d49a2df78a7 Various minor changes.
Luc Teirlinck <teirllm@auburn.edu>
parents: 61411
diff changeset
736 lines with at least @var{n} columns of indentation disappear from the
6d49a2df78a7 Various minor changes.
Luc Teirlinck <teirllm@auburn.edu>
parents: 61411
diff changeset
737 screen. The only indication of their presence is that three dots
6d49a2df78a7 Various minor changes.
Luc Teirlinck <teirllm@auburn.edu>
parents: 61411
diff changeset
738 (@samp{@dots{}}) appear at the end of each visible line that is
6d49a2df78a7 Various minor changes.
Luc Teirlinck <teirllm@auburn.edu>
parents: 61411
diff changeset
739 followed by one or more hidden ones.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
740
Dave Love <fx@gnu.org>
parents:
diff changeset
741 The commands @kbd{C-n} and @kbd{C-p} move across the hidden lines as
Dave Love <fx@gnu.org>
parents:
diff changeset
742 if they were not there.
Dave Love <fx@gnu.org>
parents:
diff changeset
743
Dave Love <fx@gnu.org>
parents:
diff changeset
744 The hidden lines are still present in the buffer, and most editing
Dave Love <fx@gnu.org>
parents:
diff changeset
745 commands see them as usual, so you may find point in the middle of the
Dave Love <fx@gnu.org>
parents:
diff changeset
746 hidden text. When this happens, the cursor appears at the end of the
Dave Love <fx@gnu.org>
parents:
diff changeset
747 previous line, after the three dots. If point is at the end of the
Dave Love <fx@gnu.org>
parents:
diff changeset
748 visible line, before the newline that ends it, the cursor appears before
Dave Love <fx@gnu.org>
parents:
diff changeset
749 the three dots.
Dave Love <fx@gnu.org>
parents:
diff changeset
750
Dave Love <fx@gnu.org>
parents:
diff changeset
751 To make all lines visible again, type @kbd{C-x $} with no argument.
Dave Love <fx@gnu.org>
parents:
diff changeset
752
Dave Love <fx@gnu.org>
parents:
diff changeset
753 @vindex selective-display-ellipses
Dave Love <fx@gnu.org>
parents:
diff changeset
754 If you set the variable @code{selective-display-ellipses} to
Dave Love <fx@gnu.org>
parents:
diff changeset
755 @code{nil}, the three dots do not appear at the end of a line that
Dave Love <fx@gnu.org>
parents:
diff changeset
756 precedes hidden lines. Then there is no visible indication of the
Dave Love <fx@gnu.org>
parents:
diff changeset
757 hidden lines. This variable becomes local automatically when set.
Dave Love <fx@gnu.org>
parents:
diff changeset
758
60104
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
759 See also @ref{Outline Mode} for another way to hide part of
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
760 the text in a buffer.
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
761
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
762 @node Optional Mode Line
Dave Love <fx@gnu.org>
parents:
diff changeset
763 @section Optional Mode Line Features
Dave Love <fx@gnu.org>
parents:
diff changeset
764
52461
030d7903be24 (Optional Mode Line): Document `size-indication-mode'.
Lute Kamstra <lute@gnu.org>
parents: 52401
diff changeset
765 @cindex buffer size display
030d7903be24 (Optional Mode Line): Document `size-indication-mode'.
Lute Kamstra <lute@gnu.org>
parents: 52401
diff changeset
766 @cindex display of buffer size
030d7903be24 (Optional Mode Line): Document `size-indication-mode'.
Lute Kamstra <lute@gnu.org>
parents: 52401
diff changeset
767 @findex size-indication-mode
030d7903be24 (Optional Mode Line): Document `size-indication-mode'.
Lute Kamstra <lute@gnu.org>
parents: 52401
diff changeset
768 The buffer percentage @var{pos} indicates the percentage of the
030d7903be24 (Optional Mode Line): Document `size-indication-mode'.
Lute Kamstra <lute@gnu.org>
parents: 52401
diff changeset
769 buffer above the top of the window. You can additionally display the
030d7903be24 (Optional Mode Line): Document `size-indication-mode'.
Lute Kamstra <lute@gnu.org>
parents: 52401
diff changeset
770 size of the buffer by typing @kbd{M-x size-indication-mode} to turn on
030d7903be24 (Optional Mode Line): Document `size-indication-mode'.
Lute Kamstra <lute@gnu.org>
parents: 52401
diff changeset
771 Size Indication mode. The size will be displayed immediately
030d7903be24 (Optional Mode Line): Document `size-indication-mode'.
Lute Kamstra <lute@gnu.org>
parents: 52401
diff changeset
772 following the buffer percentage like this:
030d7903be24 (Optional Mode Line): Document `size-indication-mode'.
Lute Kamstra <lute@gnu.org>
parents: 52401
diff changeset
773
030d7903be24 (Optional Mode Line): Document `size-indication-mode'.
Lute Kamstra <lute@gnu.org>
parents: 52401
diff changeset
774 @example
030d7903be24 (Optional Mode Line): Document `size-indication-mode'.
Lute Kamstra <lute@gnu.org>
parents: 52401
diff changeset
775 @var{POS} of @var{SIZE}
030d7903be24 (Optional Mode Line): Document `size-indication-mode'.
Lute Kamstra <lute@gnu.org>
parents: 52401
diff changeset
776 @end example
030d7903be24 (Optional Mode Line): Document `size-indication-mode'.
Lute Kamstra <lute@gnu.org>
parents: 52401
diff changeset
777
030d7903be24 (Optional Mode Line): Document `size-indication-mode'.
Lute Kamstra <lute@gnu.org>
parents: 52401
diff changeset
778 @noindent
030d7903be24 (Optional Mode Line): Document `size-indication-mode'.
Lute Kamstra <lute@gnu.org>
parents: 52401
diff changeset
779 Here @var{SIZE} is the human readable representation of the number of
030d7903be24 (Optional Mode Line): Document `size-indication-mode'.
Lute Kamstra <lute@gnu.org>
parents: 52401
diff changeset
780 characters in the buffer, which means that @samp{k} for 10^3, @samp{M}
030d7903be24 (Optional Mode Line): Document `size-indication-mode'.
Lute Kamstra <lute@gnu.org>
parents: 52401
diff changeset
781 for 10^6, @samp{G} for 10^9, etc., are used to abbreviate.
030d7903be24 (Optional Mode Line): Document `size-indication-mode'.
Lute Kamstra <lute@gnu.org>
parents: 52401
diff changeset
782
030d7903be24 (Optional Mode Line): Document `size-indication-mode'.
Lute Kamstra <lute@gnu.org>
parents: 52401
diff changeset
783 @cindex narrowing, and buffer size display
030d7903be24 (Optional Mode Line): Document `size-indication-mode'.
Lute Kamstra <lute@gnu.org>
parents: 52401
diff changeset
784 If you have narrowed the buffer (@pxref{Narrowing}), the size of the
030d7903be24 (Optional Mode Line): Document `size-indication-mode'.
Lute Kamstra <lute@gnu.org>
parents: 52401
diff changeset
785 accessible part of the buffer is shown.
030d7903be24 (Optional Mode Line): Document `size-indication-mode'.
Lute Kamstra <lute@gnu.org>
parents: 52401
diff changeset
786
36150
46e59561af4c Display Vars node renamed Display Custom.
Richard M. Stallman <rms@gnu.org>
parents: 35433
diff changeset
787 @cindex line number display
46e59561af4c Display Vars node renamed Display Custom.
Richard M. Stallman <rms@gnu.org>
parents: 35433
diff changeset
788 @cindex display of line number
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
789 @findex line-number-mode
Dave Love <fx@gnu.org>
parents:
diff changeset
790 The current line number of point appears in the mode line when Line
Dave Love <fx@gnu.org>
parents:
diff changeset
791 Number mode is enabled. Use the command @kbd{M-x line-number-mode} to
Dave Love <fx@gnu.org>
parents:
diff changeset
792 turn this mode on and off; normally it is on. The line number appears
52461
030d7903be24 (Optional Mode Line): Document `size-indication-mode'.
Lute Kamstra <lute@gnu.org>
parents: 52401
diff changeset
793 after the buffer percentage @var{pos}, with the letter @samp{L} to
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
794 indicate what it is. @xref{Minor Modes}, for more information about
Dave Love <fx@gnu.org>
parents:
diff changeset
795 minor modes and about how to use this command.
Dave Love <fx@gnu.org>
parents:
diff changeset
796
38121
82d39521a482 (Optional Mode Line): Document line-number-display-limit-width.
Eli Zaretskii <eliz@gnu.org>
parents: 38115
diff changeset
797 @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
798 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
799 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
800
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
801 @vindex line-number-display-limit
Dave Love <fx@gnu.org>
parents:
diff changeset
802 If the buffer is very large (larger than the value of
Dave Love <fx@gnu.org>
parents:
diff changeset
803 @code{line-number-display-limit}), then the line number doesn't appear.
Dave Love <fx@gnu.org>
parents:
diff changeset
804 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
805 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
806
82d39521a482 (Optional Mode Line): Document line-number-display-limit-width.
Eli Zaretskii <eliz@gnu.org>
parents: 38115
diff changeset
807 @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
808 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
809 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
810 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
811 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
812 @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
813 characters.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
814
Dave Love <fx@gnu.org>
parents:
diff changeset
815 @cindex Column Number mode
Dave Love <fx@gnu.org>
parents:
diff changeset
816 @cindex mode, Column Number
Dave Love <fx@gnu.org>
parents:
diff changeset
817 @findex column-number-mode
Dave Love <fx@gnu.org>
parents:
diff changeset
818 You can also display the current column number by turning on Column
Dave Love <fx@gnu.org>
parents:
diff changeset
819 Number mode. It displays the current column number preceded by the
Dave Love <fx@gnu.org>
parents:
diff changeset
820 letter @samp{C}. Type @kbd{M-x column-number-mode} to toggle this mode.
Dave Love <fx@gnu.org>
parents:
diff changeset
821
Dave Love <fx@gnu.org>
parents:
diff changeset
822 @findex display-time
Dave Love <fx@gnu.org>
parents:
diff changeset
823 @cindex time (on mode line)
Dave Love <fx@gnu.org>
parents:
diff changeset
824 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
825 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
826 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
827 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
828 their parentheses. It looks like this:
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
829
Dave Love <fx@gnu.org>
parents:
diff changeset
830 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
831 @var{hh}:@var{mm}pm @var{l.ll}
Dave Love <fx@gnu.org>
parents:
diff changeset
832 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
833
Dave Love <fx@gnu.org>
parents:
diff changeset
834 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
835 @vindex display-time-24hr-format
Dave Love <fx@gnu.org>
parents:
diff changeset
836 Here @var{hh} and @var{mm} are the hour and minute, followed always by
Dave Love <fx@gnu.org>
parents:
diff changeset
837 @samp{am} or @samp{pm}. @var{l.ll} is the average number of running
Dave Love <fx@gnu.org>
parents:
diff changeset
838 processes in the whole system recently. (Some fields may be missing if
Dave Love <fx@gnu.org>
parents:
diff changeset
839 your operating system cannot support them.) If you prefer time display
Dave Love <fx@gnu.org>
parents:
diff changeset
840 in 24-hour format, set the variable @code{display-time-24hr-format}
Dave Love <fx@gnu.org>
parents:
diff changeset
841 to @code{t}.
Dave Love <fx@gnu.org>
parents:
diff changeset
842
Dave Love <fx@gnu.org>
parents:
diff changeset
843 @cindex mail (on mode line)
28800
d10b6cddbf91 display-time-use-mail-icon
Dave Love <fx@gnu.org>
parents: 27219
diff changeset
844 @vindex display-time-use-mail-icon
d10b6cddbf91 display-time-use-mail-icon
Dave Love <fx@gnu.org>
parents: 27219
diff changeset
845 @vindex display-time-mail-face
45877
74f67ed375f0 Rename Trailing Whitespace to Useless Whitespace
Richard M. Stallman <rms@gnu.org>
parents: 43664
diff changeset
846 @vindex display-time-mail-file
74f67ed375f0 Rename Trailing Whitespace to Useless Whitespace
Richard M. Stallman <rms@gnu.org>
parents: 43664
diff changeset
847 @vindex display-time-mail-directory
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
848 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
849 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
850 an icon instead of @samp{Mail} by customizing
d10b6cddbf91 display-time-use-mail-icon
Dave Love <fx@gnu.org>
parents: 27219
diff changeset
851 @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
852 line. You can customize @code{display-time-mail-face} to make the mail
45877
74f67ed375f0 Rename Trailing Whitespace to Useless Whitespace
Richard M. Stallman <rms@gnu.org>
parents: 43664
diff changeset
853 indicator prominent. Use @code{display-time-mail-file} to specify
74f67ed375f0 Rename Trailing Whitespace to Useless Whitespace
Richard M. Stallman <rms@gnu.org>
parents: 43664
diff changeset
854 the mail file to check, or set @code{display-time-mail-directory}
74f67ed375f0 Rename Trailing Whitespace to Useless Whitespace
Richard M. Stallman <rms@gnu.org>
parents: 43664
diff changeset
855 to specify the directory to check for incoming mail (any nonempty regular
74f67ed375f0 Rename Trailing Whitespace to Useless Whitespace
Richard M. Stallman <rms@gnu.org>
parents: 43664
diff changeset
856 file in the directory is considered as ``newly arrived mail'').
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
857
39267
a8c0a02f6129 Spelling corrections.
Richard M. Stallman <rms@gnu.org>
parents: 39162
diff changeset
858 @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
859 @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
860 @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
861 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
862 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
863 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
864 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
865 @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
866
1777865bdb98 (Optional Mode Line): Explain how to turn off the 3D appearence of
Eli Zaretskii <eliz@gnu.org>
parents: 34749
diff changeset
867 @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
868 (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
869 @end example
1777865bdb98 (Optional Mode Line): Explain how to turn off the 3D appearence of
Eli Zaretskii <eliz@gnu.org>
parents: 34749
diff changeset
870
1777865bdb98 (Optional Mode Line): Explain how to turn off the 3D appearence of
Eli Zaretskii <eliz@gnu.org>
parents: 34749
diff changeset
871 @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
872 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
873 @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
874
1777865bdb98 (Optional Mode Line): Explain how to turn off the 3D appearence of
Eli Zaretskii <eliz@gnu.org>
parents: 34749
diff changeset
875 @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
876 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
877 @end example
1777865bdb98 (Optional Mode Line): Explain how to turn off the 3D appearence of
Eli Zaretskii <eliz@gnu.org>
parents: 34749
diff changeset
878
43260
59e700c2760c (Faces): Document the mode-line-inactive face.
Eli Zaretskii <eliz@gnu.org>
parents: 43101
diff changeset
879 @cindex non-selected windows, mode line appearance
43289
0c1cdf6e7ef1 Minor clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 43283
diff changeset
880 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
881 different face, called @code{mode-line-inactive}. Only the selected
43289
0c1cdf6e7ef1 Minor clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 43283
diff changeset
882 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
883 which window is selected. When the minibuffer is selected, since
0c1cdf6e7ef1 Minor clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 43283
diff changeset
884 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
885 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
886 ordinary entry to the minibuffer does not change any mode lines.
0c1cdf6e7ef1 Minor clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 43283
diff changeset
887
0c1cdf6e7ef1 Minor clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 43283
diff changeset
888 @vindex mode-line-in-non-selected-windows
0c1cdf6e7ef1 Minor clarifications.
Richard M. Stallman <rms@gnu.org>
parents: 43283
diff changeset
889 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
890 @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
891 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
892
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
893 @node Text Display
Dave Love <fx@gnu.org>
parents:
diff changeset
894 @section How Text Is Displayed
Dave Love <fx@gnu.org>
parents:
diff changeset
895 @cindex characters (in text)
Dave Love <fx@gnu.org>
parents:
diff changeset
896
52979
3649390c0f91 Replace @sc{ascii} and ASCII with @acronym{ASCII}.
Eli Zaretskii <eliz@gnu.org>
parents: 52461
diff changeset
897 @acronym{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
898 buffers are displayed with their graphics, as are non-ASCII multibyte
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
899 printing characters (octal codes above 0400).
Dave Love <fx@gnu.org>
parents:
diff changeset
900
52979
3649390c0f91 Replace @sc{ascii} and ASCII with @acronym{ASCII}.
Eli Zaretskii <eliz@gnu.org>
parents: 52461
diff changeset
901 Some @acronym{ASCII} control characters are displayed in special ways. The
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
902 newline character (octal code 012) is displayed by starting a new line.
Dave Love <fx@gnu.org>
parents:
diff changeset
903 The tab character (octal code 011) is displayed by moving to the next
Dave Love <fx@gnu.org>
parents:
diff changeset
904 tab stop column (normally every 8 columns).
Dave Love <fx@gnu.org>
parents:
diff changeset
905
52979
3649390c0f91 Replace @sc{ascii} and ASCII with @acronym{ASCII}.
Eli Zaretskii <eliz@gnu.org>
parents: 52461
diff changeset
906 Other @acronym{ASCII} control characters are normally displayed as a caret
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
907 (@samp{^}) followed by the non-control version of the character; thus,
Dave Love <fx@gnu.org>
parents:
diff changeset
908 control-A is displayed as @samp{^A}.
Dave Love <fx@gnu.org>
parents:
diff changeset
909
52979
3649390c0f91 Replace @sc{ascii} and ASCII with @acronym{ASCII}.
Eli Zaretskii <eliz@gnu.org>
parents: 52461
diff changeset
910 Non-@acronym{ASCII} characters 0200 through 0237 (octal) are displayed with
33744
67204e92850a Tweak non-ASCII display.
Dave Love <fx@gnu.org>
parents: 33730
diff changeset
911 octal escape sequences; thus, character code 0230 (octal) is displayed
67204e92850a Tweak non-ASCII display.
Dave Love <fx@gnu.org>
parents: 33730
diff changeset
912 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
913 (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
914 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
915 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
916 they are displayed using their graphics (assuming your terminal supports
67204e92850a Tweak non-ASCII display.
Dave Love <fx@gnu.org>
parents: 33730
diff changeset
917 them), otherwise as escape sequences. @xref{Single-Byte Character
67204e92850a Tweak non-ASCII display.
Dave Love <fx@gnu.org>
parents: 33730
diff changeset
918 Support}.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
919
60950
c7ee76ed1a51 (Text Display): Mention non-breaking spaces.
Richard M. Stallman <rms@gnu.org>
parents: 60857
diff changeset
920 @vindex show-nonbreak-escape
60988
f79ed513cc6e (Text Display): Add index entries for how no-break characters are displayed.
Eli Zaretskii <eliz@gnu.org>
parents: 60950
diff changeset
921 @cindex no-break space, display
f79ed513cc6e (Text Display): Add index entries for how no-break characters are displayed.
Eli Zaretskii <eliz@gnu.org>
parents: 60950
diff changeset
922 @cindex no-break hyphen, display
f79ed513cc6e (Text Display): Add index entries for how no-break characters are displayed.
Eli Zaretskii <eliz@gnu.org>
parents: 60950
diff changeset
923 Some character sets define ``no-break'' versions of the space
60950
c7ee76ed1a51 (Text Display): Mention non-breaking spaces.
Richard M. Stallman <rms@gnu.org>
parents: 60857
diff changeset
924 and hyphen characters, which are used where a line should not be
c7ee76ed1a51 (Text Display): Mention non-breaking spaces.
Richard M. Stallman <rms@gnu.org>
parents: 60857
diff changeset
925 broken. Emacs displays these with an escape character in order to
c7ee76ed1a51 (Text Display): Mention non-breaking spaces.
Richard M. Stallman <rms@gnu.org>
parents: 60857
diff changeset
926 distinguish them from ordinary spaces and hyphens. For example, a
c7ee76ed1a51 (Text Display): Mention non-breaking spaces.
Richard M. Stallman <rms@gnu.org>
parents: 60857
diff changeset
927 non-breaking space is displayed as @samp{\ }. You can turn off this
c7ee76ed1a51 (Text Display): Mention non-breaking spaces.
Richard M. Stallman <rms@gnu.org>
parents: 60857
diff changeset
928 behavior by setting the variable @code{show-nonbreak-escape} to
c7ee76ed1a51 (Text Display): Mention non-breaking spaces.
Richard M. Stallman <rms@gnu.org>
parents: 60857
diff changeset
929 @code{nil}.
c7ee76ed1a51 (Text Display): Mention non-breaking spaces.
Richard M. Stallman <rms@gnu.org>
parents: 60857
diff changeset
930
60104
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
931 @node Cursor Display
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
932 @section Displaying the Cursor
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
933
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
934 @findex blink-cursor-mode
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
935 @vindex blink-cursor-alist
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
936 @cindex cursor, locating visually
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
937 @cindex cursor, blinking
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
938 You can customize the cursor's color, and whether it blinks, using
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
939 the @code{cursor} Custom group (@pxref{Easy Customization}). On
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
940 graphical terminals, the command @kbd{M-x blink-cursor-mode} enables
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
941 or disables the blinking of the cursor. (On text terminals, the
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
942 terminal itself blinks the cursor, and Emacs has no control over it.)
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
943 You can control how the cursor appears when it blinks off by setting
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
944 the variable @code{blink-cursor-alist}.
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
945
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
946 @cindex cursor in non-selected windows
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
947 @vindex cursor-in-non-selected-windows
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
948 Normally, the cursor appears in non-selected windows in the ``off''
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
949 state, with the same appearance as when the blinking cursor blinks
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
950 ``off''. For a box cursor, this is a hollow box; for a bar cursor,
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
951 this is a thinner bar. To turn off cursors in non-selected windows,
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
952 customize the variable @code{cursor-in-non-selected-windows} and assign
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
953 it a @code{nil} value.
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
954
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
955 @vindex x-stretch-cursor
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
956 @cindex wide block cursor
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
957 On graphical terminals, Emacs can optionally draw the block cursor
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
958 as wide as the character under the cursor---for example, if the cursor
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
959 is on a tab character, it would cover the full width occupied by that
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
960 tab character. To enable this feature, set the variable
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
961 @code{x-stretch-cursor} to a non-@code{nil} value.
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
962
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
963 @findex hl-line-mode
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
964 @findex global-hl-line-mode
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
965 @cindex highlight current line
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
966 If you find it hard to see the cursor, you might like HL Line mode,
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
967 a minor mode that highlights the line containing point. Use @kbd{M-x
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
968 hl-line-mode} to enable or disable it in the current buffer. @kbd{M-x
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
969 global-hl-line-mode} enables or disables the same mode globally.
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
970
36150
46e59561af4c Display Vars node renamed Display Custom.
Richard M. Stallman <rms@gnu.org>
parents: 35433
diff changeset
971 @node Display Custom
46e59561af4c Display Vars node renamed Display Custom.
Richard M. Stallman <rms@gnu.org>
parents: 35433
diff changeset
972 @section Customization of Display
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
973
Dave Love <fx@gnu.org>
parents:
diff changeset
974 This section contains information for customization only. Beginning
Dave Love <fx@gnu.org>
parents:
diff changeset
975 users should skip it.
Dave Love <fx@gnu.org>
parents:
diff changeset
976
Dave Love <fx@gnu.org>
parents:
diff changeset
977 @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
978 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
979 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
980 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
981 @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
982 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
983 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
984 @xref{Faces}.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
985
Dave Love <fx@gnu.org>
parents:
diff changeset
986 @vindex inverse-video
Dave Love <fx@gnu.org>
parents:
diff changeset
987 If the variable @code{inverse-video} is non-@code{nil}, Emacs attempts
Dave Love <fx@gnu.org>
parents:
diff changeset
988 to invert all the lines of the display from what they normally are.
Dave Love <fx@gnu.org>
parents:
diff changeset
989
Dave Love <fx@gnu.org>
parents:
diff changeset
990 @vindex visible-bell
Dave Love <fx@gnu.org>
parents:
diff changeset
991 If the variable @code{visible-bell} is non-@code{nil}, Emacs attempts
Dave Love <fx@gnu.org>
parents:
diff changeset
992 to make the whole screen blink when it would normally make an audible bell
Dave Love <fx@gnu.org>
parents:
diff changeset
993 sound. This variable has no effect if your terminal does not have a way
60104
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
994 to make the screen blink.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
995
Dave Love <fx@gnu.org>
parents:
diff changeset
996 @vindex no-redraw-on-reenter
60104
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
997 On a text terminal, when you reenter Emacs after suspending, Emacs
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
998 normally clears the screen and redraws the entire display. On some
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
999 terminals with more than one page of memory, it is possible to arrange
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
1000 the termcap entry so that the @samp{ti} and @samp{te} strings (output
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
1001 to the terminal when Emacs is entered and exited, respectively) switch
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
1002 between pages of memory so as to use one page for Emacs and another
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
1003 page for other output. Then you might want to set the variable
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
1004 @code{no-redraw-on-reenter} non-@code{nil}; this tells Emacs to
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
1005 assume, when resumed, that the screen page it is using still contains
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
1006 what Emacs last wrote there.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1007
Dave Love <fx@gnu.org>
parents:
diff changeset
1008 @vindex echo-keystrokes
Dave Love <fx@gnu.org>
parents:
diff changeset
1009 The variable @code{echo-keystrokes} controls the echoing of multi-character
Dave Love <fx@gnu.org>
parents:
diff changeset
1010 keys; its value is the number of seconds of pause required to cause echoing
Dave Love <fx@gnu.org>
parents:
diff changeset
1011 to start, or zero meaning don't echo at all. @xref{Echo Area}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1012
Dave Love <fx@gnu.org>
parents:
diff changeset
1013 @vindex ctl-arrow
38048
bd45e6c57fba Proofreading fixes from Danny Colascione <qtmstr@optonline.net>.
Eli Zaretskii <eliz@gnu.org>
parents: 37485
diff changeset
1014 If the variable @code{ctl-arrow} is @code{nil}, all control characters in
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1015 the buffer are displayed with octal escape sequences, except for newline
Dave Love <fx@gnu.org>
parents:
diff changeset
1016 and tab. Altering the value of @code{ctl-arrow} makes it local to the
Dave Love <fx@gnu.org>
parents:
diff changeset
1017 current buffer; until that time, the default value is in effect. The
Dave Love <fx@gnu.org>
parents:
diff changeset
1018 default is initially @code{t}. @xref{Display Tables,, Display Tables,
Dave Love <fx@gnu.org>
parents:
diff changeset
1019 elisp, The Emacs Lisp Reference Manual}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1020
Dave Love <fx@gnu.org>
parents:
diff changeset
1021 @vindex tab-width
60104
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
1022 @vindex default-tab-width
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1023 Normally, a tab character in the buffer is displayed as whitespace which
Dave Love <fx@gnu.org>
parents:
diff changeset
1024 extends to the next display tab stop position, and display tab stops come
Dave Love <fx@gnu.org>
parents:
diff changeset
1025 at intervals equal to eight spaces. The number of spaces per tab is
Dave Love <fx@gnu.org>
parents:
diff changeset
1026 controlled by the variable @code{tab-width}, which is made local by
Dave Love <fx@gnu.org>
parents:
diff changeset
1027 changing it, just like @code{ctl-arrow}. Note that how the tab character
Dave Love <fx@gnu.org>
parents:
diff changeset
1028 in the buffer is displayed has nothing to do with the definition of
Dave Love <fx@gnu.org>
parents:
diff changeset
1029 @key{TAB} as a command. The variable @code{tab-width} must have an
60104
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
1030 integer value between 1 and 1000, inclusive. The variable
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
1031 @code{default-tab-width} controls the default value of this variable
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
1032 for buffers where you have not set it locally.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1033
60104
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
1034 @cindex truncation
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
1035 @cindex line truncation, and fringes
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
1036 As an alternative to continuation, Emacs can display long lines by
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
1037 @dfn{truncation}. This means that all the characters that do not fit
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
1038 in the width of the screen or window do not appear at all. On
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
1039 graphical terminals, a small straight arrow in the fringe indicates
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
1040 truncation at either end of the line. On text terminals, @samp{$}
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
1041 appears in the first column when there is text truncated to the left,
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
1042 and in the last column when there is text truncated to the right.
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
1043
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
1044 @vindex truncate-lines
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
1045 @findex toggle-truncate-lines
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
1046 Horizontal scrolling automatically causes line truncation
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
1047 (@pxref{Horizontal Scrolling}). You can explicitly enable line
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
1048 truncation for a particular buffer with the command @kbd{M-x
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
1049 toggle-truncate-lines}. This works by locally changing the variable
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
1050 @code{truncate-lines}. If that variable is non-@code{nil}, long lines
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
1051 are truncated; if it is @code{nil}, they are continued onto multiple
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
1052 screen lines. Setting the variable @code{truncate-lines} in any way
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
1053 makes it local to the current buffer; until that time, the default
8116a5e9f2a1 (Display): Reorder menu.
Richard M. Stallman <rms@gnu.org>
parents: 59796
diff changeset
1054 value is in effect. The default value is normally @code{nil}.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1055
Dave Love <fx@gnu.org>
parents:
diff changeset
1056 @c @vindex truncate-partial-width-windows @c Idx entry is in Split Windows.
Dave Love <fx@gnu.org>
parents:
diff changeset
1057 If the variable @code{truncate-partial-width-windows} is
Dave Love <fx@gnu.org>
parents:
diff changeset
1058 non-@code{nil}, it forces truncation rather than continuation in any
Dave Love <fx@gnu.org>
parents:
diff changeset
1059 window less than the full width of the screen or frame, regardless of
Dave Love <fx@gnu.org>
parents:
diff changeset
1060 the value of @code{truncate-lines}. For information about side-by-side
Dave Love <fx@gnu.org>
parents:
diff changeset
1061 windows, see @ref{Split Window}. See also @ref{Display,, Display,
Dave Love <fx@gnu.org>
parents:
diff changeset
1062 elisp, The Emacs Lisp Reference Manual}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1063
57194
4871edb9e1d3 (Display Custom): Add `overflow-newline-into-fringe',
Kim F. Storm <storm@cua.dk>
parents: 56779
diff changeset
1064 @vindex overflow-newline-into-fringe
4871edb9e1d3 (Display Custom): Add `overflow-newline-into-fringe',
Kim F. Storm <storm@cua.dk>
parents: 56779
diff changeset
1065 If the variable @code{overflow-newline-into-fringe} is
4871edb9e1d3 (Display Custom): Add `overflow-newline-into-fringe',
Kim F. Storm <storm@cua.dk>
parents: 56779
diff changeset
1066 non-@code{nil} on a window system, it specifies that lines which are
4871edb9e1d3 (Display Custom): Add `overflow-newline-into-fringe',
Kim F. Storm <storm@cua.dk>
parents: 56779
diff changeset
1067 exactly as wide as the window (not counting the final newline
4871edb9e1d3 (Display Custom): Add `overflow-newline-into-fringe',
Kim F. Storm <storm@cua.dk>
parents: 56779
diff changeset
1068 character) shall not be broken into two lines on the display (with
4871edb9e1d3 (Display Custom): Add `overflow-newline-into-fringe',
Kim F. Storm <storm@cua.dk>
parents: 56779
diff changeset
1069 just the newline on the second line). Instead, the newline
4871edb9e1d3 (Display Custom): Add `overflow-newline-into-fringe',
Kim F. Storm <storm@cua.dk>
parents: 56779
diff changeset
1070 overflows into the right fringe, and the cursor will be displayed in
4871edb9e1d3 (Display Custom): Add `overflow-newline-into-fringe',
Kim F. Storm <storm@cua.dk>
parents: 56779
diff changeset
1071 the fringe when positioned on that newline.
4871edb9e1d3 (Display Custom): Add `overflow-newline-into-fringe',
Kim F. Storm <storm@cua.dk>
parents: 56779
diff changeset
1072
4871edb9e1d3 (Display Custom): Add `overflow-newline-into-fringe',
Kim F. Storm <storm@cua.dk>
parents: 56779
diff changeset
1073 @vindex indicate-buffer-boundaries
4871edb9e1d3 (Display Custom): Add `overflow-newline-into-fringe',
Kim F. Storm <storm@cua.dk>
parents: 56779
diff changeset
1074 On a window system, Emacs may indicate the buffer boundaries in the
4871edb9e1d3 (Display Custom): Add `overflow-newline-into-fringe',
Kim F. Storm <storm@cua.dk>
parents: 56779
diff changeset
1075 fringes. The buffer boundaries, i.e. first and last line in the
4871edb9e1d3 (Display Custom): Add `overflow-newline-into-fringe',
Kim F. Storm <storm@cua.dk>
parents: 56779
diff changeset
1076 buffer, can be marked with angle bitmaps in the left or right fringe.
4871edb9e1d3 (Display Custom): Add `overflow-newline-into-fringe',
Kim F. Storm <storm@cua.dk>
parents: 56779
diff changeset
1077 This can be combined with up and down arrow bitmaps shown at the top
4871edb9e1d3 (Display Custom): Add `overflow-newline-into-fringe',
Kim F. Storm <storm@cua.dk>
parents: 56779
diff changeset
1078 and bottom of the left or right fringe if the window can be scrolled
4871edb9e1d3 (Display Custom): Add `overflow-newline-into-fringe',
Kim F. Storm <storm@cua.dk>
parents: 56779
diff changeset
1079 in either direction.
4871edb9e1d3 (Display Custom): Add `overflow-newline-into-fringe',
Kim F. Storm <storm@cua.dk>
parents: 56779
diff changeset
1080
57251
f4a2067d260e (Display Custom) <indicate-buffer-boundaries>:
Kim F. Storm <storm@cua.dk>
parents: 57200
diff changeset
1081 The buffer-local variable @code{indicate-buffer-boundaries} controls
57194
4871edb9e1d3 (Display Custom): Add `overflow-newline-into-fringe',
Kim F. Storm <storm@cua.dk>
parents: 56779
diff changeset
1082 how the buffer boundaries and window scrolling is indicated in the
4871edb9e1d3 (Display Custom): Add `overflow-newline-into-fringe',
Kim F. Storm <storm@cua.dk>
parents: 56779
diff changeset
1083 fringes.
4871edb9e1d3 (Display Custom): Add `overflow-newline-into-fringe',
Kim F. Storm <storm@cua.dk>
parents: 56779
diff changeset
1084
57251
f4a2067d260e (Display Custom) <indicate-buffer-boundaries>:
Kim F. Storm <storm@cua.dk>
parents: 57200
diff changeset
1085 If the value is @code{left} or @code{right}, both angle and arrow
57194
4871edb9e1d3 (Display Custom): Add `overflow-newline-into-fringe',
Kim F. Storm <storm@cua.dk>
parents: 56779
diff changeset
1086 bitmaps are displayed in the left or right fringe, respectively.
4871edb9e1d3 (Display Custom): Add `overflow-newline-into-fringe',
Kim F. Storm <storm@cua.dk>
parents: 56779
diff changeset
1087
57251
f4a2067d260e (Display Custom) <indicate-buffer-boundaries>:
Kim F. Storm <storm@cua.dk>
parents: 57200
diff changeset
1088 If value is an alist, each element @code{(@var{indicator} .
f4a2067d260e (Display Custom) <indicate-buffer-boundaries>:
Kim F. Storm <storm@cua.dk>
parents: 57200
diff changeset
1089 @var{position})} specifies the position of one of the indicators.
f4a2067d260e (Display Custom) <indicate-buffer-boundaries>:
Kim F. Storm <storm@cua.dk>
parents: 57200
diff changeset
1090 The @var{indicator} must be one of @code{top}, @code{bottom},
f4a2067d260e (Display Custom) <indicate-buffer-boundaries>:
Kim F. Storm <storm@cua.dk>
parents: 57200
diff changeset
1091 @code{up}, @code{down}, or @code{t} which specifies the default
f4a2067d260e (Display Custom) <indicate-buffer-boundaries>:
Kim F. Storm <storm@cua.dk>
parents: 57200
diff changeset
1092 position for the indicators not present in the alist.
62571
e2ddd55fafc1 (Display Custom): Correct typo.
Luc Teirlinck <teirllm@auburn.edu>
parents: 62417
diff changeset
1093 The @var{position} is one of @code{left}, @code{right}, or @code{nil}
57251
f4a2067d260e (Display Custom) <indicate-buffer-boundaries>:
Kim F. Storm <storm@cua.dk>
parents: 57200
diff changeset
1094 which specifies not to show this indicator.
f4a2067d260e (Display Custom) <indicate-buffer-boundaries>:
Kim F. Storm <storm@cua.dk>
parents: 57200
diff changeset
1095
f4a2067d260e (Display Custom) <indicate-buffer-boundaries>:
Kim F. Storm <storm@cua.dk>
parents: 57200
diff changeset
1096 For example, @code{((top . left) (t . right))} places the top angle
f4a2067d260e (Display Custom) <indicate-buffer-boundaries>:
Kim F. Storm <storm@cua.dk>
parents: 57200
diff changeset
1097 bitmap in left fringe, the bottom angle bitmap in right fringe, and
f4a2067d260e (Display Custom) <indicate-buffer-boundaries>:
Kim F. Storm <storm@cua.dk>
parents: 57200
diff changeset
1098 both arrow bitmaps in right fringe. To show just the angle bitmaps in
f4a2067d260e (Display Custom) <indicate-buffer-boundaries>:
Kim F. Storm <storm@cua.dk>
parents: 57200
diff changeset
1099 the left fringe, but no arrow bitmaps, use @code{((top . left)
f4a2067d260e (Display Custom) <indicate-buffer-boundaries>:
Kim F. Storm <storm@cua.dk>
parents: 57200
diff changeset
1100 (bottom . left))}.
57194
4871edb9e1d3 (Display Custom): Add `overflow-newline-into-fringe',
Kim F. Storm <storm@cua.dk>
parents: 56779
diff changeset
1101
4871edb9e1d3 (Display Custom): Add `overflow-newline-into-fringe',
Kim F. Storm <storm@cua.dk>
parents: 56779
diff changeset
1102 @vindex default-indicate-buffer-boundaries
4871edb9e1d3 (Display Custom): Add `overflow-newline-into-fringe',
Kim F. Storm <storm@cua.dk>
parents: 56779
diff changeset
1103 The value of the variable @code{default-indicate-buffer-boundaries}
4871edb9e1d3 (Display Custom): Add `overflow-newline-into-fringe',
Kim F. Storm <storm@cua.dk>
parents: 56779
diff changeset
1104 is the default value for @code{indicate-buffer-boundaries} in buffers
4871edb9e1d3 (Display Custom): Add `overflow-newline-into-fringe',
Kim F. Storm <storm@cua.dk>
parents: 56779
diff changeset
1105 that do not override it.
4871edb9e1d3 (Display Custom): Add `overflow-newline-into-fringe',
Kim F. Storm <storm@cua.dk>
parents: 56779
diff changeset
1106
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1107 @vindex baud-rate
36151
8597da1b1ab7 Minor changes in previous change.
Richard M. Stallman <rms@gnu.org>
parents: 36150
diff changeset
1108 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
1109 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
1110 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
1111 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
1112 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
1113 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
1114
36150
46e59561af4c Display Vars node renamed Display Custom.
Richard M. Stallman <rms@gnu.org>
parents: 35433
diff changeset
1115 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
1116 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
1117 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
1118 will be done less frequently.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1119
Dave Love <fx@gnu.org>
parents:
diff changeset
1120 You can customize the way any particular character code is displayed
Dave Love <fx@gnu.org>
parents:
diff changeset
1121 by means of a display table. @xref{Display Tables,, Display Tables,
Dave Love <fx@gnu.org>
parents:
diff changeset
1122 elisp, The Emacs Lisp Reference Manual}.
36150
46e59561af4c Display Vars node renamed Display Custom.
Richard M. Stallman <rms@gnu.org>
parents: 35433
diff changeset
1123
36260
0d7feed66bac busy-cursor -> hourglass.
Gerd Moellmann <gerd@gnu.org>
parents: 36246
diff changeset
1124 @cindex hourglass pointer display
0d7feed66bac busy-cursor -> hourglass.
Gerd Moellmann <gerd@gnu.org>
parents: 36246
diff changeset
1125 @vindex hourglass-delay
36156
3a9de976b35c Delete info on Font Lock Support Modes.
Richard M. Stallman <rms@gnu.org>
parents: 36151
diff changeset
1126 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
1127 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
1128 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
1129 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
1130 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
1131
39162
af44a4698df4 Describe tty-suppress-bold-inverse-default-colors.
Richard M. Stallman <rms@gnu.org>
parents: 38939
diff changeset
1132 @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
1133 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
1134 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
1135 @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
1136 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
1137
52401
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 51810
diff changeset
1138 @ignore
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 51810
diff changeset
1139 arch-tag: 2219f910-2ff0-4521-b059-1bd231a536c4
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 51810
diff changeset
1140 @end ignore