annotate man/frames.texi @ 34868:f3c217d2fc2e

*** empty log message ***
author Eli Zaretskii <eliz@gnu.org>
date Wed, 27 Dec 2000 14:08:34 +0000
parents ae23bd13d2ee
children 94d46968a93f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1 @c This is part of the Emacs manual.
28126
e7cf77f27506 Fix copyright line.
Dave Love <fx@gnu.org>
parents: 28124
diff changeset
2 @c Copyright (C) 1985, 86, 87, 93, 94, 95, 97, 99, 2000
e7cf77f27506 Fix copyright line.
Dave Love <fx@gnu.org>
parents: 28124
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 Frames, International, Windows, Top
Dave Love <fx@gnu.org>
parents:
diff changeset
6 @chapter Frames and X Windows
Dave Love <fx@gnu.org>
parents:
diff changeset
7 @cindex frames
Dave Love <fx@gnu.org>
parents:
diff changeset
8
Dave Love <fx@gnu.org>
parents:
diff changeset
9 When using the X Window System, you can create multiple windows at the
Dave Love <fx@gnu.org>
parents:
diff changeset
10 X level in a single Emacs session. Each X window that belongs to Emacs
Dave Love <fx@gnu.org>
parents:
diff changeset
11 displays a @dfn{frame} which can contain one or several Emacs windows.
Dave Love <fx@gnu.org>
parents:
diff changeset
12 A frame initially contains a single general-purpose Emacs window which
Dave Love <fx@gnu.org>
parents:
diff changeset
13 you can subdivide vertically or horizontally into smaller windows. A
Dave Love <fx@gnu.org>
parents:
diff changeset
14 frame normally contains its own echo area and minibuffer, but you can
Dave Love <fx@gnu.org>
parents:
diff changeset
15 make frames that don't have these---they use the echo area and
Dave Love <fx@gnu.org>
parents:
diff changeset
16 minibuffer of another frame.
Dave Love <fx@gnu.org>
parents:
diff changeset
17
Dave Love <fx@gnu.org>
parents:
diff changeset
18 Editing you do in one frame also affects the other frames. For
Dave Love <fx@gnu.org>
parents:
diff changeset
19 instance, if you put text in the kill ring in one frame, you can yank it
Dave Love <fx@gnu.org>
parents:
diff changeset
20 in another frame. If you exit Emacs through @kbd{C-x C-c} in one frame,
Dave Love <fx@gnu.org>
parents:
diff changeset
21 it terminates all the frames. To delete just one frame, use @kbd{C-x 5
Dave Love <fx@gnu.org>
parents:
diff changeset
22 0}.
Dave Love <fx@gnu.org>
parents:
diff changeset
23
Dave Love <fx@gnu.org>
parents:
diff changeset
24 To avoid confusion, we reserve the word ``window'' for the
Dave Love <fx@gnu.org>
parents:
diff changeset
25 subdivisions that Emacs implements, and never use it to refer to a
Dave Love <fx@gnu.org>
parents:
diff changeset
26 frame.
Dave Love <fx@gnu.org>
parents:
diff changeset
27
Dave Love <fx@gnu.org>
parents:
diff changeset
28 Emacs compiled for MS-DOS emulates some aspects of the window system
Dave Love <fx@gnu.org>
parents:
diff changeset
29 so that you can use many of the features described in this chapter.
Dave Love <fx@gnu.org>
parents:
diff changeset
30 @xref{MS-DOS Input}, for more information.
Dave Love <fx@gnu.org>
parents:
diff changeset
31
27224
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
32 @cindex MS Windows
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
33 Emacs compiled for MS Windows mostly supports the same features as
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
34 under X.
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
35
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
36 Features which rely on text in multiple faces (such as Font Lock mode)
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
37 will also work on non-windowed terminals that can display more than one
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
38 face, whether by colors or underlining and emboldening, such as the
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
39 Linux console. Emacs determines automatically whether the terminal has
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
40 such support.
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
41
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
42 @menu
Dave Love <fx@gnu.org>
parents:
diff changeset
43 * Mouse Commands:: Moving, cutting, and pasting, with the mouse.
Dave Love <fx@gnu.org>
parents:
diff changeset
44 * Secondary Selection:: Cutting without altering point and mark.
33920
9fd4e6727f6b (Clipboard): New.
Dave Love <fx@gnu.org>
parents: 32274
diff changeset
45 * Clipboard:: Using the clipboard for selections.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
46 * Mouse References:: Using the mouse to select an item from a list.
Dave Love <fx@gnu.org>
parents:
diff changeset
47 * Menu Mouse Clicks:: Mouse clicks that bring up menus.
Dave Love <fx@gnu.org>
parents:
diff changeset
48 * Mode Line Mouse:: Mouse clicks on the mode line.
Dave Love <fx@gnu.org>
parents:
diff changeset
49 * Speedbar:: How to make and use a speedbar frame.
Dave Love <fx@gnu.org>
parents:
diff changeset
50 * Creating Frames:: Creating additional Emacs frames with various contents.
Dave Love <fx@gnu.org>
parents:
diff changeset
51 * Multiple Displays:: How one Emacs job can talk to several displays.
Dave Love <fx@gnu.org>
parents:
diff changeset
52 * Special Buffer Frames:: You can make certain buffers have their own frames.
Dave Love <fx@gnu.org>
parents:
diff changeset
53 * Frame Parameters:: Changing the colors and other modes of frames.
Dave Love <fx@gnu.org>
parents:
diff changeset
54 * Scroll Bars:: How to enable and disable scroll bars; how to use them.
27224
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
55 * Wheeled Mice:: Using mouse wheels for scrolling.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
56 * Menu Bars:: Enabling and disabling the menu bar.
31609
f5c313af6821 Tool bar, mention c-mouse-3.
Dave Love <fx@gnu.org>
parents: 31187
diff changeset
57 * Tool Bars:: Enabling and disabling the tool bar.
27224
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
58 * Dialog Boxes:: Controlling use of dialog boxes.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
59 * Faces:: How to change the display style using faces.
Dave Love <fx@gnu.org>
parents:
diff changeset
60 * Font Lock:: Minor mode for syntactic highlighting using faces.
Dave Love <fx@gnu.org>
parents:
diff changeset
61 * Support Modes:: Font Lock support modes make Font Lock faster.
Dave Love <fx@gnu.org>
parents:
diff changeset
62 * Highlight Changes:: Using colors to show where you changed the buffer.
30583
c7e7209535ae (Highlight Interactively): Document the hi-lock mode.
Eli Zaretskii <eliz@gnu.org>
parents: 29800
diff changeset
63 * Highlight Interactively:: Tell Emacs what text to highlight.
27224
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
64 * Trailing Whitespace:: Showing possibly-spurious trailing whitespace.
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
65 * Tooltips:: Showing `tooltips', AKA `ballon help' for active text.
28124
eef598a6a330 (Mouse Avoidance): New section.
Dave Love <fx@gnu.org>
parents: 27224
diff changeset
66 * Mouse Avoidance:: Moving the mouse pointer out of the way.
27224
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
67 * Misc X:: Iconifying and deleting frames.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
68 * Non-Window Terminals:: Multiple frames on terminals that show only one.
27224
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
69 * XTerm Mouse:: Using the mouse in an XTerm terminal emulator.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
70 @end menu
Dave Love <fx@gnu.org>
parents:
diff changeset
71
Dave Love <fx@gnu.org>
parents:
diff changeset
72 @node Mouse Commands
Dave Love <fx@gnu.org>
parents:
diff changeset
73 @section Mouse Commands for Editing
Dave Love <fx@gnu.org>
parents:
diff changeset
74 @cindex mouse buttons (what they do)
Dave Love <fx@gnu.org>
parents:
diff changeset
75
Dave Love <fx@gnu.org>
parents:
diff changeset
76 The mouse commands for selecting and copying a region are mostly
Dave Love <fx@gnu.org>
parents:
diff changeset
77 compatible with the @code{xterm} program. You can use the same mouse
Dave Love <fx@gnu.org>
parents:
diff changeset
78 commands for copying between Emacs and other X client programs.
Dave Love <fx@gnu.org>
parents:
diff changeset
79
Dave Love <fx@gnu.org>
parents:
diff changeset
80 @kindex DELETE
Dave Love <fx@gnu.org>
parents:
diff changeset
81 If you select a region with any of these mouse commands, and then
Dave Love <fx@gnu.org>
parents:
diff changeset
82 immediately afterward type the @key{DELETE} function key, it deletes the
Dave Love <fx@gnu.org>
parents:
diff changeset
83 region that you selected. The @key{BACKSPACE} function key and the
Dave Love <fx@gnu.org>
parents:
diff changeset
84 ASCII character @key{DEL} do not do this; if you type any other key
Dave Love <fx@gnu.org>
parents:
diff changeset
85 in between the mouse command and @key{DELETE}, it does not do this.
Dave Love <fx@gnu.org>
parents:
diff changeset
86
Dave Love <fx@gnu.org>
parents:
diff changeset
87 @findex mouse-set-region
Dave Love <fx@gnu.org>
parents:
diff changeset
88 @findex mouse-set-point
Dave Love <fx@gnu.org>
parents:
diff changeset
89 @findex mouse-yank-at-click
Dave Love <fx@gnu.org>
parents:
diff changeset
90 @findex mouse-save-then-click
Dave Love <fx@gnu.org>
parents:
diff changeset
91 @kindex Mouse-1
Dave Love <fx@gnu.org>
parents:
diff changeset
92 @kindex Mouse-2
Dave Love <fx@gnu.org>
parents:
diff changeset
93 @kindex Mouse-3
Dave Love <fx@gnu.org>
parents:
diff changeset
94 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
95 @item Mouse-1
Dave Love <fx@gnu.org>
parents:
diff changeset
96 Move point to where you click (@code{mouse-set-point}).
Dave Love <fx@gnu.org>
parents:
diff changeset
97 This is normally the left button.
Dave Love <fx@gnu.org>
parents:
diff changeset
98
Dave Love <fx@gnu.org>
parents:
diff changeset
99 @item Drag-Mouse-1
Dave Love <fx@gnu.org>
parents:
diff changeset
100 Set the region to the text you select by dragging, and copy it to the
Dave Love <fx@gnu.org>
parents:
diff changeset
101 kill ring (@code{mouse-set-region}). You can specify both ends of the
Dave Love <fx@gnu.org>
parents:
diff changeset
102 region with this single command.
Dave Love <fx@gnu.org>
parents:
diff changeset
103
Dave Love <fx@gnu.org>
parents:
diff changeset
104 @vindex mouse-scroll-min-lines
Dave Love <fx@gnu.org>
parents:
diff changeset
105 If you move the mouse off the top or bottom of the window while
Dave Love <fx@gnu.org>
parents:
diff changeset
106 dragging, the window scrolls at a steady rate until you move the mouse
Dave Love <fx@gnu.org>
parents:
diff changeset
107 back into the window. This way, you can select regions that don't fit
Dave Love <fx@gnu.org>
parents:
diff changeset
108 entirely on the screen. The number of lines scrolled per step depends
Dave Love <fx@gnu.org>
parents:
diff changeset
109 on how far away from the window edge the mouse has gone; the variable
Dave Love <fx@gnu.org>
parents:
diff changeset
110 @code{mouse-scroll-min-lines} specifies a minimum step size.
Dave Love <fx@gnu.org>
parents:
diff changeset
111
Dave Love <fx@gnu.org>
parents:
diff changeset
112 @item Mouse-2
Dave Love <fx@gnu.org>
parents:
diff changeset
113 Yank the last killed text, where you click (@code{mouse-yank-at-click}).
Dave Love <fx@gnu.org>
parents:
diff changeset
114 This is normally the middle button.
Dave Love <fx@gnu.org>
parents:
diff changeset
115
Dave Love <fx@gnu.org>
parents:
diff changeset
116 @item Mouse-3
Dave Love <fx@gnu.org>
parents:
diff changeset
117 This command, @code{mouse-save-then-kill}, has several functions
Dave Love <fx@gnu.org>
parents:
diff changeset
118 depending on where you click and the status of the region.
Dave Love <fx@gnu.org>
parents:
diff changeset
119
Dave Love <fx@gnu.org>
parents:
diff changeset
120 The most basic case is when you click @kbd{Mouse-1} in one place and
Dave Love <fx@gnu.org>
parents:
diff changeset
121 then @kbd{Mouse-3} in another. This selects the text between those two
Dave Love <fx@gnu.org>
parents:
diff changeset
122 positions as the region. It also copies the new region to the kill
Dave Love <fx@gnu.org>
parents:
diff changeset
123 ring, so that you can copy it to someplace else.
Dave Love <fx@gnu.org>
parents:
diff changeset
124
Dave Love <fx@gnu.org>
parents:
diff changeset
125 If you click @kbd{Mouse-1} in the text, scroll with the scroll bar, and
Dave Love <fx@gnu.org>
parents:
diff changeset
126 then click @kbd{Mouse-3}, it remembers where point was before scrolling
Dave Love <fx@gnu.org>
parents:
diff changeset
127 (where you put it with @kbd{Mouse-1}), and uses that position as the
Dave Love <fx@gnu.org>
parents:
diff changeset
128 other end of the region. This is so that you can select a region that
Dave Love <fx@gnu.org>
parents:
diff changeset
129 doesn't fit entirely on the screen.
Dave Love <fx@gnu.org>
parents:
diff changeset
130
Dave Love <fx@gnu.org>
parents:
diff changeset
131 More generally, if you do not have a highlighted region, @kbd{Mouse-3}
Dave Love <fx@gnu.org>
parents:
diff changeset
132 selects the text between point and the click position as the region. It
Dave Love <fx@gnu.org>
parents:
diff changeset
133 does this by setting the mark where point was, and moving point to where
Dave Love <fx@gnu.org>
parents:
diff changeset
134 you click.
Dave Love <fx@gnu.org>
parents:
diff changeset
135
Dave Love <fx@gnu.org>
parents:
diff changeset
136 If you have a highlighted region, or if the region was set just before
Dave Love <fx@gnu.org>
parents:
diff changeset
137 by dragging button 1, @kbd{Mouse-3} adjusts the nearer end of the region
Dave Love <fx@gnu.org>
parents:
diff changeset
138 by moving it to where you click. The adjusted region's text also
Dave Love <fx@gnu.org>
parents:
diff changeset
139 replaces the old region's text in the kill ring.
Dave Love <fx@gnu.org>
parents:
diff changeset
140
Dave Love <fx@gnu.org>
parents:
diff changeset
141 If you originally specified the region using a double or triple
Dave Love <fx@gnu.org>
parents:
diff changeset
142 @kbd{Mouse-1}, so that the region is defined to consist of entire words
Dave Love <fx@gnu.org>
parents:
diff changeset
143 or lines, then adjusting the region with @kbd{Mouse-3} also proceeds by
Dave Love <fx@gnu.org>
parents:
diff changeset
144 entire words or lines.
Dave Love <fx@gnu.org>
parents:
diff changeset
145
Dave Love <fx@gnu.org>
parents:
diff changeset
146 If you use @kbd{Mouse-3} a second time consecutively, at the same place,
Dave Love <fx@gnu.org>
parents:
diff changeset
147 that kills the region already selected.
Dave Love <fx@gnu.org>
parents:
diff changeset
148
Dave Love <fx@gnu.org>
parents:
diff changeset
149 @item Double-Mouse-1
Dave Love <fx@gnu.org>
parents:
diff changeset
150 This key sets the region around the word which you click on. If you
Dave Love <fx@gnu.org>
parents:
diff changeset
151 click on a character with ``symbol'' syntax (such as underscore, in C
Dave Love <fx@gnu.org>
parents:
diff changeset
152 mode), it sets the region around the symbol surrounding that character.
Dave Love <fx@gnu.org>
parents:
diff changeset
153
Dave Love <fx@gnu.org>
parents:
diff changeset
154 If you click on a character with open-parenthesis or close-parenthesis
Dave Love <fx@gnu.org>
parents:
diff changeset
155 syntax, it sets the region around the parenthetical grouping (sexp)
Dave Love <fx@gnu.org>
parents:
diff changeset
156 which that character starts or ends. If you click on a character with
Dave Love <fx@gnu.org>
parents:
diff changeset
157 string-delimiter syntax (such as a singlequote or doublequote in C), it
Dave Love <fx@gnu.org>
parents:
diff changeset
158 sets the region around the string constant (using heuristics to figure
Dave Love <fx@gnu.org>
parents:
diff changeset
159 out whether that character is the beginning or the end of it).
Dave Love <fx@gnu.org>
parents:
diff changeset
160
Dave Love <fx@gnu.org>
parents:
diff changeset
161 @item Double-Drag-Mouse-1
Dave Love <fx@gnu.org>
parents:
diff changeset
162 This key selects a region made up of the words you drag across.
Dave Love <fx@gnu.org>
parents:
diff changeset
163
Dave Love <fx@gnu.org>
parents:
diff changeset
164 @item Triple-Mouse-1
Dave Love <fx@gnu.org>
parents:
diff changeset
165 This key sets the region around the line you click on.
Dave Love <fx@gnu.org>
parents:
diff changeset
166
Dave Love <fx@gnu.org>
parents:
diff changeset
167 @item Triple-Drag-Mouse-1
Dave Love <fx@gnu.org>
parents:
diff changeset
168 This key selects a region made up of the lines you drag across.
Dave Love <fx@gnu.org>
parents:
diff changeset
169 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
170
Dave Love <fx@gnu.org>
parents:
diff changeset
171 The simplest way to kill text with the mouse is to press @kbd{Mouse-1}
Dave Love <fx@gnu.org>
parents:
diff changeset
172 at one end, then press @kbd{Mouse-3} twice at the other end.
Dave Love <fx@gnu.org>
parents:
diff changeset
173 @xref{Killing}. To copy the text into the kill ring without deleting it
Dave Love <fx@gnu.org>
parents:
diff changeset
174 from the buffer, press @kbd{Mouse-3} just once---or just drag across the
Dave Love <fx@gnu.org>
parents:
diff changeset
175 text with @kbd{Mouse-1}. Then you can copy it elsewhere by yanking it.
Dave Love <fx@gnu.org>
parents:
diff changeset
176
Dave Love <fx@gnu.org>
parents:
diff changeset
177 @vindex mouse-yank-at-point
Dave Love <fx@gnu.org>
parents:
diff changeset
178 To yank the killed or copied text somewhere else, move the mouse there
Dave Love <fx@gnu.org>
parents:
diff changeset
179 and press @kbd{Mouse-2}. @xref{Yanking}. However, if
Dave Love <fx@gnu.org>
parents:
diff changeset
180 @code{mouse-yank-at-point} is non-@code{nil}, @kbd{Mouse-2} yanks at
Dave Love <fx@gnu.org>
parents:
diff changeset
181 point. Then it does not matter where you click, or even which of the
Dave Love <fx@gnu.org>
parents:
diff changeset
182 frame's windows you click on. The default value is @code{nil}. This
Dave Love <fx@gnu.org>
parents:
diff changeset
183 variable also affects yanking the secondary selection.
Dave Love <fx@gnu.org>
parents:
diff changeset
184
Dave Love <fx@gnu.org>
parents:
diff changeset
185 @cindex cutting and X
Dave Love <fx@gnu.org>
parents:
diff changeset
186 @cindex pasting and X
Dave Love <fx@gnu.org>
parents:
diff changeset
187 @cindex X cutting and pasting
Dave Love <fx@gnu.org>
parents:
diff changeset
188 To copy text to another X window, kill it or save it in the kill ring.
Dave Love <fx@gnu.org>
parents:
diff changeset
189 Under X, this also sets the @dfn{primary selection}. Then use the
Dave Love <fx@gnu.org>
parents:
diff changeset
190 ``paste'' or ``yank'' command of the program operating the other window
Dave Love <fx@gnu.org>
parents:
diff changeset
191 to insert the text from the selection.
Dave Love <fx@gnu.org>
parents:
diff changeset
192
Dave Love <fx@gnu.org>
parents:
diff changeset
193 To copy text from another X window, use the ``cut'' or ``copy'' command
Dave Love <fx@gnu.org>
parents:
diff changeset
194 of the program operating the other window, to select the text you want.
Dave Love <fx@gnu.org>
parents:
diff changeset
195 Then yank it in Emacs with @kbd{C-y} or @kbd{Mouse-2}.
Dave Love <fx@gnu.org>
parents:
diff changeset
196
Dave Love <fx@gnu.org>
parents:
diff changeset
197 These cutting and pasting commands also work on MS-Windows.
Dave Love <fx@gnu.org>
parents:
diff changeset
198
Dave Love <fx@gnu.org>
parents:
diff changeset
199 @cindex primary selection
Dave Love <fx@gnu.org>
parents:
diff changeset
200 @cindex cut buffer
Dave Love <fx@gnu.org>
parents:
diff changeset
201 @cindex selection, primary
Dave Love <fx@gnu.org>
parents:
diff changeset
202 @vindex x-cut-buffer-max
Dave Love <fx@gnu.org>
parents:
diff changeset
203 When Emacs puts text into the kill ring, or rotates text to the front
Dave Love <fx@gnu.org>
parents:
diff changeset
204 of the kill ring, it sets the @dfn{primary selection} in the X server.
Dave Love <fx@gnu.org>
parents:
diff changeset
205 This is how other X clients can access the text. Emacs also stores the
Dave Love <fx@gnu.org>
parents:
diff changeset
206 text in the cut buffer, but only if the text is short enough
Dave Love <fx@gnu.org>
parents:
diff changeset
207 (@code{x-cut-buffer-max} specifies the maximum number of characters);
Dave Love <fx@gnu.org>
parents:
diff changeset
208 putting long strings in the cut buffer can be slow.
Dave Love <fx@gnu.org>
parents:
diff changeset
209
Dave Love <fx@gnu.org>
parents:
diff changeset
210 The commands to yank the first entry in the kill ring actually check
Dave Love <fx@gnu.org>
parents:
diff changeset
211 first for a primary selection in another program; after that, they check
Dave Love <fx@gnu.org>
parents:
diff changeset
212 for text in the cut buffer. If neither of those sources provides text
Dave Love <fx@gnu.org>
parents:
diff changeset
213 to yank, the kill ring contents are used.
Dave Love <fx@gnu.org>
parents:
diff changeset
214
Dave Love <fx@gnu.org>
parents:
diff changeset
215 @node Secondary Selection
Dave Love <fx@gnu.org>
parents:
diff changeset
216 @section Secondary Selection
Dave Love <fx@gnu.org>
parents:
diff changeset
217 @cindex secondary selection
Dave Love <fx@gnu.org>
parents:
diff changeset
218
Dave Love <fx@gnu.org>
parents:
diff changeset
219 The @dfn{secondary selection} is another way of selecting text using
Dave Love <fx@gnu.org>
parents:
diff changeset
220 X. It does not use point or the mark, so you can use it to kill text
Dave Love <fx@gnu.org>
parents:
diff changeset
221 without setting point or the mark.
Dave Love <fx@gnu.org>
parents:
diff changeset
222
Dave Love <fx@gnu.org>
parents:
diff changeset
223 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
224 @findex mouse-set-secondary
Dave Love <fx@gnu.org>
parents:
diff changeset
225 @kindex M-Drag-Mouse-1
Dave Love <fx@gnu.org>
parents:
diff changeset
226 @item M-Drag-Mouse-1
Dave Love <fx@gnu.org>
parents:
diff changeset
227 Set the secondary selection, with one end at the place where you press
Dave Love <fx@gnu.org>
parents:
diff changeset
228 down the button, and the other end at the place where you release it
Dave Love <fx@gnu.org>
parents:
diff changeset
229 (@code{mouse-set-secondary}). The highlighting appears and changes as
Dave Love <fx@gnu.org>
parents:
diff changeset
230 you drag.
Dave Love <fx@gnu.org>
parents:
diff changeset
231
Dave Love <fx@gnu.org>
parents:
diff changeset
232 If you move the mouse off the top or bottom of the window while
Dave Love <fx@gnu.org>
parents:
diff changeset
233 dragging, the window scrolls at a steady rate until you move the mouse
Dave Love <fx@gnu.org>
parents:
diff changeset
234 back into the window. This way, you can mark regions that don't fit
Dave Love <fx@gnu.org>
parents:
diff changeset
235 entirely on the screen.
Dave Love <fx@gnu.org>
parents:
diff changeset
236
Dave Love <fx@gnu.org>
parents:
diff changeset
237 @findex mouse-start-secondary
Dave Love <fx@gnu.org>
parents:
diff changeset
238 @kindex M-Mouse-1
Dave Love <fx@gnu.org>
parents:
diff changeset
239 @item M-Mouse-1
Dave Love <fx@gnu.org>
parents:
diff changeset
240 Set one endpoint for the @dfn{secondary selection}
Dave Love <fx@gnu.org>
parents:
diff changeset
241 (@code{mouse-start-secondary}).
Dave Love <fx@gnu.org>
parents:
diff changeset
242
Dave Love <fx@gnu.org>
parents:
diff changeset
243 @findex mouse-secondary-save-then-kill
Dave Love <fx@gnu.org>
parents:
diff changeset
244 @kindex M-Mouse-3
Dave Love <fx@gnu.org>
parents:
diff changeset
245 @item M-Mouse-3
Dave Love <fx@gnu.org>
parents:
diff changeset
246 Make a secondary selection, using the place specified with @kbd{M-Mouse-1}
Dave Love <fx@gnu.org>
parents:
diff changeset
247 as the other end (@code{mouse-secondary-save-then-kill}). A second click
Dave Love <fx@gnu.org>
parents:
diff changeset
248 at the same place kills the secondary selection just made.
Dave Love <fx@gnu.org>
parents:
diff changeset
249
Dave Love <fx@gnu.org>
parents:
diff changeset
250 @findex mouse-yank-secondary
Dave Love <fx@gnu.org>
parents:
diff changeset
251 @kindex M-Mouse-2
Dave Love <fx@gnu.org>
parents:
diff changeset
252 @item M-Mouse-2
Dave Love <fx@gnu.org>
parents:
diff changeset
253 Insert the secondary selection where you click
Dave Love <fx@gnu.org>
parents:
diff changeset
254 (@code{mouse-yank-secondary}). This places point at the end of the
Dave Love <fx@gnu.org>
parents:
diff changeset
255 yanked text.
Dave Love <fx@gnu.org>
parents:
diff changeset
256 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
257
Dave Love <fx@gnu.org>
parents:
diff changeset
258 Double or triple clicking of @kbd{M-Mouse-1} operates on words and
Dave Love <fx@gnu.org>
parents:
diff changeset
259 lines, much like @kbd{Mouse-1}.
Dave Love <fx@gnu.org>
parents:
diff changeset
260
Dave Love <fx@gnu.org>
parents:
diff changeset
261 If @code{mouse-yank-at-point} is non-@code{nil}, @kbd{M-Mouse-2}
Dave Love <fx@gnu.org>
parents:
diff changeset
262 yanks at point. Then it does not matter precisely where you click; all
Dave Love <fx@gnu.org>
parents:
diff changeset
263 that matters is which window you click on. @xref{Mouse Commands}.
Dave Love <fx@gnu.org>
parents:
diff changeset
264
33920
9fd4e6727f6b (Clipboard): New.
Dave Love <fx@gnu.org>
parents: 32274
diff changeset
265 @node Clipboard
9fd4e6727f6b (Clipboard): New.
Dave Love <fx@gnu.org>
parents: 32274
diff changeset
266 @section Using the Clipboard
9fd4e6727f6b (Clipboard): New.
Dave Love <fx@gnu.org>
parents: 32274
diff changeset
267 @cindex X clipboard
9fd4e6727f6b (Clipboard): New.
Dave Love <fx@gnu.org>
parents: 32274
diff changeset
268 @cindex clipboard
9fd4e6727f6b (Clipboard): New.
Dave Love <fx@gnu.org>
parents: 32274
diff changeset
269 @vindex x-select-enable-clipboard
9fd4e6727f6b (Clipboard): New.
Dave Love <fx@gnu.org>
parents: 32274
diff changeset
270 @findex menu-bar-enable-clipboard
9fd4e6727f6b (Clipboard): New.
Dave Love <fx@gnu.org>
parents: 32274
diff changeset
271 @cindex OpenWindows
9fd4e6727f6b (Clipboard): New.
Dave Love <fx@gnu.org>
parents: 32274
diff changeset
272 @cindex Gnome
9fd4e6727f6b (Clipboard): New.
Dave Love <fx@gnu.org>
parents: 32274
diff changeset
273
9fd4e6727f6b (Clipboard): New.
Dave Love <fx@gnu.org>
parents: 32274
diff changeset
274 As well as the primary and secondary selection types, X supports a
9fd4e6727f6b (Clipboard): New.
Dave Love <fx@gnu.org>
parents: 32274
diff changeset
275 @dfn{clipboard} selection type which is used by some applications,
9fd4e6727f6b (Clipboard): New.
Dave Love <fx@gnu.org>
parents: 32274
diff changeset
276 particularly under OpenWindows and Gnome.
9fd4e6727f6b (Clipboard): New.
Dave Love <fx@gnu.org>
parents: 32274
diff changeset
277
9fd4e6727f6b (Clipboard): New.
Dave Love <fx@gnu.org>
parents: 32274
diff changeset
278 The command @kbd{M-x menu-bar-enable-clipboard} makes the @code{Cut},
9fd4e6727f6b (Clipboard): New.
Dave Love <fx@gnu.org>
parents: 32274
diff changeset
279 @code{Paste} and @code{Copy} menu items, as well as the keys of the same
9fd4e6727f6b (Clipboard): New.
Dave Love <fx@gnu.org>
parents: 32274
diff changeset
280 names, all use the clipboard.
9fd4e6727f6b (Clipboard): New.
Dave Love <fx@gnu.org>
parents: 32274
diff changeset
281
9fd4e6727f6b (Clipboard): New.
Dave Love <fx@gnu.org>
parents: 32274
diff changeset
282 You can customize the option @code{x-select-enable-clipboard} to make
9fd4e6727f6b (Clipboard): New.
Dave Love <fx@gnu.org>
parents: 32274
diff changeset
283 the Emacs yank functions consult the clipboard before the primary
9fd4e6727f6b (Clipboard): New.
Dave Love <fx@gnu.org>
parents: 32274
diff changeset
284 selection, and to make the kill functions to store in the clipboard as
9fd4e6727f6b (Clipboard): New.
Dave Love <fx@gnu.org>
parents: 32274
diff changeset
285 well as the primary selection. Otherwise they do not access the
9fd4e6727f6b (Clipboard): New.
Dave Love <fx@gnu.org>
parents: 32274
diff changeset
286 clipboard at all. Using the clipboard is the default on MS-Windows,
9fd4e6727f6b (Clipboard): New.
Dave Love <fx@gnu.org>
parents: 32274
diff changeset
287 unlike most systems.
9fd4e6727f6b (Clipboard): New.
Dave Love <fx@gnu.org>
parents: 32274
diff changeset
288
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
289 @node Mouse References
Dave Love <fx@gnu.org>
parents:
diff changeset
290 @section Following References with the Mouse
Dave Love <fx@gnu.org>
parents:
diff changeset
291 @kindex Mouse-2 @r{(selection)}
Dave Love <fx@gnu.org>
parents:
diff changeset
292
Dave Love <fx@gnu.org>
parents:
diff changeset
293 Some Emacs buffers display lists of various sorts. These include
Dave Love <fx@gnu.org>
parents:
diff changeset
294 lists of files, of buffers, of possible completions, of matches for
Dave Love <fx@gnu.org>
parents:
diff changeset
295 a pattern, and so on.
Dave Love <fx@gnu.org>
parents:
diff changeset
296
Dave Love <fx@gnu.org>
parents:
diff changeset
297 Since yanking text into these buffers is not very useful, most of them
Dave Love <fx@gnu.org>
parents:
diff changeset
298 define @kbd{Mouse-2} specially, as a command to use or view the item you
Dave Love <fx@gnu.org>
parents:
diff changeset
299 click on.
Dave Love <fx@gnu.org>
parents:
diff changeset
300
Dave Love <fx@gnu.org>
parents:
diff changeset
301 For example, if you click @kbd{Mouse-2} on a file name in a Dired
Dave Love <fx@gnu.org>
parents:
diff changeset
302 buffer, you visit that file. If you click @kbd{Mouse-2} on an error
Dave Love <fx@gnu.org>
parents:
diff changeset
303 message in the @samp{*Compilation*} buffer, you go to the source code
Dave Love <fx@gnu.org>
parents:
diff changeset
304 for that error message. If you click @kbd{Mouse-2} on a completion in
Dave Love <fx@gnu.org>
parents:
diff changeset
305 the @samp{*Completions*} buffer, you choose that completion.
Dave Love <fx@gnu.org>
parents:
diff changeset
306
Dave Love <fx@gnu.org>
parents:
diff changeset
307 You can usually tell when @kbd{Mouse-2} has this special sort of
Dave Love <fx@gnu.org>
parents:
diff changeset
308 meaning because the sensitive text highlights when you move the mouse
Dave Love <fx@gnu.org>
parents:
diff changeset
309 over it.
Dave Love <fx@gnu.org>
parents:
diff changeset
310
Dave Love <fx@gnu.org>
parents:
diff changeset
311 @node Menu Mouse Clicks
Dave Love <fx@gnu.org>
parents:
diff changeset
312 @section Mouse Clicks for Menus
Dave Love <fx@gnu.org>
parents:
diff changeset
313
Dave Love <fx@gnu.org>
parents:
diff changeset
314 Mouse clicks modified with the @key{CTRL} and @key{SHIFT} keys
Dave Love <fx@gnu.org>
parents:
diff changeset
315 bring up menus.
Dave Love <fx@gnu.org>
parents:
diff changeset
316
Dave Love <fx@gnu.org>
parents:
diff changeset
317 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
318 @item C-Mouse-1
30872
ddf00eb5fb12 C-Mouse-3.
Dave Love <fx@gnu.org>
parents: 30583
diff changeset
319 @kindex C-Mouse-1
ddf00eb5fb12 C-Mouse-3.
Dave Love <fx@gnu.org>
parents: 30583
diff changeset
320 @findex msb-mode
ddf00eb5fb12 C-Mouse-3.
Dave Love <fx@gnu.org>
parents: 30583
diff changeset
321 @cindex MSB minor mode
ddf00eb5fb12 C-Mouse-3.
Dave Love <fx@gnu.org>
parents: 30583
diff changeset
322 @cindex mode, MSB
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
323 This menu is for selecting a buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
324
30872
ddf00eb5fb12 C-Mouse-3.
Dave Love <fx@gnu.org>
parents: 30583
diff changeset
325 The MSB (`mouse select buffer') global minor mode alters this menu to a
ddf00eb5fb12 C-Mouse-3.
Dave Love <fx@gnu.org>
parents: 30583
diff changeset
326 form some people prefer and which is customizable. See the Custom group
ddf00eb5fb12 C-Mouse-3.
Dave Love <fx@gnu.org>
parents: 30583
diff changeset
327 @code{msb}.
ddf00eb5fb12 C-Mouse-3.
Dave Love <fx@gnu.org>
parents: 30583
diff changeset
328
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
329 @item C-Mouse-2
30872
ddf00eb5fb12 C-Mouse-3.
Dave Love <fx@gnu.org>
parents: 30583
diff changeset
330 @kindex C-Mouse-2
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
331 This menu is for specifying faces and other text properties
Dave Love <fx@gnu.org>
parents:
diff changeset
332 for editing formatted text. @xref{Formatted Text}.
Dave Love <fx@gnu.org>
parents:
diff changeset
333
Dave Love <fx@gnu.org>
parents:
diff changeset
334 @item C-Mouse-3
30872
ddf00eb5fb12 C-Mouse-3.
Dave Love <fx@gnu.org>
parents: 30583
diff changeset
335 @kindex C-Mouse-3
ddf00eb5fb12 C-Mouse-3.
Dave Love <fx@gnu.org>
parents: 30583
diff changeset
336 This menu is mode-specific. For most modes if Menu-bar mode is on, this
ddf00eb5fb12 C-Mouse-3.
Dave Love <fx@gnu.org>
parents: 30583
diff changeset
337 menu has the same items as all the mode-specific menu-bar menus put
ddf00eb5fb12 C-Mouse-3.
Dave Love <fx@gnu.org>
parents: 30583
diff changeset
338 together. Some modes may specify a different menu for this
ddf00eb5fb12 C-Mouse-3.
Dave Love <fx@gnu.org>
parents: 30583
diff changeset
339 button.@footnote{Some systems use @kbd{Mouse-3} for a mode-specific
ddf00eb5fb12 C-Mouse-3.
Dave Love <fx@gnu.org>
parents: 30583
diff changeset
340 menu. We took a survey of users, and found they preferred to keep
ddf00eb5fb12 C-Mouse-3.
Dave Love <fx@gnu.org>
parents: 30583
diff changeset
341 @kbd{Mouse-3} for selecting and killing regions. Hence the decision to
ddf00eb5fb12 C-Mouse-3.
Dave Love <fx@gnu.org>
parents: 30583
diff changeset
342 use @kbd{C-Mouse-3} for this menu.} If Menu-bar mode is off, this menu
ddf00eb5fb12 C-Mouse-3.
Dave Love <fx@gnu.org>
parents: 30583
diff changeset
343 contains all the items which would be present in the menu bar---not just
ddf00eb5fb12 C-Mouse-3.
Dave Love <fx@gnu.org>
parents: 30583
diff changeset
344 the mode-specific ones---so that you can access them without having to
ddf00eb5fb12 C-Mouse-3.
Dave Love <fx@gnu.org>
parents: 30583
diff changeset
345 display the menu bar.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
346
Dave Love <fx@gnu.org>
parents:
diff changeset
347 @item S-mouse-1
Dave Love <fx@gnu.org>
parents:
diff changeset
348 This menu is for specifying the frame's principal font.
Dave Love <fx@gnu.org>
parents:
diff changeset
349 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
350
Dave Love <fx@gnu.org>
parents:
diff changeset
351 @node Mode Line Mouse
Dave Love <fx@gnu.org>
parents:
diff changeset
352 @section Mode Line Mouse Commands
30872
ddf00eb5fb12 C-Mouse-3.
Dave Love <fx@gnu.org>
parents: 30583
diff changeset
353 @cindex mode line, mouse
ddf00eb5fb12 C-Mouse-3.
Dave Love <fx@gnu.org>
parents: 30583
diff changeset
354 @cindex mouse on mode line
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
355
Dave Love <fx@gnu.org>
parents:
diff changeset
356 You can use mouse clicks on window mode lines to select and manipulate
Dave Love <fx@gnu.org>
parents:
diff changeset
357 windows.
Dave Love <fx@gnu.org>
parents:
diff changeset
358
Dave Love <fx@gnu.org>
parents:
diff changeset
359 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
360 @item Mouse-1
30872
ddf00eb5fb12 C-Mouse-3.
Dave Love <fx@gnu.org>
parents: 30583
diff changeset
361 @kindex mode-line mouse-1
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
362 @kbd{Mouse-1} on a mode line selects the window above. By dragging
Dave Love <fx@gnu.org>
parents:
diff changeset
363 @kbd{Mouse-1} on the mode line, you can move it, thus changing the
Dave Love <fx@gnu.org>
parents:
diff changeset
364 height of the windows above and below.
Dave Love <fx@gnu.org>
parents:
diff changeset
365
Dave Love <fx@gnu.org>
parents:
diff changeset
366 @item Mouse-2
30872
ddf00eb5fb12 C-Mouse-3.
Dave Love <fx@gnu.org>
parents: 30583
diff changeset
367 @kindex mode-line mouse-2
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
368 @kbd{Mouse-2} on a mode line expands that window to fill its frame.
Dave Love <fx@gnu.org>
parents:
diff changeset
369
Dave Love <fx@gnu.org>
parents:
diff changeset
370 @item Mouse-3
30872
ddf00eb5fb12 C-Mouse-3.
Dave Love <fx@gnu.org>
parents: 30583
diff changeset
371 @kindex mode-line mouse-3
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
372 @kbd{Mouse-3} on a mode line deletes the window above.
Dave Love <fx@gnu.org>
parents:
diff changeset
373
Dave Love <fx@gnu.org>
parents:
diff changeset
374 @item C-Mouse-2
30872
ddf00eb5fb12 C-Mouse-3.
Dave Love <fx@gnu.org>
parents: 30583
diff changeset
375 @kindex mode-line C-mouse-2
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
376 @kbd{C-Mouse-2} on a mode line splits the window above
Dave Love <fx@gnu.org>
parents:
diff changeset
377 horizontally, above the place in the mode line where you click.
Dave Love <fx@gnu.org>
parents:
diff changeset
378 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
379
30872
ddf00eb5fb12 C-Mouse-3.
Dave Love <fx@gnu.org>
parents: 30583
diff changeset
380 @kindex vertical-scroll-bar mouse-1
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
381 @kbd{C-Mouse-2} on a scroll bar splits the corresponding window
Dave Love <fx@gnu.org>
parents:
diff changeset
382 vertically. @xref{Split Window}.
Dave Love <fx@gnu.org>
parents:
diff changeset
383
27224
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
384 The commands above apply to areas of the mode line which do not have
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
385 mouse bindings of their own. Normally some areas, such as those
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
386 displaying the buffer name and the major mode name, have their own mouse
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
387 bindings. Help on these bindings is echoed when the mouse is positioned
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
388 over them.
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
389
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
390 @node Creating Frames
Dave Love <fx@gnu.org>
parents:
diff changeset
391 @section Creating Frames
Dave Love <fx@gnu.org>
parents:
diff changeset
392 @cindex creating frames
Dave Love <fx@gnu.org>
parents:
diff changeset
393
Dave Love <fx@gnu.org>
parents:
diff changeset
394 @kindex C-x 5
Dave Love <fx@gnu.org>
parents:
diff changeset
395 The prefix key @kbd{C-x 5} is analogous to @kbd{C-x 4}, with parallel
Dave Love <fx@gnu.org>
parents:
diff changeset
396 subcommands. The difference is that @kbd{C-x 5} commands create a new
Dave Love <fx@gnu.org>
parents:
diff changeset
397 frame rather than just a new window in the selected frame (@pxref{Pop
Dave Love <fx@gnu.org>
parents:
diff changeset
398 Up Window}). If an existing visible or iconified frame already displays
Dave Love <fx@gnu.org>
parents:
diff changeset
399 the requested material, these commands use the existing frame, after
Dave Love <fx@gnu.org>
parents:
diff changeset
400 raising or deiconifying as necessary.
Dave Love <fx@gnu.org>
parents:
diff changeset
401
Dave Love <fx@gnu.org>
parents:
diff changeset
402 The various @kbd{C-x 5} commands differ in how they find or create the
Dave Love <fx@gnu.org>
parents:
diff changeset
403 buffer to select:
Dave Love <fx@gnu.org>
parents:
diff changeset
404
Dave Love <fx@gnu.org>
parents:
diff changeset
405 @table @kbd
30984
9d25b399dd59 C-x 5 1
Dave Love <fx@gnu.org>
parents: 30872
diff changeset
406 @item C-x 5 1
9d25b399dd59 C-x 5 1
Dave Love <fx@gnu.org>
parents: 30872
diff changeset
407 @kindex C-x 5 1
9d25b399dd59 C-x 5 1
Dave Love <fx@gnu.org>
parents: 30872
diff changeset
408 @findex delete-other-frames
9d25b399dd59 C-x 5 1
Dave Love <fx@gnu.org>
parents: 30872
diff changeset
409 Delete all frames except the selected one (@code{delete-other-frames}).
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
410 @item C-x 5 2
Dave Love <fx@gnu.org>
parents:
diff changeset
411 @kindex C-x 5 2
Dave Love <fx@gnu.org>
parents:
diff changeset
412 @findex make-frame-command
Dave Love <fx@gnu.org>
parents:
diff changeset
413 Create a new frame (@code{make-frame-command}).
Dave Love <fx@gnu.org>
parents:
diff changeset
414 @item C-x 5 b @var{bufname} @key{RET}
Dave Love <fx@gnu.org>
parents:
diff changeset
415 Select buffer @var{bufname} in another frame. This runs
Dave Love <fx@gnu.org>
parents:
diff changeset
416 @code{switch-to-buffer-other-frame}.
Dave Love <fx@gnu.org>
parents:
diff changeset
417 @item C-x 5 f @var{filename} @key{RET}
Dave Love <fx@gnu.org>
parents:
diff changeset
418 Visit file @var{filename} and select its buffer in another frame. This
Dave Love <fx@gnu.org>
parents:
diff changeset
419 runs @code{find-file-other-frame}. @xref{Visiting}.
Dave Love <fx@gnu.org>
parents:
diff changeset
420 @item C-x 5 d @var{directory} @key{RET}
Dave Love <fx@gnu.org>
parents:
diff changeset
421 Select a Dired buffer for directory @var{directory} in another frame.
Dave Love <fx@gnu.org>
parents:
diff changeset
422 This runs @code{dired-other-frame}. @xref{Dired}.
Dave Love <fx@gnu.org>
parents:
diff changeset
423 @item C-x 5 m
Dave Love <fx@gnu.org>
parents:
diff changeset
424 Start composing a mail message in another frame. This runs
Dave Love <fx@gnu.org>
parents:
diff changeset
425 @code{mail-other-frame}. It is the other-frame variant of @kbd{C-x m}.
Dave Love <fx@gnu.org>
parents:
diff changeset
426 @xref{Sending Mail}.
Dave Love <fx@gnu.org>
parents:
diff changeset
427 @item C-x 5 .
Dave Love <fx@gnu.org>
parents:
diff changeset
428 Find a tag in the current tag table in another frame. This runs
Dave Love <fx@gnu.org>
parents:
diff changeset
429 @code{find-tag-other-frame}, the multiple-frame variant of @kbd{M-.}.
Dave Love <fx@gnu.org>
parents:
diff changeset
430 @xref{Tags}.
Dave Love <fx@gnu.org>
parents:
diff changeset
431 @item C-x 5 r @var{filename} @key{RET}
Dave Love <fx@gnu.org>
parents:
diff changeset
432 @kindex C-x 5 r
Dave Love <fx@gnu.org>
parents:
diff changeset
433 @findex find-file-read-only-other-frame
Dave Love <fx@gnu.org>
parents:
diff changeset
434 Visit file @var{filename} read-only, and select its buffer in another
Dave Love <fx@gnu.org>
parents:
diff changeset
435 frame. This runs @code{find-file-read-only-other-frame}.
Dave Love <fx@gnu.org>
parents:
diff changeset
436 @xref{Visiting}.
Dave Love <fx@gnu.org>
parents:
diff changeset
437 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
438
Dave Love <fx@gnu.org>
parents:
diff changeset
439 @cindex default-frame-alist
Dave Love <fx@gnu.org>
parents:
diff changeset
440 @cindex initial-frame-alist
Dave Love <fx@gnu.org>
parents:
diff changeset
441 You can control the appearance of new frames you create by setting the
Dave Love <fx@gnu.org>
parents:
diff changeset
442 frame parameters in @code{default-frame-alist}. You can use the
Dave Love <fx@gnu.org>
parents:
diff changeset
443 variable @code{initial-frame-alist} to specify parameters that affect
Dave Love <fx@gnu.org>
parents:
diff changeset
444 only the initial frame. @xref{Initial Parameters,,, elisp, The Emacs
Dave Love <fx@gnu.org>
parents:
diff changeset
445 Lisp Reference Manual}, for more information.
Dave Love <fx@gnu.org>
parents:
diff changeset
446
Dave Love <fx@gnu.org>
parents:
diff changeset
447 @cindex font (default)
Dave Love <fx@gnu.org>
parents:
diff changeset
448 The easiest way to specify the principal font for all your Emacs
Dave Love <fx@gnu.org>
parents:
diff changeset
449 frames is with an X resource (@pxref{Font X}), but you can also do it by
Dave Love <fx@gnu.org>
parents:
diff changeset
450 modifying @code{default-frame-alist} to specify the @code{font}
Dave Love <fx@gnu.org>
parents:
diff changeset
451 parameter, as shown here:
Dave Love <fx@gnu.org>
parents:
diff changeset
452
Dave Love <fx@gnu.org>
parents:
diff changeset
453 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
454 (add-to-list 'default-frame-alist '(font . "10x20"))
Dave Love <fx@gnu.org>
parents:
diff changeset
455 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
456
Dave Love <fx@gnu.org>
parents:
diff changeset
457 @node Speedbar
Dave Love <fx@gnu.org>
parents:
diff changeset
458 @section Making and Using a Speedbar Frame
Dave Love <fx@gnu.org>
parents:
diff changeset
459 @cindex speedbar
Dave Love <fx@gnu.org>
parents:
diff changeset
460
Dave Love <fx@gnu.org>
parents:
diff changeset
461 An Emacs frame can have a @dfn{speedbar}, which is a vertical window
Dave Love <fx@gnu.org>
parents:
diff changeset
462 that serves as a scrollable menu of files you could visit and tags
Dave Love <fx@gnu.org>
parents:
diff changeset
463 within those files. To create a speedbar, type @kbd{M-x speedbar}; this
Dave Love <fx@gnu.org>
parents:
diff changeset
464 creates a speedbar window for the selected frame. From then on, you can
Dave Love <fx@gnu.org>
parents:
diff changeset
465 click on a file name in the speedbar to visit that file in the
Dave Love <fx@gnu.org>
parents:
diff changeset
466 corresponding Emacs frame, or click on a tag name to jump to that tag in
Dave Love <fx@gnu.org>
parents:
diff changeset
467 the Emacs frame.
Dave Love <fx@gnu.org>
parents:
diff changeset
468
Dave Love <fx@gnu.org>
parents:
diff changeset
469 Initially the speedbar lists the immediate contents of the current
Dave Love <fx@gnu.org>
parents:
diff changeset
470 directory, one file per line. Each line also has a box, @samp{[+]} or
Dave Love <fx@gnu.org>
parents:
diff changeset
471 @samp{<+>}, that you can click on with @kbd{Mouse-2} to ``open up'' the
Dave Love <fx@gnu.org>
parents:
diff changeset
472 contents of that item. If the line names a directory, opening it adds
Dave Love <fx@gnu.org>
parents:
diff changeset
473 the contents of that directory to the speedbar display, underneath the
Dave Love <fx@gnu.org>
parents:
diff changeset
474 directory's own line. If the line lists an ordinary file, opening it up
Dave Love <fx@gnu.org>
parents:
diff changeset
475 adds a list of the tags in that file to the speedbar display. When a
Dave Love <fx@gnu.org>
parents:
diff changeset
476 file is opened up, the @samp{[+]} changes to @samp{[-]}; you can click
Dave Love <fx@gnu.org>
parents:
diff changeset
477 on that box to ``close up'' that file (hide its contents).
Dave Love <fx@gnu.org>
parents:
diff changeset
478
Dave Love <fx@gnu.org>
parents:
diff changeset
479 Some major modes, including Rmail mode, Info, and GUD, have
Dave Love <fx@gnu.org>
parents:
diff changeset
480 specialized ways of putting useful items into the speedbar for you to
Dave Love <fx@gnu.org>
parents:
diff changeset
481 select. For example, in Rmail mode, the speedbar shows a list of Rmail
Dave Love <fx@gnu.org>
parents:
diff changeset
482 files, and lets you move the current message to another Rmail file by
Dave Love <fx@gnu.org>
parents:
diff changeset
483 clicking on its @samp{<M>} box.
Dave Love <fx@gnu.org>
parents:
diff changeset
484
Dave Love <fx@gnu.org>
parents:
diff changeset
485 A speedbar belongs to one Emacs frame, and always operates on that
Dave Love <fx@gnu.org>
parents:
diff changeset
486 frame. If you use multiple frames, you can make a speedbar for some or
Dave Love <fx@gnu.org>
parents:
diff changeset
487 all of the frames; type @kbd{M-x speedbar} in any given frame to make a
Dave Love <fx@gnu.org>
parents:
diff changeset
488 speedbar for it.
Dave Love <fx@gnu.org>
parents:
diff changeset
489
Dave Love <fx@gnu.org>
parents:
diff changeset
490 @node Multiple Displays
Dave Love <fx@gnu.org>
parents:
diff changeset
491 @section Multiple Displays
Dave Love <fx@gnu.org>
parents:
diff changeset
492 @cindex multiple displays
Dave Love <fx@gnu.org>
parents:
diff changeset
493
Dave Love <fx@gnu.org>
parents:
diff changeset
494 A single Emacs can talk to more than one X Windows display.
Dave Love <fx@gnu.org>
parents:
diff changeset
495 Initially, Emacs uses just one display---the one specified with the
29107
203ba1f77b7b *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 28432
diff changeset
496 @env{DISPLAY} environment variable or with the @samp{--display} option
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
497 (@pxref{Initial Options}). To connect to another display, use the
Dave Love <fx@gnu.org>
parents:
diff changeset
498 command @code{make-frame-on-display}:
Dave Love <fx@gnu.org>
parents:
diff changeset
499
Dave Love <fx@gnu.org>
parents:
diff changeset
500 @findex make-frame-on-display
Dave Love <fx@gnu.org>
parents:
diff changeset
501 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
502 @item M-x make-frame-on-display @key{RET} @var{display} @key{RET}
Dave Love <fx@gnu.org>
parents:
diff changeset
503 Create a new frame on display @var{display}.
Dave Love <fx@gnu.org>
parents:
diff changeset
504 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
505
Dave Love <fx@gnu.org>
parents:
diff changeset
506 A single X server can handle more than one screen. When you open
Dave Love <fx@gnu.org>
parents:
diff changeset
507 frames on two screens belonging to one server, Emacs knows they share a
Dave Love <fx@gnu.org>
parents:
diff changeset
508 single keyboard, and it treats all the commands arriving from these
Dave Love <fx@gnu.org>
parents:
diff changeset
509 screens as a single stream of input.
Dave Love <fx@gnu.org>
parents:
diff changeset
510
Dave Love <fx@gnu.org>
parents:
diff changeset
511 When you open frames on different X servers, Emacs makes a separate
Dave Love <fx@gnu.org>
parents:
diff changeset
512 input stream for each server. This way, two users can type
Dave Love <fx@gnu.org>
parents:
diff changeset
513 simultaneously on the two displays, and Emacs will not garble their
Dave Love <fx@gnu.org>
parents:
diff changeset
514 input. Each server also has its own selected frame. The commands you
Dave Love <fx@gnu.org>
parents:
diff changeset
515 enter with a particular X server apply to that server's selected frame.
Dave Love <fx@gnu.org>
parents:
diff changeset
516
Dave Love <fx@gnu.org>
parents:
diff changeset
517 Despite these features, people using the same Emacs job from different
Dave Love <fx@gnu.org>
parents:
diff changeset
518 displays can still interfere with each other if they are not careful.
Dave Love <fx@gnu.org>
parents:
diff changeset
519 For example, if any one types @kbd{C-x C-c}, that exits the Emacs job
Dave Love <fx@gnu.org>
parents:
diff changeset
520 for all of them!
Dave Love <fx@gnu.org>
parents:
diff changeset
521
Dave Love <fx@gnu.org>
parents:
diff changeset
522 @node Special Buffer Frames
Dave Love <fx@gnu.org>
parents:
diff changeset
523 @section Special Buffer Frames
Dave Love <fx@gnu.org>
parents:
diff changeset
524
Dave Love <fx@gnu.org>
parents:
diff changeset
525 @vindex special-display-buffer-names
Dave Love <fx@gnu.org>
parents:
diff changeset
526 You can make certain chosen buffers, for which Emacs normally creates
Dave Love <fx@gnu.org>
parents:
diff changeset
527 a second window when you have just one window, appear in special frames
Dave Love <fx@gnu.org>
parents:
diff changeset
528 of their own. To do this, set the variable
Dave Love <fx@gnu.org>
parents:
diff changeset
529 @code{special-display-buffer-names} to a list of buffer names; any
Dave Love <fx@gnu.org>
parents:
diff changeset
530 buffer whose name is in that list automatically gets a special frame,
Dave Love <fx@gnu.org>
parents:
diff changeset
531 when an Emacs command wants to display it ``in another window.''
Dave Love <fx@gnu.org>
parents:
diff changeset
532
Dave Love <fx@gnu.org>
parents:
diff changeset
533 For example, if you set the variable this way,
Dave Love <fx@gnu.org>
parents:
diff changeset
534
Dave Love <fx@gnu.org>
parents:
diff changeset
535 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
536 (setq special-display-buffer-names
Dave Love <fx@gnu.org>
parents:
diff changeset
537 '("*Completions*" "*grep*" "*tex-shell*"))
Dave Love <fx@gnu.org>
parents:
diff changeset
538 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
539
Dave Love <fx@gnu.org>
parents:
diff changeset
540 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
541 then completion lists, @code{grep} output and the @TeX{} mode shell
Dave Love <fx@gnu.org>
parents:
diff changeset
542 buffer get individual frames of their own. These frames, and the
Dave Love <fx@gnu.org>
parents:
diff changeset
543 windows in them, are never automatically split or reused for any other
Dave Love <fx@gnu.org>
parents:
diff changeset
544 buffers. They continue to show the buffers they were created for,
Dave Love <fx@gnu.org>
parents:
diff changeset
545 unless you alter them by hand. Killing the special buffer deletes its
Dave Love <fx@gnu.org>
parents:
diff changeset
546 frame automatically.
Dave Love <fx@gnu.org>
parents:
diff changeset
547
Dave Love <fx@gnu.org>
parents:
diff changeset
548 @vindex special-display-regexps
Dave Love <fx@gnu.org>
parents:
diff changeset
549 More generally, you can set @code{special-display-regexps} to a list
Dave Love <fx@gnu.org>
parents:
diff changeset
550 of regular expressions; then a buffer gets its own frame if its name
Dave Love <fx@gnu.org>
parents:
diff changeset
551 matches any of those regular expressions. (Once again, this applies only
Dave Love <fx@gnu.org>
parents:
diff changeset
552 to buffers that normally get displayed for you in a separate window.)
Dave Love <fx@gnu.org>
parents:
diff changeset
553
Dave Love <fx@gnu.org>
parents:
diff changeset
554 @vindex special-display-frame-alist
Dave Love <fx@gnu.org>
parents:
diff changeset
555 The variable @code{special-display-frame-alist} specifies the frame
Dave Love <fx@gnu.org>
parents:
diff changeset
556 parameters for these frames. It has a default value, so you don't need
Dave Love <fx@gnu.org>
parents:
diff changeset
557 to set it.
Dave Love <fx@gnu.org>
parents:
diff changeset
558
Dave Love <fx@gnu.org>
parents:
diff changeset
559 For those who know Lisp, an element of
Dave Love <fx@gnu.org>
parents:
diff changeset
560 @code{special-display-buffer-names} or @code{special-display-regexps}
Dave Love <fx@gnu.org>
parents:
diff changeset
561 can also be a list. Then the first element is the buffer name or
Dave Love <fx@gnu.org>
parents:
diff changeset
562 regular expression; the rest of the list specifies how to create the
Dave Love <fx@gnu.org>
parents:
diff changeset
563 frame. It can be an association list specifying frame parameter values;
Dave Love <fx@gnu.org>
parents:
diff changeset
564 these values take precedence over parameter values specified in
Dave Love <fx@gnu.org>
parents:
diff changeset
565 @code{special-display-frame-alist}. Alternatively, it can have this
Dave Love <fx@gnu.org>
parents:
diff changeset
566 form:
Dave Love <fx@gnu.org>
parents:
diff changeset
567
Dave Love <fx@gnu.org>
parents:
diff changeset
568 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
569 (@var{function} @var{args}...)
Dave Love <fx@gnu.org>
parents:
diff changeset
570 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
571
Dave Love <fx@gnu.org>
parents:
diff changeset
572 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
573 where @var{function} is a symbol. Then the frame is constructed by
Dave Love <fx@gnu.org>
parents:
diff changeset
574 calling @var{function}; its first argument is the buffer, and its
Dave Love <fx@gnu.org>
parents:
diff changeset
575 remaining arguments are @var{args}.
Dave Love <fx@gnu.org>
parents:
diff changeset
576
Dave Love <fx@gnu.org>
parents:
diff changeset
577 An analogous feature lets you specify buffers which should be
Dave Love <fx@gnu.org>
parents:
diff changeset
578 displayed in the selected window. @xref{Force Same Window}. The
Dave Love <fx@gnu.org>
parents:
diff changeset
579 same-window feature takes precedence over the special-frame feature;
Dave Love <fx@gnu.org>
parents:
diff changeset
580 therefore, if you add a buffer name to
Dave Love <fx@gnu.org>
parents:
diff changeset
581 @code{special-display-buffer-names} and it has no effect, check to see
Dave Love <fx@gnu.org>
parents:
diff changeset
582 whether that feature is also in use for the same buffer name.
Dave Love <fx@gnu.org>
parents:
diff changeset
583
Dave Love <fx@gnu.org>
parents:
diff changeset
584 @node Frame Parameters
Dave Love <fx@gnu.org>
parents:
diff changeset
585 @section Setting Frame Parameters
Dave Love <fx@gnu.org>
parents:
diff changeset
586 @cindex colors
Dave Love <fx@gnu.org>
parents:
diff changeset
587 @cindex Auto-Raise mode
Dave Love <fx@gnu.org>
parents:
diff changeset
588 @cindex Auto-Lower mode
Dave Love <fx@gnu.org>
parents:
diff changeset
589
Dave Love <fx@gnu.org>
parents:
diff changeset
590 This section describes commands for altering the display style and
Dave Love <fx@gnu.org>
parents:
diff changeset
591 window management behavior of the selected frame.
Dave Love <fx@gnu.org>
parents:
diff changeset
592
Dave Love <fx@gnu.org>
parents:
diff changeset
593 @findex set-foreground-color
Dave Love <fx@gnu.org>
parents:
diff changeset
594 @findex set-background-color
Dave Love <fx@gnu.org>
parents:
diff changeset
595 @findex set-cursor-color
Dave Love <fx@gnu.org>
parents:
diff changeset
596 @findex set-mouse-color
Dave Love <fx@gnu.org>
parents:
diff changeset
597 @findex set-border-color
Dave Love <fx@gnu.org>
parents:
diff changeset
598 @findex auto-raise-mode
Dave Love <fx@gnu.org>
parents:
diff changeset
599 @findex auto-lower-mode
Dave Love <fx@gnu.org>
parents:
diff changeset
600 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
601 @item M-x set-foreground-color @key{RET} @var{color} @key{RET}
Dave Love <fx@gnu.org>
parents:
diff changeset
602 Specify color @var{color} for the foreground of the selected frame.
Dave Love <fx@gnu.org>
parents:
diff changeset
603 (This also changes the foreground color of the default face.)
Dave Love <fx@gnu.org>
parents:
diff changeset
604
Dave Love <fx@gnu.org>
parents:
diff changeset
605 @item M-x set-background-color @key{RET} @var{color} @key{RET}
Dave Love <fx@gnu.org>
parents:
diff changeset
606 Specify color @var{color} for the background of the selected frame.
Dave Love <fx@gnu.org>
parents:
diff changeset
607 (This also changes the background color of the default face.)
Dave Love <fx@gnu.org>
parents:
diff changeset
608
Dave Love <fx@gnu.org>
parents:
diff changeset
609 @item M-x set-cursor-color @key{RET} @var{color} @key{RET}
Dave Love <fx@gnu.org>
parents:
diff changeset
610 Specify color @var{color} for the cursor of the selected frame.
Dave Love <fx@gnu.org>
parents:
diff changeset
611
Dave Love <fx@gnu.org>
parents:
diff changeset
612 @item M-x set-mouse-color @key{RET} @var{color} @key{RET}
Dave Love <fx@gnu.org>
parents:
diff changeset
613 Specify color @var{color} for the mouse cursor when it is over the
Dave Love <fx@gnu.org>
parents:
diff changeset
614 selected frame.
Dave Love <fx@gnu.org>
parents:
diff changeset
615
Dave Love <fx@gnu.org>
parents:
diff changeset
616 @item M-x set-border-color @key{RET} @var{color} @key{RET}
Dave Love <fx@gnu.org>
parents:
diff changeset
617 Specify color @var{color} for the border of the selected frame.
Dave Love <fx@gnu.org>
parents:
diff changeset
618
Dave Love <fx@gnu.org>
parents:
diff changeset
619 @item M-x list-colors-display
Dave Love <fx@gnu.org>
parents:
diff changeset
620 Display the defined color names and show what the colors look like.
Dave Love <fx@gnu.org>
parents:
diff changeset
621 This command is somewhat slow.
Dave Love <fx@gnu.org>
parents:
diff changeset
622
Dave Love <fx@gnu.org>
parents:
diff changeset
623 @item M-x auto-raise-mode
Dave Love <fx@gnu.org>
parents:
diff changeset
624 Toggle whether or not the selected frame should auto-raise. Auto-raise
Dave Love <fx@gnu.org>
parents:
diff changeset
625 means that every time you move the mouse onto the frame, it raises the
Dave Love <fx@gnu.org>
parents:
diff changeset
626 frame.
Dave Love <fx@gnu.org>
parents:
diff changeset
627
Dave Love <fx@gnu.org>
parents:
diff changeset
628 Note that this auto-raise feature is implemented by Emacs itself. Some
Dave Love <fx@gnu.org>
parents:
diff changeset
629 window managers also implement auto-raise. If you enable auto-raise for
Dave Love <fx@gnu.org>
parents:
diff changeset
630 Emacs frames in your X window manager, it should work, but it is beyond
Dave Love <fx@gnu.org>
parents:
diff changeset
631 Emacs's control and therefore @code{auto-raise-mode} has no effect on
Dave Love <fx@gnu.org>
parents:
diff changeset
632 it.
Dave Love <fx@gnu.org>
parents:
diff changeset
633
Dave Love <fx@gnu.org>
parents:
diff changeset
634 @item M-x auto-lower-mode
Dave Love <fx@gnu.org>
parents:
diff changeset
635 Toggle whether or not the selected frame should auto-lower.
Dave Love <fx@gnu.org>
parents:
diff changeset
636 Auto-lower means that every time you move the mouse off the frame,
Dave Love <fx@gnu.org>
parents:
diff changeset
637 the frame moves to the bottom of the stack of X windows.
Dave Love <fx@gnu.org>
parents:
diff changeset
638
Dave Love <fx@gnu.org>
parents:
diff changeset
639 The command @code{auto-lower-mode} has no effect on auto-lower
Dave Love <fx@gnu.org>
parents:
diff changeset
640 implemented by the X window manager. To control that, you must use
Dave Love <fx@gnu.org>
parents:
diff changeset
641 the appropriate window manager features.
Dave Love <fx@gnu.org>
parents:
diff changeset
642
Dave Love <fx@gnu.org>
parents:
diff changeset
643 @findex set-frame-font
Dave Love <fx@gnu.org>
parents:
diff changeset
644 @item M-x set-frame-font @key{RET} @var{font} @key{RET}
Dave Love <fx@gnu.org>
parents:
diff changeset
645 @cindex font (principal)
Dave Love <fx@gnu.org>
parents:
diff changeset
646 Specify font @var{font} as the principal font for the selected frame.
Dave Love <fx@gnu.org>
parents:
diff changeset
647 The principal font controls several face attributes of the
Dave Love <fx@gnu.org>
parents:
diff changeset
648 @code{default} face (@pxref{Faces}). For example, if the principal font
Dave Love <fx@gnu.org>
parents:
diff changeset
649 has a height of 12 pt, all text will be drawn in 12 pt fonts, unless you
Dave Love <fx@gnu.org>
parents:
diff changeset
650 use another face that specifies a different height. @xref{Font X}, for
Dave Love <fx@gnu.org>
parents:
diff changeset
651 ways to list the available fonts on your system.
Dave Love <fx@gnu.org>
parents:
diff changeset
652
Dave Love <fx@gnu.org>
parents:
diff changeset
653 @kindex S-Mouse-1
Dave Love <fx@gnu.org>
parents:
diff changeset
654 You can also set a frame's principal font through a pop-up menu.
Dave Love <fx@gnu.org>
parents:
diff changeset
655 Press @kbd{S-Mouse-1} to activate this menu.
Dave Love <fx@gnu.org>
parents:
diff changeset
656 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
657
Dave Love <fx@gnu.org>
parents:
diff changeset
658 In Emacs versions that use an X toolkit, the color-setting and
Dave Love <fx@gnu.org>
parents:
diff changeset
659 font-setting functions don't affect menus and the menu bar, since they
Dave Love <fx@gnu.org>
parents:
diff changeset
660 are displayed by their own widget classes. To change the appearance of
Dave Love <fx@gnu.org>
parents:
diff changeset
661 the menus and menu bar, you must use X resources (@pxref{Resources X}).
Dave Love <fx@gnu.org>
parents:
diff changeset
662 @xref{Colors X}, regarding colors. @xref{Font X}, regarding choice of
Dave Love <fx@gnu.org>
parents:
diff changeset
663 font.
Dave Love <fx@gnu.org>
parents:
diff changeset
664
Dave Love <fx@gnu.org>
parents:
diff changeset
665 For information on frame parameters and customization, see @ref{Frame
Dave Love <fx@gnu.org>
parents:
diff changeset
666 Parameters,,, elisp, The Emacs Lisp Reference Manual}.
Dave Love <fx@gnu.org>
parents:
diff changeset
667
Dave Love <fx@gnu.org>
parents:
diff changeset
668 @node Scroll Bars
Dave Love <fx@gnu.org>
parents:
diff changeset
669 @section Scroll Bars
Dave Love <fx@gnu.org>
parents:
diff changeset
670 @cindex Scroll Bar mode
Dave Love <fx@gnu.org>
parents:
diff changeset
671 @cindex mode, Scroll Bar
Dave Love <fx@gnu.org>
parents:
diff changeset
672
Dave Love <fx@gnu.org>
parents:
diff changeset
673 When using X, Emacs normally makes a @dfn{scroll bar} at the left of
27224
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
674 each Emacs window.@footnote{Placing it at the left is usually more
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
675 useful with overlapping frames with text starting at the left margin.}
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
676 The scroll bar runs the height of the window, and shows a moving
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
677 rectangular inner box which represents the portion of the buffer
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
678 currently displayed. The entire height of the scroll bar represents the
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
679 entire length of the buffer.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
680
Dave Love <fx@gnu.org>
parents:
diff changeset
681 You can use @kbd{Mouse-2} (normally, the middle button) in the scroll
Dave Love <fx@gnu.org>
parents:
diff changeset
682 bar to move or drag the inner box up and down. If you move it to the
Dave Love <fx@gnu.org>
parents:
diff changeset
683 top of the scroll bar, you see the top of the buffer. If you move it to
Dave Love <fx@gnu.org>
parents:
diff changeset
684 the bottom of the scroll bar, you see the bottom of the buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
685
Dave Love <fx@gnu.org>
parents:
diff changeset
686 The left and right buttons in the scroll bar scroll by controlled
Dave Love <fx@gnu.org>
parents:
diff changeset
687 increments. @kbd{Mouse-1} (normally, the left button) moves the line at
Dave Love <fx@gnu.org>
parents:
diff changeset
688 the level where you click up to the top of the window. @kbd{Mouse-3}
Dave Love <fx@gnu.org>
parents:
diff changeset
689 (normally, the right button) moves the line at the top of the window
Dave Love <fx@gnu.org>
parents:
diff changeset
690 down to the level where you click. By clicking repeatedly in the same
Dave Love <fx@gnu.org>
parents:
diff changeset
691 place, you can scroll by the same distance over and over.
Dave Love <fx@gnu.org>
parents:
diff changeset
692
34523
ae23bd13d2ee *** empty log message ***
Dave Love <fx@gnu.org>
parents: 34444
diff changeset
693 If you are using Emacs's own implementation of scroll bars, as opposed
34444
ffd94915c70a *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 34040
diff changeset
694 to scroll bars from an X toolkit, you can also click @kbd{C-Mouse-2} in
ffd94915c70a *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 34040
diff changeset
695 the scroll bar to split a window vertically. The split occurs on the
ffd94915c70a *** empty log message ***
Gerd Moellmann <gerd@gnu.org>
parents: 34040
diff changeset
696 line where you click.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
697
Dave Love <fx@gnu.org>
parents:
diff changeset
698 @findex scroll-bar-mode
27224
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
699 @vindex scroll-bar-mode
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
700 You can enable or disable Scroll Bar mode with the command @kbd{M-x
Dave Love <fx@gnu.org>
parents:
diff changeset
701 scroll-bar-mode}. With no argument, it toggles the use of scroll bars.
Dave Love <fx@gnu.org>
parents:
diff changeset
702 With an argument, it turns use of scroll bars on if and only if the
Dave Love <fx@gnu.org>
parents:
diff changeset
703 argument is positive. This command applies to all frames, including
27224
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
704 frames yet to be created. Customize the option @code{scroll-bar-mode}
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
705 to control the use of scroll bars at startup. You can use it to specify
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
706 that they are placed at the right of windows if you prefer that. You
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
707 can use the X resource @samp{verticalScrollBars} to control the initial
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
708 setting of Scroll Bar mode similarly. @xref{Resources X}.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
709
Dave Love <fx@gnu.org>
parents:
diff changeset
710 @findex toggle-scroll-bar
Dave Love <fx@gnu.org>
parents:
diff changeset
711 To enable or disable scroll bars for just the selected frame, use the
Dave Love <fx@gnu.org>
parents:
diff changeset
712 @kbd{M-x toggle-scroll-bar} command.
Dave Love <fx@gnu.org>
parents:
diff changeset
713
27224
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
714 @node Wheeled Mice
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
715 @section Scrolling With `Wheeled' Mice
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
716
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
717 @cindex mouse wheel
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
718 @findex mwheel-install
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
719 Some mice have a `wheel' instead of a third button. You can usually
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
720 click the wheel to act as @kbd{mouse-3}. You can also use the wheel to
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
721 scroll windows instead of using the scroll bar or keyboard commands.
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
722 Use @kbd{M-x mwheel-install} to set up the wheel for scrolling or put
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
723 @samp{(require 'mwheel)} in your @file{.emacs}. (Support for the wheel
30872
ddf00eb5fb12 C-Mouse-3.
Dave Love <fx@gnu.org>
parents: 30583
diff changeset
724 depends on the system generating appropriate events for Emacs.)
27224
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
725
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
726 @vindex mwheel-follow-mouse
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
727 @vindex mwheel-scroll-amount
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
728 The variables @code{mwheel-follow-mouse} and @code{mwheel-scroll-amount}
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
729 determine where and by how much buffers are scrolled.
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
730
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
731 @node Menu Bars
Dave Love <fx@gnu.org>
parents:
diff changeset
732 @section Menu Bars
Dave Love <fx@gnu.org>
parents:
diff changeset
733 @cindex Menu Bar mode
Dave Love <fx@gnu.org>
parents:
diff changeset
734 @cindex mode, Menu Bar
Dave Love <fx@gnu.org>
parents:
diff changeset
735
Dave Love <fx@gnu.org>
parents:
diff changeset
736 You can turn display of menu bars on or off with @kbd{M-x
31609
f5c313af6821 Tool bar, mention c-mouse-3.
Dave Love <fx@gnu.org>
parents: 31187
diff changeset
737 menu-bar-mode} or by customizing the option @code{menu-bar-mode}.
f5c313af6821 Tool bar, mention c-mouse-3.
Dave Love <fx@gnu.org>
parents: 31187
diff changeset
738 With no argument, this command toggles Menu Bar mode, a
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
739 minor mode. With an argument, the command turns Menu Bar mode on if the
Dave Love <fx@gnu.org>
parents:
diff changeset
740 argument is positive, off if the argument is not positive. You can use
Dave Love <fx@gnu.org>
parents:
diff changeset
741 the X resource @samp{menuBarLines} to control the initial setting of
31609
f5c313af6821 Tool bar, mention c-mouse-3.
Dave Love <fx@gnu.org>
parents: 31187
diff changeset
742 Menu Bar mode. @xref{Resources X}.
f5c313af6821 Tool bar, mention c-mouse-3.
Dave Love <fx@gnu.org>
parents: 31187
diff changeset
743
32274
5428e8f8fbda (Font Lock): Explain how to customize Font Lock faces.
Eli Zaretskii <eliz@gnu.org>
parents: 31609
diff changeset
744 @kindex C-Mouse-3@r{, when menu bar is turned off}
31609
f5c313af6821 Tool bar, mention c-mouse-3.
Dave Love <fx@gnu.org>
parents: 31187
diff changeset
745 Expert users often turn off the menu bar, especially on text-only
f5c313af6821 Tool bar, mention c-mouse-3.
Dave Love <fx@gnu.org>
parents: 31187
diff changeset
746 terminals, where this makes one additional line available for text. If
f5c313af6821 Tool bar, mention c-mouse-3.
Dave Love <fx@gnu.org>
parents: 31187
diff changeset
747 the menu bar is off, you can still pop up a menu of its contents with
32274
5428e8f8fbda (Font Lock): Explain how to customize Font Lock faces.
Eli Zaretskii <eliz@gnu.org>
parents: 31609
diff changeset
748 @kbd{C-mouse-3} on a display which supports popup menus. @xref{Menu
31609
f5c313af6821 Tool bar, mention c-mouse-3.
Dave Love <fx@gnu.org>
parents: 31187
diff changeset
749 Mouse Clicks}.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
750
Dave Love <fx@gnu.org>
parents:
diff changeset
751 @xref{Menu Bar}, for information on how to invoke commands with the
Dave Love <fx@gnu.org>
parents:
diff changeset
752 menu bar.
Dave Love <fx@gnu.org>
parents:
diff changeset
753
31609
f5c313af6821 Tool bar, mention c-mouse-3.
Dave Love <fx@gnu.org>
parents: 31187
diff changeset
754 @node Tool Bars
f5c313af6821 Tool bar, mention c-mouse-3.
Dave Love <fx@gnu.org>
parents: 31187
diff changeset
755 @section Tool Bars
f5c313af6821 Tool bar, mention c-mouse-3.
Dave Love <fx@gnu.org>
parents: 31187
diff changeset
756 @cindex Tool Bar mode
f5c313af6821 Tool bar, mention c-mouse-3.
Dave Love <fx@gnu.org>
parents: 31187
diff changeset
757 @cindex mode, Tool Bar
34040
dbe2757d6cb8 Tool bar tweak.
Dave Love <fx@gnu.org>
parents: 33920
diff changeset
758 @cindex icons, tool bar
27224
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
759
31609
f5c313af6821 Tool bar, mention c-mouse-3.
Dave Love <fx@gnu.org>
parents: 31187
diff changeset
760 You can turn display of tool bars on or off with @kbd{M-x tool-bar-mode}
f5c313af6821 Tool bar, mention c-mouse-3.
Dave Love <fx@gnu.org>
parents: 31187
diff changeset
761 analogously to @code{menu-bar-mode}. @xref{Menu Bars}. This will only
34040
dbe2757d6cb8 Tool bar tweak.
Dave Love <fx@gnu.org>
parents: 33920
diff changeset
762 work in an Emacs with appropriate image support for the available icons
dbe2757d6cb8 Tool bar tweak.
Dave Love <fx@gnu.org>
parents: 33920
diff changeset
763 on a graphic display. By default, monochrome (PBM or XBM format) icons
dbe2757d6cb8 Tool bar tweak.
Dave Love <fx@gnu.org>
parents: 33920
diff changeset
764 are used. XPM format icons, which normally look better, will normally
dbe2757d6cb8 Tool bar tweak.
Dave Love <fx@gnu.org>
parents: 33920
diff changeset
765 be used if Emacs was built with XPM support.
31609
f5c313af6821 Tool bar, mention c-mouse-3.
Dave Love <fx@gnu.org>
parents: 31187
diff changeset
766
34040
dbe2757d6cb8 Tool bar tweak.
Dave Love <fx@gnu.org>
parents: 33920
diff changeset
767 There is a global tool bar with useful items and some modes define their
dbe2757d6cb8 Tool bar tweak.
Dave Love <fx@gnu.org>
parents: 33920
diff changeset
768 own tool bars to replace it.@footnote{We could provide more if suitable
dbe2757d6cb8 Tool bar tweak.
Dave Love <fx@gnu.org>
parents: 33920
diff changeset
769 icons are contributed.} Some items are removed from the global bar in
dbe2757d6cb8 Tool bar tweak.
Dave Love <fx@gnu.org>
parents: 33920
diff changeset
770 `special' modes not designed for editing text.
27224
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
771
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
772 @node Dialog Boxes
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
773 @section Using Dialog Boxes
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
774 @cindex dialog boxes
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
775
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
776 @vindex use-dialog-box
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
777 Certain operations invoked from menus will use a window system dialog
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
778 box to get information via the mouse if such dialog boxes are supported.
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
779 This includes yes/no questions and file selection under Motif/LessTif
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
780 and MS Windows. Customize the option @code{use-dialog-box} to suppress
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
781 the use of dialog boxes.
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
782
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
783 @node Faces
Dave Love <fx@gnu.org>
parents:
diff changeset
784 @section Using Multiple Typefaces
Dave Love <fx@gnu.org>
parents:
diff changeset
785 @cindex faces
Dave Love <fx@gnu.org>
parents:
diff changeset
786
Dave Love <fx@gnu.org>
parents:
diff changeset
787 When using Emacs with X, you can set up multiple styles of displaying
Dave Love <fx@gnu.org>
parents:
diff changeset
788 characters. The aspects of style that you can control are the type
Dave Love <fx@gnu.org>
parents:
diff changeset
789 font, the foreground color, the background color, and whether to
Dave Love <fx@gnu.org>
parents:
diff changeset
790 underline. Emacs on MS-DOS supports faces partially by letting you
Dave Love <fx@gnu.org>
parents:
diff changeset
791 control the foreground and background colors of each face
27224
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
792 (@pxref{MS-DOS}). On non-windowed terminals faces are supported to the
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
793 extent the terminal can display them.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
794
Dave Love <fx@gnu.org>
parents:
diff changeset
795 The way you control display style is by defining named @dfn{faces}.
Dave Love <fx@gnu.org>
parents:
diff changeset
796 Each face can specify a type font, a foreground color, a background
Dave Love <fx@gnu.org>
parents:
diff changeset
797 color, and an underline flag; but it does not have to specify all of
Dave Love <fx@gnu.org>
parents:
diff changeset
798 them. Then by specifying the face or faces to use for a given part
Dave Love <fx@gnu.org>
parents:
diff changeset
799 of the text in the buffer, you control how that text appears.
Dave Love <fx@gnu.org>
parents:
diff changeset
800
Dave Love <fx@gnu.org>
parents:
diff changeset
801 The style of display used for a given character in the text is
Dave Love <fx@gnu.org>
parents:
diff changeset
802 determined by combining several faces. Any aspect of the display style
Dave Love <fx@gnu.org>
parents:
diff changeset
803 that isn't specified by overlays or text properties comes from the frame
Dave Love <fx@gnu.org>
parents:
diff changeset
804 itself.
Dave Love <fx@gnu.org>
parents:
diff changeset
805
Dave Love <fx@gnu.org>
parents:
diff changeset
806 Enriched mode, the mode for editing formatted text, includes several
Dave Love <fx@gnu.org>
parents:
diff changeset
807 commands and menus for specifying faces. @xref{Format Faces}, for how
Dave Love <fx@gnu.org>
parents:
diff changeset
808 to specify the font for text in the buffer. @xref{Format Colors}, for
Dave Love <fx@gnu.org>
parents:
diff changeset
809 how to specify the foreground and background color.
Dave Love <fx@gnu.org>
parents:
diff changeset
810
Dave Love <fx@gnu.org>
parents:
diff changeset
811 To alter the appearance of a face, use the customization buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
812 @xref{Face Customization}. You can also use X resources to specify
Dave Love <fx@gnu.org>
parents:
diff changeset
813 attributes of particular faces (@pxref{Resources X}).
Dave Love <fx@gnu.org>
parents:
diff changeset
814
32274
5428e8f8fbda (Font Lock): Explain how to customize Font Lock faces.
Eli Zaretskii <eliz@gnu.org>
parents: 31609
diff changeset
815 @cindex face colors, setting
5428e8f8fbda (Font Lock): Explain how to customize Font Lock faces.
Eli Zaretskii <eliz@gnu.org>
parents: 31609
diff changeset
816 @findex set-face-foreground
5428e8f8fbda (Font Lock): Explain how to customize Font Lock faces.
Eli Zaretskii <eliz@gnu.org>
parents: 31609
diff changeset
817 @findex set-face-background
5428e8f8fbda (Font Lock): Explain how to customize Font Lock faces.
Eli Zaretskii <eliz@gnu.org>
parents: 31609
diff changeset
818 Alternatively, you could change the foreground and background colors
5428e8f8fbda (Font Lock): Explain how to customize Font Lock faces.
Eli Zaretskii <eliz@gnu.org>
parents: 31609
diff changeset
819 of a specific face with @kbd{M-x set-face-foreground} and @kbd{M-x
5428e8f8fbda (Font Lock): Explain how to customize Font Lock faces.
Eli Zaretskii <eliz@gnu.org>
parents: 31609
diff changeset
820 set-face-background}. These commands prompt in the minibuffer for a
5428e8f8fbda (Font Lock): Explain how to customize Font Lock faces.
Eli Zaretskii <eliz@gnu.org>
parents: 31609
diff changeset
821 face name and a color name, with completion, and then setup that face to
5428e8f8fbda (Font Lock): Explain how to customize Font Lock faces.
Eli Zaretskii <eliz@gnu.org>
parents: 31609
diff changeset
822 use the specified color.
5428e8f8fbda (Font Lock): Explain how to customize Font Lock faces.
Eli Zaretskii <eliz@gnu.org>
parents: 31609
diff changeset
823
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
824 @findex list-faces-display
Dave Love <fx@gnu.org>
parents:
diff changeset
825 To see what faces are currently defined, and what they look like, type
Dave Love <fx@gnu.org>
parents:
diff changeset
826 @kbd{M-x list-faces-display}. It's possible for a given face to look
Dave Love <fx@gnu.org>
parents:
diff changeset
827 different in different frames; this command shows the appearance in the
Dave Love <fx@gnu.org>
parents:
diff changeset
828 frame in which you type it. Here's a list of the standardly defined
Dave Love <fx@gnu.org>
parents:
diff changeset
829 faces:
Dave Love <fx@gnu.org>
parents:
diff changeset
830
Dave Love <fx@gnu.org>
parents:
diff changeset
831 @table @code
Dave Love <fx@gnu.org>
parents:
diff changeset
832 @item default
Dave Love <fx@gnu.org>
parents:
diff changeset
833 This face is used for ordinary text that doesn't specify any other face.
Dave Love <fx@gnu.org>
parents:
diff changeset
834 @item modeline
27224
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
835 This face is used for mode lines. By default, it's drawn with shadows
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
836 for a `raised' effect under X and set up as the inverse of the default
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
837 face on non-windowed terminals. @xref{Display Vars}.
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
838 @item header-line
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
839 Similar to @code{modeline} for a window's header line.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
840 @item highlight
Dave Love <fx@gnu.org>
parents:
diff changeset
841 This face is used for highlighting portions of text, in various modes.
Dave Love <fx@gnu.org>
parents:
diff changeset
842 @item region
Dave Love <fx@gnu.org>
parents:
diff changeset
843 This face is used for displaying a selected region (when Transient Mark
Dave Love <fx@gnu.org>
parents:
diff changeset
844 mode is enabled---see below).
Dave Love <fx@gnu.org>
parents:
diff changeset
845 @item secondary-selection
Dave Love <fx@gnu.org>
parents:
diff changeset
846 This face is used for displaying a secondary selection (@pxref{Secondary
Dave Love <fx@gnu.org>
parents:
diff changeset
847 Selection}).
Dave Love <fx@gnu.org>
parents:
diff changeset
848 @item bold
Dave Love <fx@gnu.org>
parents:
diff changeset
849 This face uses a bold variant of the default font, if it has one.
Dave Love <fx@gnu.org>
parents:
diff changeset
850 @item italic
Dave Love <fx@gnu.org>
parents:
diff changeset
851 This face uses an italic variant of the default font, if it has one.
Dave Love <fx@gnu.org>
parents:
diff changeset
852 @item bold-italic
Dave Love <fx@gnu.org>
parents:
diff changeset
853 This face uses a bold italic variant of the default font, if it has one.
Dave Love <fx@gnu.org>
parents:
diff changeset
854 @item underline
Dave Love <fx@gnu.org>
parents:
diff changeset
855 This face underlines text.
27224
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
856 @item fixed-pitch
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
857 The basic fixed-pitch face.
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
858 @item fringe
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
859 The face for the fringes to the left and right of windows under X.
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
860 @item scroll-bar
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
861 This face determines the colors of the scroll bar.
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
862 @item border
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
863 This face determines the color of the frame border.
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
864 @item cursor
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
865 This face determines the color of the cursor.
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
866 @item mouse
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
867 This face determines the color of the mouse pointer.
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
868 @item tool-bar
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
869 The basic tool-bar face.
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
870 @item menu
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
871 This face determines the colors and font of Emacs's menus. Setting the
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
872 font of LessTif/Motif menus is currently not supported; attempts to set
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
873 the font are ignored in this case.
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
874 @item trailing-whitespace
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
875 The face for highlighting trailing whitespace when
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
876 @code{show-trailing-whitespace} is non-nil.
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
877 @item variable-pitch
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
878 The basic variable-pitch face.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
879 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
880
Dave Love <fx@gnu.org>
parents:
diff changeset
881 @cindex @code{region} face
Dave Love <fx@gnu.org>
parents:
diff changeset
882 When Transient Mark mode is enabled, the text of the region is
Dave Love <fx@gnu.org>
parents:
diff changeset
883 highlighted when the mark is active. This uses the face named
Dave Love <fx@gnu.org>
parents:
diff changeset
884 @code{region}; you can control the style of highlighting by changing the
Dave Love <fx@gnu.org>
parents:
diff changeset
885 style of this face (@pxref{Face Customization}). @xref{Transient Mark},
Dave Love <fx@gnu.org>
parents:
diff changeset
886 for more information about Transient Mark mode and activation and
Dave Love <fx@gnu.org>
parents:
diff changeset
887 deactivation of the mark.
Dave Love <fx@gnu.org>
parents:
diff changeset
888
Dave Love <fx@gnu.org>
parents:
diff changeset
889 One easy way to use faces is to turn on Font Lock mode. This minor
Dave Love <fx@gnu.org>
parents:
diff changeset
890 mode, which is always local to a particular buffer, arranges to
Dave Love <fx@gnu.org>
parents:
diff changeset
891 choose faces according to the syntax of the text you are editing. It
Dave Love <fx@gnu.org>
parents:
diff changeset
892 can recognize comments and strings in most languages; in several
Dave Love <fx@gnu.org>
parents:
diff changeset
893 languages, it can also recognize and properly highlight various other
Dave Love <fx@gnu.org>
parents:
diff changeset
894 important constructs. @xref{Font Lock}, for more information about
Dave Love <fx@gnu.org>
parents:
diff changeset
895 Font Lock mode and syntactic highlighting.
Dave Love <fx@gnu.org>
parents:
diff changeset
896
Dave Love <fx@gnu.org>
parents:
diff changeset
897 You can print out the buffer with the highlighting that appears
Dave Love <fx@gnu.org>
parents:
diff changeset
898 on your screen using the command @code{ps-print-buffer-with-faces}.
27224
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
899 @xref{PostScript}.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
900
Dave Love <fx@gnu.org>
parents:
diff changeset
901 @node Font Lock
Dave Love <fx@gnu.org>
parents:
diff changeset
902 @section Font Lock mode
Dave Love <fx@gnu.org>
parents:
diff changeset
903 @cindex Font Lock mode
Dave Love <fx@gnu.org>
parents:
diff changeset
904 @cindex mode, Font Lock
Dave Love <fx@gnu.org>
parents:
diff changeset
905 @cindex syntax highlighting
27224
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
906 @cindex syntax coloring
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
907
Dave Love <fx@gnu.org>
parents:
diff changeset
908 Font Lock mode is a minor mode, always local to a particular
Dave Love <fx@gnu.org>
parents:
diff changeset
909 buffer, which highlights (or ``fontifies'') using various faces
Dave Love <fx@gnu.org>
parents:
diff changeset
910 according to the syntax of the text you are editing. It can
Dave Love <fx@gnu.org>
parents:
diff changeset
911 recognize comments and strings in most languages; in several
Dave Love <fx@gnu.org>
parents:
diff changeset
912 languages, it can also recognize and properly highlight various other
Dave Love <fx@gnu.org>
parents:
diff changeset
913 important constructs---for example, names of functions being defined
Dave Love <fx@gnu.org>
parents:
diff changeset
914 or reserved keywords.
Dave Love <fx@gnu.org>
parents:
diff changeset
915
Dave Love <fx@gnu.org>
parents:
diff changeset
916 @findex font-lock-mode
Dave Love <fx@gnu.org>
parents:
diff changeset
917 @findex turn-on-font-lock
Dave Love <fx@gnu.org>
parents:
diff changeset
918 The command @kbd{M-x font-lock-mode} turns Font Lock mode on or off
Dave Love <fx@gnu.org>
parents:
diff changeset
919 according to the argument, and toggles the mode when it has no argument.
Dave Love <fx@gnu.org>
parents:
diff changeset
920 The function @code{turn-on-font-lock} unconditionally enables Font Lock
Dave Love <fx@gnu.org>
parents:
diff changeset
921 mode. This is useful in mode-hook functions. For example, to enable
Dave Love <fx@gnu.org>
parents:
diff changeset
922 Font Lock mode whenever you edit a C file, you can do this:
Dave Love <fx@gnu.org>
parents:
diff changeset
923
Dave Love <fx@gnu.org>
parents:
diff changeset
924 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
925 (add-hook 'c-mode-hook 'turn-on-font-lock)
Dave Love <fx@gnu.org>
parents:
diff changeset
926 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
927
Dave Love <fx@gnu.org>
parents:
diff changeset
928 @findex global-font-lock-mode
27224
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
929 @vindex global-font-lock-mode
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
930 To turn on Font Lock mode automatically in all modes which support it,
27224
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
931 customize the user option @code{global-font-lock-mode} or use the
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
932 function @code{global-font-lock-mode}, like this:
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
933
Dave Love <fx@gnu.org>
parents:
diff changeset
934 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
935 (global-font-lock-mode 1)
Dave Love <fx@gnu.org>
parents:
diff changeset
936 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
937
32274
5428e8f8fbda (Font Lock): Explain how to customize Font Lock faces.
Eli Zaretskii <eliz@gnu.org>
parents: 31609
diff changeset
938 To change the colors or the fonts used by Font Lock mode to fontify
5428e8f8fbda (Font Lock): Explain how to customize Font Lock faces.
Eli Zaretskii <eliz@gnu.org>
parents: 31609
diff changeset
939 different parts of text, you can use one of the following:
5428e8f8fbda (Font Lock): Explain how to customize Font Lock faces.
Eli Zaretskii <eliz@gnu.org>
parents: 31609
diff changeset
940
5428e8f8fbda (Font Lock): Explain how to customize Font Lock faces.
Eli Zaretskii <eliz@gnu.org>
parents: 31609
diff changeset
941 @itemize @bullet
5428e8f8fbda (Font Lock): Explain how to customize Font Lock faces.
Eli Zaretskii <eliz@gnu.org>
parents: 31609
diff changeset
942 @item
5428e8f8fbda (Font Lock): Explain how to customize Font Lock faces.
Eli Zaretskii <eliz@gnu.org>
parents: 31609
diff changeset
943 Invoke @kbd{M-x set-face-foreground} or @kbd{M-x set-face-background} to
5428e8f8fbda (Font Lock): Explain how to customize Font Lock faces.
Eli Zaretskii <eliz@gnu.org>
parents: 31609
diff changeset
944 change the colors of a particular face, such as
5428e8f8fbda (Font Lock): Explain how to customize Font Lock faces.
Eli Zaretskii <eliz@gnu.org>
parents: 31609
diff changeset
945 @code{font-lock-variable-name-face}, used by Font Lock. @xref{Faces}.
5428e8f8fbda (Font Lock): Explain how to customize Font Lock faces.
Eli Zaretskii <eliz@gnu.org>
parents: 31609
diff changeset
946 The command @kbd{M-x list-faces-display} displays all the faces
5428e8f8fbda (Font Lock): Explain how to customize Font Lock faces.
Eli Zaretskii <eliz@gnu.org>
parents: 31609
diff changeset
947 currently known to Emacs, including those used by Font Lock.
5428e8f8fbda (Font Lock): Explain how to customize Font Lock faces.
Eli Zaretskii <eliz@gnu.org>
parents: 31609
diff changeset
948
5428e8f8fbda (Font Lock): Explain how to customize Font Lock faces.
Eli Zaretskii <eliz@gnu.org>
parents: 31609
diff changeset
949 @item
5428e8f8fbda (Font Lock): Explain how to customize Font Lock faces.
Eli Zaretskii <eliz@gnu.org>
parents: 31609
diff changeset
950 Customize the faces interactively with @kbd{M-x customize-face}, as
5428e8f8fbda (Font Lock): Explain how to customize Font Lock faces.
Eli Zaretskii <eliz@gnu.org>
parents: 31609
diff changeset
951 described in @ref{Face Customization}.
5428e8f8fbda (Font Lock): Explain how to customize Font Lock faces.
Eli Zaretskii <eliz@gnu.org>
parents: 31609
diff changeset
952 @end itemize
5428e8f8fbda (Font Lock): Explain how to customize Font Lock faces.
Eli Zaretskii <eliz@gnu.org>
parents: 31609
diff changeset
953
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
954 @kindex M-g M-g
Dave Love <fx@gnu.org>
parents:
diff changeset
955 @findex font-lock-fontify-block
Dave Love <fx@gnu.org>
parents:
diff changeset
956 In Font Lock mode, when you edit the text, the highlighting updates
Dave Love <fx@gnu.org>
parents:
diff changeset
957 automatically in the line that you changed. Most changes don't affect
Dave Love <fx@gnu.org>
parents:
diff changeset
958 the highlighting of subsequent lines, but occasionally they do. To
Dave Love <fx@gnu.org>
parents:
diff changeset
959 rehighlight a range of lines, use the command @kbd{M-g M-g}
Dave Love <fx@gnu.org>
parents:
diff changeset
960 (@code{font-lock-fontify-block}).
Dave Love <fx@gnu.org>
parents:
diff changeset
961
Dave Love <fx@gnu.org>
parents:
diff changeset
962 @vindex font-lock-mark-block-function
Dave Love <fx@gnu.org>
parents:
diff changeset
963 In certain major modes, @kbd{M-g M-g} refontifies the entire current
Dave Love <fx@gnu.org>
parents:
diff changeset
964 function. (The variable @code{font-lock-mark-block-function} controls
Dave Love <fx@gnu.org>
parents:
diff changeset
965 how to find the current function.) In other major modes, @kbd{M-g M-g}
Dave Love <fx@gnu.org>
parents:
diff changeset
966 refontifies 16 lines above and below point.
Dave Love <fx@gnu.org>
parents:
diff changeset
967
Dave Love <fx@gnu.org>
parents:
diff changeset
968 With a prefix argument @var{n}, @kbd{M-g M-g} refontifies @var{n}
Dave Love <fx@gnu.org>
parents:
diff changeset
969 lines above and below point, regardless of the mode.
Dave Love <fx@gnu.org>
parents:
diff changeset
970
Dave Love <fx@gnu.org>
parents:
diff changeset
971 To get the full benefit of Font Lock mode, you need to choose a
Dave Love <fx@gnu.org>
parents:
diff changeset
972 default font which has bold, italic, and bold-italic variants; or else
Dave Love <fx@gnu.org>
parents:
diff changeset
973 you need to have a color or gray-scale screen.
Dave Love <fx@gnu.org>
parents:
diff changeset
974
Dave Love <fx@gnu.org>
parents:
diff changeset
975 @vindex font-lock-maximum-decoration
Dave Love <fx@gnu.org>
parents:
diff changeset
976 The variable @code{font-lock-maximum-decoration} specifies the
Dave Love <fx@gnu.org>
parents:
diff changeset
977 preferred level of fontification, for modes that provide multiple
Dave Love <fx@gnu.org>
parents:
diff changeset
978 levels. Level 1 is the least amount of fontification; some modes
Dave Love <fx@gnu.org>
parents:
diff changeset
979 support levels as high as 3. The normal default is ``as high as
Dave Love <fx@gnu.org>
parents:
diff changeset
980 possible.'' You can specify an integer, which applies to all modes, or
Dave Love <fx@gnu.org>
parents:
diff changeset
981 you can specify different numbers for particular major modes; for
Dave Love <fx@gnu.org>
parents:
diff changeset
982 example, to use level 1 for C/C++ modes, and the default level
Dave Love <fx@gnu.org>
parents:
diff changeset
983 otherwise, use this:
Dave Love <fx@gnu.org>
parents:
diff changeset
984
Dave Love <fx@gnu.org>
parents:
diff changeset
985 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
986 (setq font-lock-maximum-decoration
Dave Love <fx@gnu.org>
parents:
diff changeset
987 '((c-mode . 1) (c++-mode . 1)))
Dave Love <fx@gnu.org>
parents:
diff changeset
988 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
989
Dave Love <fx@gnu.org>
parents:
diff changeset
990 @vindex font-lock-maximum-size
Dave Love <fx@gnu.org>
parents:
diff changeset
991 Fontification can be too slow for large buffers, so you can suppress
Dave Love <fx@gnu.org>
parents:
diff changeset
992 it. The variable @code{font-lock-maximum-size} specifies a buffer size,
Dave Love <fx@gnu.org>
parents:
diff changeset
993 beyond which buffer fontification is suppressed.
Dave Love <fx@gnu.org>
parents:
diff changeset
994
Dave Love <fx@gnu.org>
parents:
diff changeset
995 @c @w is used below to prevent a bad page-break.
Dave Love <fx@gnu.org>
parents:
diff changeset
996 @vindex font-lock-beginning-of-syntax-function
Dave Love <fx@gnu.org>
parents:
diff changeset
997 Comment and string fontification (or ``syntactic'' fontification)
Dave Love <fx@gnu.org>
parents:
diff changeset
998 relies on analysis of the syntactic structure of the buffer text. For
Dave Love <fx@gnu.org>
parents:
diff changeset
999 the purposes of speed, some modes including C mode and Lisp mode rely on
Dave Love <fx@gnu.org>
parents:
diff changeset
1000 a special convention: an open-parenthesis in the leftmost column always
Dave Love <fx@gnu.org>
parents:
diff changeset
1001 defines the @w{beginning} of a defun, and is thus always outside any string
Dave Love <fx@gnu.org>
parents:
diff changeset
1002 or comment. (@xref{Defuns}.) If you don't follow this convention,
Dave Love <fx@gnu.org>
parents:
diff changeset
1003 then Font Lock mode can misfontify the text after an open-parenthesis in
Dave Love <fx@gnu.org>
parents:
diff changeset
1004 the leftmost column that is inside a string or comment.
Dave Love <fx@gnu.org>
parents:
diff changeset
1005
Dave Love <fx@gnu.org>
parents:
diff changeset
1006 The variable @code{font-lock-beginning-of-syntax-function} (always
Dave Love <fx@gnu.org>
parents:
diff changeset
1007 buffer-local) specifies how Font Lock mode can find a position
Dave Love <fx@gnu.org>
parents:
diff changeset
1008 guaranteed to be outside any comment or string. In modes which use the
Dave Love <fx@gnu.org>
parents:
diff changeset
1009 leftmost column parenthesis convention, the default value of the variable
Dave Love <fx@gnu.org>
parents:
diff changeset
1010 is @code{beginning-of-defun}---that tells Font Lock mode to use the
Dave Love <fx@gnu.org>
parents:
diff changeset
1011 convention. If you set this variable to @code{nil}, Font Lock no longer
Dave Love <fx@gnu.org>
parents:
diff changeset
1012 relies on the convention. This avoids incorrect results, but the price
Dave Love <fx@gnu.org>
parents:
diff changeset
1013 is that, in some cases, fontification for a changed text must rescan
Dave Love <fx@gnu.org>
parents:
diff changeset
1014 buffer text from the beginning of the buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
1015
Dave Love <fx@gnu.org>
parents:
diff changeset
1016 @findex font-lock-add-keywords
Dave Love <fx@gnu.org>
parents:
diff changeset
1017 Font Lock highlighting patterns already exist for many modes, but you
Dave Love <fx@gnu.org>
parents:
diff changeset
1018 may want to fontify additional patterns. You can use the function
Dave Love <fx@gnu.org>
parents:
diff changeset
1019 @code{font-lock-add-keywords}, to add your own highlighting patterns for
Dave Love <fx@gnu.org>
parents:
diff changeset
1020 a particular mode. For example, to highlight @samp{FIXME:} words in C
Dave Love <fx@gnu.org>
parents:
diff changeset
1021 comments, use this:
Dave Love <fx@gnu.org>
parents:
diff changeset
1022
Dave Love <fx@gnu.org>
parents:
diff changeset
1023 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1024 (font-lock-add-keywords
Dave Love <fx@gnu.org>
parents:
diff changeset
1025 'c-mode
Dave Love <fx@gnu.org>
parents:
diff changeset
1026 '(("\\<\\(FIXME\\):" 1 font-lock-warning-face t)))
Dave Love <fx@gnu.org>
parents:
diff changeset
1027 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1028
Dave Love <fx@gnu.org>
parents:
diff changeset
1029 @node Support Modes
Dave Love <fx@gnu.org>
parents:
diff changeset
1030 @section Font Lock Support Modes
Dave Love <fx@gnu.org>
parents:
diff changeset
1031
Dave Love <fx@gnu.org>
parents:
diff changeset
1032 Font Lock support modes make Font Lock mode faster for large buffers.
Dave Love <fx@gnu.org>
parents:
diff changeset
1033 There are two support modes: Fast Lock mode and Lazy Lock mode. They
Dave Love <fx@gnu.org>
parents:
diff changeset
1034 use two different methods of speeding up Font Lock mode.
Dave Love <fx@gnu.org>
parents:
diff changeset
1035
Dave Love <fx@gnu.org>
parents:
diff changeset
1036 @menu
Dave Love <fx@gnu.org>
parents:
diff changeset
1037 * Fast Lock Mode:: Saving font information in files.
Dave Love <fx@gnu.org>
parents:
diff changeset
1038 * Lazy Lock Mode:: Fontifying only text that is actually displayed.
27224
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
1039 * JIT Lock Mode:: Like Lazy Lock, but generally faster.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1040 * Fast or Lazy:: Which support mode is best for you?
Dave Love <fx@gnu.org>
parents:
diff changeset
1041 @end menu
Dave Love <fx@gnu.org>
parents:
diff changeset
1042
Dave Love <fx@gnu.org>
parents:
diff changeset
1043 @node Fast Lock Mode
Dave Love <fx@gnu.org>
parents:
diff changeset
1044 @subsection Fast Lock Mode
Dave Love <fx@gnu.org>
parents:
diff changeset
1045
Dave Love <fx@gnu.org>
parents:
diff changeset
1046 @cindex Fast Lock mode
Dave Love <fx@gnu.org>
parents:
diff changeset
1047 @cindex mode, Fast Lock
Dave Love <fx@gnu.org>
parents:
diff changeset
1048 To make Font Lock mode faster for buffers visiting large files, you
Dave Love <fx@gnu.org>
parents:
diff changeset
1049 can use Fast Lock mode. Fast Lock mode saves the font information for
Dave Love <fx@gnu.org>
parents:
diff changeset
1050 each file in a separate cache file; each time you visit the file, it
Dave Love <fx@gnu.org>
parents:
diff changeset
1051 rereads the font information from the cache file instead of refontifying
Dave Love <fx@gnu.org>
parents:
diff changeset
1052 the text from scratch.
Dave Love <fx@gnu.org>
parents:
diff changeset
1053
Dave Love <fx@gnu.org>
parents:
diff changeset
1054 @findex fast-lock-mode
Dave Love <fx@gnu.org>
parents:
diff changeset
1055 The command @kbd{M-x fast-lock-mode} turns Fast Lock mode on or off,
Dave Love <fx@gnu.org>
parents:
diff changeset
1056 according to the argument (with no argument, it toggles). You can also
Dave Love <fx@gnu.org>
parents:
diff changeset
1057 arrange to enable Fast Lock mode whenever you use Font Lock mode, like
Dave Love <fx@gnu.org>
parents:
diff changeset
1058 this:
Dave Love <fx@gnu.org>
parents:
diff changeset
1059
Dave Love <fx@gnu.org>
parents:
diff changeset
1060 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1061 (setq font-lock-support-mode 'fast-lock-mode)
Dave Love <fx@gnu.org>
parents:
diff changeset
1062 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1063
Dave Love <fx@gnu.org>
parents:
diff changeset
1064 @vindex fast-lock-minimum-size
Dave Love <fx@gnu.org>
parents:
diff changeset
1065 It is not worth writing a cache file for small buffers. Therefore,
Dave Love <fx@gnu.org>
parents:
diff changeset
1066 the variable @code{fast-lock-minimum-size} specifies a minimum file size
Dave Love <fx@gnu.org>
parents:
diff changeset
1067 for caching font information.
Dave Love <fx@gnu.org>
parents:
diff changeset
1068
Dave Love <fx@gnu.org>
parents:
diff changeset
1069 @vindex fast-lock-cache-directories
Dave Love <fx@gnu.org>
parents:
diff changeset
1070 The variable @code{fast-lock-cache-directories} specifies where to put
Dave Love <fx@gnu.org>
parents:
diff changeset
1071 the cache files. Its value is a list of directories to try; @code{"."}
Dave Love <fx@gnu.org>
parents:
diff changeset
1072 means the same directory as the file being edited. The default value is
Dave Love <fx@gnu.org>
parents:
diff changeset
1073 @w{@code{("." "~/.emacs-flc")}}, which means to use the same directory if
Dave Love <fx@gnu.org>
parents:
diff changeset
1074 possible, and otherwise the directory @file{~/.emacs-flc}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1075
Dave Love <fx@gnu.org>
parents:
diff changeset
1076 @vindex fast-lock-save-others
Dave Love <fx@gnu.org>
parents:
diff changeset
1077 The variable @code{fast-lock-save-others} specifies whether Fast Lock
Dave Love <fx@gnu.org>
parents:
diff changeset
1078 mode should save cache files for files that you do not own. A
Dave Love <fx@gnu.org>
parents:
diff changeset
1079 non-@code{nil} value means yes (and that is the default).
Dave Love <fx@gnu.org>
parents:
diff changeset
1080
Dave Love <fx@gnu.org>
parents:
diff changeset
1081 @node Lazy Lock Mode
Dave Love <fx@gnu.org>
parents:
diff changeset
1082 @subsection Lazy Lock Mode
Dave Love <fx@gnu.org>
parents:
diff changeset
1083 @cindex Lazy Lock mode
Dave Love <fx@gnu.org>
parents:
diff changeset
1084 @cindex mode, Lazy Lock
Dave Love <fx@gnu.org>
parents:
diff changeset
1085
Dave Love <fx@gnu.org>
parents:
diff changeset
1086 To make Font Lock mode faster for large buffers, you can use Lazy Lock
Dave Love <fx@gnu.org>
parents:
diff changeset
1087 mode to reduce the amount of text that is fontified. In Lazy Lock mode,
Dave Love <fx@gnu.org>
parents:
diff changeset
1088 buffer fontification is demand-driven; it happens to portions of the
Dave Love <fx@gnu.org>
parents:
diff changeset
1089 buffer that are about to be displayed. And fontification of your
Dave Love <fx@gnu.org>
parents:
diff changeset
1090 changes is deferred; it happens only when Emacs has been idle for a
Dave Love <fx@gnu.org>
parents:
diff changeset
1091 certain short period of time.
Dave Love <fx@gnu.org>
parents:
diff changeset
1092
Dave Love <fx@gnu.org>
parents:
diff changeset
1093 @findex lazy-lock-mode
Dave Love <fx@gnu.org>
parents:
diff changeset
1094 The command @kbd{M-x lazy-lock-mode} turns Lazy Lock mode on or off,
Dave Love <fx@gnu.org>
parents:
diff changeset
1095 according to the argument (with no argument, it toggles). You can also
Dave Love <fx@gnu.org>
parents:
diff changeset
1096 arrange to enable Lazy Lock mode whenever you use Font Lock mode, like
Dave Love <fx@gnu.org>
parents:
diff changeset
1097 this:
Dave Love <fx@gnu.org>
parents:
diff changeset
1098
Dave Love <fx@gnu.org>
parents:
diff changeset
1099 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1100 (setq font-lock-support-mode 'lazy-lock-mode)
Dave Love <fx@gnu.org>
parents:
diff changeset
1101 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1102
Dave Love <fx@gnu.org>
parents:
diff changeset
1103 @vindex lazy-lock-minimum-size
Dave Love <fx@gnu.org>
parents:
diff changeset
1104 It is not worth avoiding buffer fontification for small buffers.
Dave Love <fx@gnu.org>
parents:
diff changeset
1105 Therefore, the variable @code{lazy-lock-minimum-size} specifies a
Dave Love <fx@gnu.org>
parents:
diff changeset
1106 minimum buffer size for demand-driven buffer fontification. Buffers
Dave Love <fx@gnu.org>
parents:
diff changeset
1107 smaller than that are fontified all at once, as in plain Font Lock mode.
Dave Love <fx@gnu.org>
parents:
diff changeset
1108
Dave Love <fx@gnu.org>
parents:
diff changeset
1109 @vindex lazy-lock-defer-time
Dave Love <fx@gnu.org>
parents:
diff changeset
1110 When you alter the buffer, Lazy Lock mode defers fontification of the
Dave Love <fx@gnu.org>
parents:
diff changeset
1111 text you changed. The variable @code{lazy-lock-defer-time} specifies
Dave Love <fx@gnu.org>
parents:
diff changeset
1112 how many seconds Emacs must be idle before it starts fontifying your
Dave Love <fx@gnu.org>
parents:
diff changeset
1113 changes. If the value is 0, then changes are fontified immediately, as
Dave Love <fx@gnu.org>
parents:
diff changeset
1114 in plain Font Lock mode.
Dave Love <fx@gnu.org>
parents:
diff changeset
1115
Dave Love <fx@gnu.org>
parents:
diff changeset
1116 @vindex lazy-lock-defer-on-scrolling
Dave Love <fx@gnu.org>
parents:
diff changeset
1117 Lazy Lock mode normally fontifies newly visible portions of the buffer
Dave Love <fx@gnu.org>
parents:
diff changeset
1118 before they are first displayed. However, if the value of
Dave Love <fx@gnu.org>
parents:
diff changeset
1119 @code{lazy-lock-defer-on-scrolling} is non-@code{nil}, newly visible
Dave Love <fx@gnu.org>
parents:
diff changeset
1120 text is fontified only when Emacs is idle for
Dave Love <fx@gnu.org>
parents:
diff changeset
1121 @code{lazy-lock-defer-time} seconds.
Dave Love <fx@gnu.org>
parents:
diff changeset
1122
Dave Love <fx@gnu.org>
parents:
diff changeset
1123 @vindex lazy-lock-defer-contextually
Dave Love <fx@gnu.org>
parents:
diff changeset
1124 In some modes, including C mode and Emacs Lisp mode, changes in one
Dave Love <fx@gnu.org>
parents:
diff changeset
1125 line's contents can alter the context for subsequent lines, and thus
Dave Love <fx@gnu.org>
parents:
diff changeset
1126 change how they ought to be fontified. Ordinarily, you must type
Dave Love <fx@gnu.org>
parents:
diff changeset
1127 @kbd{M-g M-g} to refontify the subsequent lines. However, if you set
Dave Love <fx@gnu.org>
parents:
diff changeset
1128 the variable @code{lazy-lock-defer-contextually} to non-@code{nil}, Lazy
Dave Love <fx@gnu.org>
parents:
diff changeset
1129 Lock mode does this automatically, after @code{lazy-lock-defer-time}
Dave Love <fx@gnu.org>
parents:
diff changeset
1130 seconds.
Dave Love <fx@gnu.org>
parents:
diff changeset
1131
Dave Love <fx@gnu.org>
parents:
diff changeset
1132 @cindex stealth fontification
Dave Love <fx@gnu.org>
parents:
diff changeset
1133 When Emacs is idle for a long time, Lazy Lock fontifies additional
Dave Love <fx@gnu.org>
parents:
diff changeset
1134 portions of the buffer, not yet displayed, in case you will display them
Dave Love <fx@gnu.org>
parents:
diff changeset
1135 later. This is called @dfn{stealth fontification}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1136
Dave Love <fx@gnu.org>
parents:
diff changeset
1137 @vindex lazy-lock-stealth-time
Dave Love <fx@gnu.org>
parents:
diff changeset
1138 @vindex lazy-lock-stealth-lines
Dave Love <fx@gnu.org>
parents:
diff changeset
1139 @vindex lazy-lock-stealth-verbose
Dave Love <fx@gnu.org>
parents:
diff changeset
1140 The variable @code{lazy-lock-stealth-time} specifies how many seconds
Dave Love <fx@gnu.org>
parents:
diff changeset
1141 Emacs has to be idle before stealth fontification starts. A value of
Dave Love <fx@gnu.org>
parents:
diff changeset
1142 @code{nil} means no stealth fontification. The variables
Dave Love <fx@gnu.org>
parents:
diff changeset
1143 @code{lazy-lock-stealth-lines} and @code{lazy-lock-stealth-verbose}
Dave Love <fx@gnu.org>
parents:
diff changeset
1144 specify the granularity and verbosity of stealth fontification.
Dave Love <fx@gnu.org>
parents:
diff changeset
1145
27224
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
1146 @node JIT Lock Mode
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
1147 @subsection JIT Lock Mode
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
1148
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
1149 @findex jit-lock-mode
29800
b64123677c0b (JIT Lock Mode): jit-lock-mode is not a command any more.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 29107
diff changeset
1150 This Just-In-time support mode is roughly equivalent to Lazy Lock but is
b64123677c0b (JIT Lock Mode): jit-lock-mode is not a command any more.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 29107
diff changeset
1151 generally faster and more robust. It supports stealth and deferred
b64123677c0b (JIT Lock Mode): jit-lock-mode is not a command any more.
Stefan Monnier <monnier@iro.umontreal.ca>
parents: 29107
diff changeset
1152 contextual fontification.
27224
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
1153
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
1154 Font-lock uses @code{jit-lock-mode} as default support mode, so you
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
1155 don't have to do anything to activate it.
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
1156
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1157 @node Fast or Lazy
Dave Love <fx@gnu.org>
parents:
diff changeset
1158 @subsection Fast Lock or Lazy Lock?
Dave Love <fx@gnu.org>
parents:
diff changeset
1159
Dave Love <fx@gnu.org>
parents:
diff changeset
1160 Here is a simple guide to help you choose one of the Font Lock support
Dave Love <fx@gnu.org>
parents:
diff changeset
1161 modes.
Dave Love <fx@gnu.org>
parents:
diff changeset
1162
Dave Love <fx@gnu.org>
parents:
diff changeset
1163 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
1164 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
1165 Fast Lock mode intervenes only during file visiting and buffer
Dave Love <fx@gnu.org>
parents:
diff changeset
1166 killing (and related events); therefore buffer editing and window
Dave Love <fx@gnu.org>
parents:
diff changeset
1167 scrolling are no faster or slower than in plain Font Lock mode.
Dave Love <fx@gnu.org>
parents:
diff changeset
1168
Dave Love <fx@gnu.org>
parents:
diff changeset
1169 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
1170 Fast Lock mode is slower at reading a cache file than Lazy Lock
Dave Love <fx@gnu.org>
parents:
diff changeset
1171 mode is at fontifying a window; therefore Fast Lock mode is slower at
Dave Love <fx@gnu.org>
parents:
diff changeset
1172 visiting a file than Lazy Lock mode.
Dave Love <fx@gnu.org>
parents:
diff changeset
1173
Dave Love <fx@gnu.org>
parents:
diff changeset
1174 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
1175 Lazy Lock mode intervenes during window scrolling to fontify text that
Dave Love <fx@gnu.org>
parents:
diff changeset
1176 scrolls onto the screen; therefore, scrolling is slower than in plain
Dave Love <fx@gnu.org>
parents:
diff changeset
1177 Font Lock mode.
Dave Love <fx@gnu.org>
parents:
diff changeset
1178
Dave Love <fx@gnu.org>
parents:
diff changeset
1179 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
1180 Lazy Lock mode doesn't fontify during buffer editing (it defers
Dave Love <fx@gnu.org>
parents:
diff changeset
1181 fontification of changes); therefore, editing is faster than in plain
Dave Love <fx@gnu.org>
parents:
diff changeset
1182 Font Lock mode.
Dave Love <fx@gnu.org>
parents:
diff changeset
1183
Dave Love <fx@gnu.org>
parents:
diff changeset
1184 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
1185 Fast Lock mode can be fooled by a file that is kept under version
Dave Love <fx@gnu.org>
parents:
diff changeset
1186 control software; therefore buffer fontification may occur even when
Dave Love <fx@gnu.org>
parents:
diff changeset
1187 a cache file exists for the file.
Dave Love <fx@gnu.org>
parents:
diff changeset
1188
Dave Love <fx@gnu.org>
parents:
diff changeset
1189 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
1190 Fast Lock mode only works with a buffer visiting a file; Lazy Lock
Dave Love <fx@gnu.org>
parents:
diff changeset
1191 mode works with any buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
1192
Dave Love <fx@gnu.org>
parents:
diff changeset
1193 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
1194 Fast Lock mode generates cache files; Lazy Lock mode does not.
Dave Love <fx@gnu.org>
parents:
diff changeset
1195 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
1196
Dave Love <fx@gnu.org>
parents:
diff changeset
1197 @vindex font-lock-support-mode
Dave Love <fx@gnu.org>
parents:
diff changeset
1198 The variable @code{font-lock-support-mode} specifies which of these
Dave Love <fx@gnu.org>
parents:
diff changeset
1199 support modes to use; for example, to specify that Fast Lock mode is
Dave Love <fx@gnu.org>
parents:
diff changeset
1200 used for C/C++ modes, and Lazy Lock mode otherwise, set the variable
Dave Love <fx@gnu.org>
parents:
diff changeset
1201 like this:
Dave Love <fx@gnu.org>
parents:
diff changeset
1202
Dave Love <fx@gnu.org>
parents:
diff changeset
1203 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1204 (setq font-lock-support-mode
Dave Love <fx@gnu.org>
parents:
diff changeset
1205 '((c-mode . fast-lock-mode) (c++-mode . fast-lock-mode)
Dave Love <fx@gnu.org>
parents:
diff changeset
1206 (t . lazy-lock-mode)))
Dave Love <fx@gnu.org>
parents:
diff changeset
1207 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1208
Dave Love <fx@gnu.org>
parents:
diff changeset
1209 @node Highlight Changes
Dave Love <fx@gnu.org>
parents:
diff changeset
1210 @section Highlight Changes Mode
Dave Love <fx@gnu.org>
parents:
diff changeset
1211
Dave Love <fx@gnu.org>
parents:
diff changeset
1212 @findex highlight-changes-mode
Dave Love <fx@gnu.org>
parents:
diff changeset
1213 Use @kbd{M-x highlight-changes-mode} to enable a minor mode
Dave Love <fx@gnu.org>
parents:
diff changeset
1214 that uses faces (colors, typically) to indicate which parts of
Dave Love <fx@gnu.org>
parents:
diff changeset
1215 the buffer were changed most recently.
Dave Love <fx@gnu.org>
parents:
diff changeset
1216
30583
c7e7209535ae (Highlight Interactively): Document the hi-lock mode.
Eli Zaretskii <eliz@gnu.org>
parents: 29800
diff changeset
1217 @node Highlight Interactively
c7e7209535ae (Highlight Interactively): Document the hi-lock mode.
Eli Zaretskii <eliz@gnu.org>
parents: 29800
diff changeset
1218 @section Interactive Highlighting of Arbitrary Text
c7e7209535ae (Highlight Interactively): Document the hi-lock mode.
Eli Zaretskii <eliz@gnu.org>
parents: 29800
diff changeset
1219
c7e7209535ae (Highlight Interactively): Document the hi-lock mode.
Eli Zaretskii <eliz@gnu.org>
parents: 29800
diff changeset
1220 @cindex highlighting, arbitrary text
c7e7209535ae (Highlight Interactively): Document the hi-lock mode.
Eli Zaretskii <eliz@gnu.org>
parents: 29800
diff changeset
1221 @cindex interactive highlighting
c7e7209535ae (Highlight Interactively): Document the hi-lock mode.
Eli Zaretskii <eliz@gnu.org>
parents: 29800
diff changeset
1222 Sometimes, you could need to highlight arbitrary strings in the
c7e7209535ae (Highlight Interactively): Document the hi-lock mode.
Eli Zaretskii <eliz@gnu.org>
parents: 29800
diff changeset
1223 buffer. For example, you might wish to see all the references to a
c7e7209535ae (Highlight Interactively): Document the hi-lock mode.
Eli Zaretskii <eliz@gnu.org>
parents: 29800
diff changeset
1224 certain variable in a program source file or highlight certain parts in
c7e7209535ae (Highlight Interactively): Document the hi-lock mode.
Eli Zaretskii <eliz@gnu.org>
parents: 29800
diff changeset
1225 a voluminous output of some program, or make certain cliches stand out.
c7e7209535ae (Highlight Interactively): Document the hi-lock mode.
Eli Zaretskii <eliz@gnu.org>
parents: 29800
diff changeset
1226
c7e7209535ae (Highlight Interactively): Document the hi-lock mode.
Eli Zaretskii <eliz@gnu.org>
parents: 29800
diff changeset
1227 @findex hi-lock-mode
c7e7209535ae (Highlight Interactively): Document the hi-lock mode.
Eli Zaretskii <eliz@gnu.org>
parents: 29800
diff changeset
1228 Use the @kbd{M-x hi-lock-mode} command to turn on a minor mode that
c7e7209535ae (Highlight Interactively): Document the hi-lock mode.
Eli Zaretskii <eliz@gnu.org>
parents: 29800
diff changeset
1229 allows you to specify regular expressions of the text to be highlighted.
c7e7209535ae (Highlight Interactively): Document the hi-lock mode.
Eli Zaretskii <eliz@gnu.org>
parents: 29800
diff changeset
1230 @code{hi-lock-mode} works like Font Lock (@pxref{Font Lock}), except
c7e7209535ae (Highlight Interactively): Document the hi-lock mode.
Eli Zaretskii <eliz@gnu.org>
parents: 29800
diff changeset
1231 that it lets you control what parts of text are highlighted.
c7e7209535ae (Highlight Interactively): Document the hi-lock mode.
Eli Zaretskii <eliz@gnu.org>
parents: 29800
diff changeset
1232 @code{hi-lock-mode} provides several functions:
c7e7209535ae (Highlight Interactively): Document the hi-lock mode.
Eli Zaretskii <eliz@gnu.org>
parents: 29800
diff changeset
1233
c7e7209535ae (Highlight Interactively): Document the hi-lock mode.
Eli Zaretskii <eliz@gnu.org>
parents: 29800
diff changeset
1234 @table @kbd
c7e7209535ae (Highlight Interactively): Document the hi-lock mode.
Eli Zaretskii <eliz@gnu.org>
parents: 29800
diff changeset
1235 @item C-x w h
c7e7209535ae (Highlight Interactively): Document the hi-lock mode.
Eli Zaretskii <eliz@gnu.org>
parents: 29800
diff changeset
1236 @kindex C-x w i
c7e7209535ae (Highlight Interactively): Document the hi-lock mode.
Eli Zaretskii <eliz@gnu.org>
parents: 29800
diff changeset
1237 @findex highlight-regexp
c7e7209535ae (Highlight Interactively): Document the hi-lock mode.
Eli Zaretskii <eliz@gnu.org>
parents: 29800
diff changeset
1238 Specify the regular expression (@pxref{Regexps}) for the parts of buffer
c7e7209535ae (Highlight Interactively): Document the hi-lock mode.
Eli Zaretskii <eliz@gnu.org>
parents: 29800
diff changeset
1239 text that are to be highlighted (@code{highlight-regexp}). It prompts
c7e7209535ae (Highlight Interactively): Document the hi-lock mode.
Eli Zaretskii <eliz@gnu.org>
parents: 29800
diff changeset
1240 for the regular expression, then for the name of the face with which to
c7e7209535ae (Highlight Interactively): Document the hi-lock mode.
Eli Zaretskii <eliz@gnu.org>
parents: 29800
diff changeset
1241 highlight the text that matches.
c7e7209535ae (Highlight Interactively): Document the hi-lock mode.
Eli Zaretskii <eliz@gnu.org>
parents: 29800
diff changeset
1242
c7e7209535ae (Highlight Interactively): Document the hi-lock mode.
Eli Zaretskii <eliz@gnu.org>
parents: 29800
diff changeset
1243 @item C-x w r
c7e7209535ae (Highlight Interactively): Document the hi-lock mode.
Eli Zaretskii <eliz@gnu.org>
parents: 29800
diff changeset
1244 @kindex C-x w r
c7e7209535ae (Highlight Interactively): Document the hi-lock mode.
Eli Zaretskii <eliz@gnu.org>
parents: 29800
diff changeset
1245 @findex unhighlight-regexp
c7e7209535ae (Highlight Interactively): Document the hi-lock mode.
Eli Zaretskii <eliz@gnu.org>
parents: 29800
diff changeset
1246 Unhighlight @var{regexp} (@code{unhighlight-regexp}). Prompts for the
c7e7209535ae (Highlight Interactively): Document the hi-lock mode.
Eli Zaretskii <eliz@gnu.org>
parents: 29800
diff changeset
1247 regular expression, and will accept only one of the regexps inserted by
c7e7209535ae (Highlight Interactively): Document the hi-lock mode.
Eli Zaretskii <eliz@gnu.org>
parents: 29800
diff changeset
1248 other @code{hi-lock} commands.
c7e7209535ae (Highlight Interactively): Document the hi-lock mode.
Eli Zaretskii <eliz@gnu.org>
parents: 29800
diff changeset
1249
c7e7209535ae (Highlight Interactively): Document the hi-lock mode.
Eli Zaretskii <eliz@gnu.org>
parents: 29800
diff changeset
1250 @item C-x w l
c7e7209535ae (Highlight Interactively): Document the hi-lock mode.
Eli Zaretskii <eliz@gnu.org>
parents: 29800
diff changeset
1251 @kindex C-x w l
c7e7209535ae (Highlight Interactively): Document the hi-lock mode.
Eli Zaretskii <eliz@gnu.org>
parents: 29800
diff changeset
1252 @findex highlight-lines-matching-regexp
c7e7209535ae (Highlight Interactively): Document the hi-lock mode.
Eli Zaretskii <eliz@gnu.org>
parents: 29800
diff changeset
1253 @cindex lines, highlighting
c7e7209535ae (Highlight Interactively): Document the hi-lock mode.
Eli Zaretskii <eliz@gnu.org>
parents: 29800
diff changeset
1254 @cindex highlighting lines of text
c7e7209535ae (Highlight Interactively): Document the hi-lock mode.
Eli Zaretskii <eliz@gnu.org>
parents: 29800
diff changeset
1255 Specify the regular expression (@pxref{Regexps}) for the lines of buffer
c7e7209535ae (Highlight Interactively): Document the hi-lock mode.
Eli Zaretskii <eliz@gnu.org>
parents: 29800
diff changeset
1256 text that are to be highlighted
c7e7209535ae (Highlight Interactively): Document the hi-lock mode.
Eli Zaretskii <eliz@gnu.org>
parents: 29800
diff changeset
1257 (@code{highlight-lines-matching-regexp}). It prompts for the regular
c7e7209535ae (Highlight Interactively): Document the hi-lock mode.
Eli Zaretskii <eliz@gnu.org>
parents: 29800
diff changeset
1258 expression, then for the name of the face with which to highlight the
c7e7209535ae (Highlight Interactively): Document the hi-lock mode.
Eli Zaretskii <eliz@gnu.org>
parents: 29800
diff changeset
1259 matching lines.
c7e7209535ae (Highlight Interactively): Document the hi-lock mode.
Eli Zaretskii <eliz@gnu.org>
parents: 29800
diff changeset
1260
c7e7209535ae (Highlight Interactively): Document the hi-lock mode.
Eli Zaretskii <eliz@gnu.org>
parents: 29800
diff changeset
1261 @item C-x w b
c7e7209535ae (Highlight Interactively): Document the hi-lock mode.
Eli Zaretskii <eliz@gnu.org>
parents: 29800
diff changeset
1262 @kindex C-x w b
c7e7209535ae (Highlight Interactively): Document the hi-lock mode.
Eli Zaretskii <eliz@gnu.org>
parents: 29800
diff changeset
1263 @findex hi-lock-write-interactive-patterns
c7e7209535ae (Highlight Interactively): Document the hi-lock mode.
Eli Zaretskii <eliz@gnu.org>
parents: 29800
diff changeset
1264 This runs the @code{hi-lock-write-interactive-patterns} command which
c7e7209535ae (Highlight Interactively): Document the hi-lock mode.
Eli Zaretskii <eliz@gnu.org>
parents: 29800
diff changeset
1265 inserts the patterns added by @kbd{M-x highlight-regexp} and @kbd{M-x
c7e7209535ae (Highlight Interactively): Document the hi-lock mode.
Eli Zaretskii <eliz@gnu.org>
parents: 29800
diff changeset
1266 highlight-lines-matching-regexp} into the current buffer at point, as
c7e7209535ae (Highlight Interactively): Document the hi-lock mode.
Eli Zaretskii <eliz@gnu.org>
parents: 29800
diff changeset
1267 comments. These patterns will be read the next time the file is
c7e7209535ae (Highlight Interactively): Document the hi-lock mode.
Eli Zaretskii <eliz@gnu.org>
parents: 29800
diff changeset
1268 visited, or when the @kbd{M-x hi-lock-find-patterns} command is issued.
c7e7209535ae (Highlight Interactively): Document the hi-lock mode.
Eli Zaretskii <eliz@gnu.org>
parents: 29800
diff changeset
1269
c7e7209535ae (Highlight Interactively): Document the hi-lock mode.
Eli Zaretskii <eliz@gnu.org>
parents: 29800
diff changeset
1270 @item C-x w i
c7e7209535ae (Highlight Interactively): Document the hi-lock mode.
Eli Zaretskii <eliz@gnu.org>
parents: 29800
diff changeset
1271 @kindex C-x w i
c7e7209535ae (Highlight Interactively): Document the hi-lock mode.
Eli Zaretskii <eliz@gnu.org>
parents: 29800
diff changeset
1272 @findex hi-lock-find-patterns
c7e7209535ae (Highlight Interactively): Document the hi-lock mode.
Eli Zaretskii <eliz@gnu.org>
parents: 29800
diff changeset
1273 @vindex hi-lock-exclude-modes
c7e7209535ae (Highlight Interactively): Document the hi-lock mode.
Eli Zaretskii <eliz@gnu.org>
parents: 29800
diff changeset
1274 Re-read patterns stored in a buffer in the format produced by @kbd{M-x
c7e7209535ae (Highlight Interactively): Document the hi-lock mode.
Eli Zaretskii <eliz@gnu.org>
parents: 29800
diff changeset
1275 hi-lock-write-interactive-patterns}
c7e7209535ae (Highlight Interactively): Document the hi-lock mode.
Eli Zaretskii <eliz@gnu.org>
parents: 29800
diff changeset
1276 (@code{hi-lock-write-interactive-patterns}. If you invoke this command
c7e7209535ae (Highlight Interactively): Document the hi-lock mode.
Eli Zaretskii <eliz@gnu.org>
parents: 29800
diff changeset
1277 in a buffer whose major mode is a member of the list that is the value
c7e7209535ae (Highlight Interactively): Document the hi-lock mode.
Eli Zaretskii <eliz@gnu.org>
parents: 29800
diff changeset
1278 of the variable @code{hi-lock-exclude-modes}, this command has no
c7e7209535ae (Highlight Interactively): Document the hi-lock mode.
Eli Zaretskii <eliz@gnu.org>
parents: 29800
diff changeset
1279 effect.
c7e7209535ae (Highlight Interactively): Document the hi-lock mode.
Eli Zaretskii <eliz@gnu.org>
parents: 29800
diff changeset
1280 @end table
c7e7209535ae (Highlight Interactively): Document the hi-lock mode.
Eli Zaretskii <eliz@gnu.org>
parents: 29800
diff changeset
1281
c7e7209535ae (Highlight Interactively): Document the hi-lock mode.
Eli Zaretskii <eliz@gnu.org>
parents: 29800
diff changeset
1282
27224
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
1283 @node Trailing Whitespace
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
1284 @section Trailing Whitespace
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
1285
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
1286 @cindex trailing whitespace
28124
eef598a6a330 (Mouse Avoidance): New section.
Dave Love <fx@gnu.org>
parents: 27224
diff changeset
1287 @cindex whitespace, trailing
27224
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
1288 @vindex show-trailing-whitespace
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
1289 The option @code{show-trailing-whitespace} can be customized so that
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
1290 Emacs displays trailing whitespace in the face
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
1291 @code{trailing-whitespace}. Trailing whitespace is defined as spaces or
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
1292 tabs at the end of a line. To avoid busy highlighting when entering new
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
1293 text, trailing whitespace is not displayed if point is at the end of the
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
1294 line containing the whitespace.
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
1295
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
1296 @node Tooltips
28124
eef598a6a330 (Mouse Avoidance): New section.
Dave Love <fx@gnu.org>
parents: 27224
diff changeset
1297 @section Tooltips (or `Balloon Help')
27224
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
1298
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
1299 @cindex balloon help
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
1300 @findex tooltip-mode
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
1301 Tooltips are small X windows displaying a help string at the current
28432
a232089b2eea Tooltips extra. C-x 5 1.
Dave Love <fx@gnu.org>
parents: 28126
diff changeset
1302 mouse position, typically over text---including the mode line---which
a232089b2eea Tooltips extra. C-x 5 1.
Dave Love <fx@gnu.org>
parents: 28126
diff changeset
1303 can be activated with the mouse or other keys. (This facility is
a232089b2eea Tooltips extra. C-x 5 1.
Dave Love <fx@gnu.org>
parents: 28126
diff changeset
1304 sometimes known as `balloon help'.) Tooltips may be available for menu
a232089b2eea Tooltips extra. C-x 5 1.
Dave Love <fx@gnu.org>
parents: 28126
diff changeset
1305 items too.
a232089b2eea Tooltips extra. C-x 5 1.
Dave Love <fx@gnu.org>
parents: 28126
diff changeset
1306
a232089b2eea Tooltips extra. C-x 5 1.
Dave Love <fx@gnu.org>
parents: 28126
diff changeset
1307 To use tooltips, customize the user option @code{tooltip-mode}. The
a232089b2eea Tooltips extra. C-x 5 1.
Dave Love <fx@gnu.org>
parents: 28126
diff changeset
1308 customization group @code{tooltip} controls various aspects of their
a232089b2eea Tooltips extra. C-x 5 1.
Dave Love <fx@gnu.org>
parents: 28126
diff changeset
1309 display. If Tooltip mode is not activated, the help text is displayed
a232089b2eea Tooltips extra. C-x 5 1.
Dave Love <fx@gnu.org>
parents: 28126
diff changeset
1310 in the echo area instead.
27224
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
1311
28124
eef598a6a330 (Mouse Avoidance): New section.
Dave Love <fx@gnu.org>
parents: 27224
diff changeset
1312 @node Mouse Avoidance
eef598a6a330 (Mouse Avoidance): New section.
Dave Love <fx@gnu.org>
parents: 27224
diff changeset
1313 @section Mouse Avoidance
eef598a6a330 (Mouse Avoidance): New section.
Dave Love <fx@gnu.org>
parents: 27224
diff changeset
1314
eef598a6a330 (Mouse Avoidance): New section.
Dave Love <fx@gnu.org>
parents: 27224
diff changeset
1315 Mouse Avoidance mode keeps the window system mouse pointer away from
eef598a6a330 (Mouse Avoidance): New section.
Dave Love <fx@gnu.org>
parents: 27224
diff changeset
1316 point to avoid obscuring text. Whenever the mouse is moved, the frame
eef598a6a330 (Mouse Avoidance): New section.
Dave Love <fx@gnu.org>
parents: 27224
diff changeset
1317 is also raised. To use it, customize the option
eef598a6a330 (Mouse Avoidance): New section.
Dave Love <fx@gnu.org>
parents: 27224
diff changeset
1318 @code{mouse-avoidance-mode}. You can set this to various values to move
eef598a6a330 (Mouse Avoidance): New section.
Dave Love <fx@gnu.org>
parents: 27224
diff changeset
1319 the mouse in several ways:
eef598a6a330 (Mouse Avoidance): New section.
Dave Love <fx@gnu.org>
parents: 27224
diff changeset
1320
eef598a6a330 (Mouse Avoidance): New section.
Dave Love <fx@gnu.org>
parents: 27224
diff changeset
1321 @table @code
eef598a6a330 (Mouse Avoidance): New section.
Dave Love <fx@gnu.org>
parents: 27224
diff changeset
1322 @item banish
eef598a6a330 (Mouse Avoidance): New section.
Dave Love <fx@gnu.org>
parents: 27224
diff changeset
1323 Move the mouse to the upper-right corner on any keypress;
eef598a6a330 (Mouse Avoidance): New section.
Dave Love <fx@gnu.org>
parents: 27224
diff changeset
1324 @item exile
eef598a6a330 (Mouse Avoidance): New section.
Dave Love <fx@gnu.org>
parents: 27224
diff changeset
1325 Move the mouse to the corner only if the cursor gets too close,
eef598a6a330 (Mouse Avoidance): New section.
Dave Love <fx@gnu.org>
parents: 27224
diff changeset
1326 and allow it to return once the cursor is out of the way;
eef598a6a330 (Mouse Avoidance): New section.
Dave Love <fx@gnu.org>
parents: 27224
diff changeset
1327 @item jump
eef598a6a330 (Mouse Avoidance): New section.
Dave Love <fx@gnu.org>
parents: 27224
diff changeset
1328 If the cursor gets too close to the mouse, displace the mouse
eef598a6a330 (Mouse Avoidance): New section.
Dave Love <fx@gnu.org>
parents: 27224
diff changeset
1329 a random distance & direction;
eef598a6a330 (Mouse Avoidance): New section.
Dave Love <fx@gnu.org>
parents: 27224
diff changeset
1330 @item animate
eef598a6a330 (Mouse Avoidance): New section.
Dave Love <fx@gnu.org>
parents: 27224
diff changeset
1331 As @code{jump}, but shows steps along the way for illusion of motion;
eef598a6a330 (Mouse Avoidance): New section.
Dave Love <fx@gnu.org>
parents: 27224
diff changeset
1332 @item cat-and-mouse
eef598a6a330 (Mouse Avoidance): New section.
Dave Love <fx@gnu.org>
parents: 27224
diff changeset
1333 The same as @code{animate};
eef598a6a330 (Mouse Avoidance): New section.
Dave Love <fx@gnu.org>
parents: 27224
diff changeset
1334 @item proteus
eef598a6a330 (Mouse Avoidance): New section.
Dave Love <fx@gnu.org>
parents: 27224
diff changeset
1335 As @code{animate}, but changes the shape of the mouse pointer too.
eef598a6a330 (Mouse Avoidance): New section.
Dave Love <fx@gnu.org>
parents: 27224
diff changeset
1336 @end table
eef598a6a330 (Mouse Avoidance): New section.
Dave Love <fx@gnu.org>
parents: 27224
diff changeset
1337
eef598a6a330 (Mouse Avoidance): New section.
Dave Love <fx@gnu.org>
parents: 27224
diff changeset
1338 You can also use the command @kbd{M-x mouse-avoidance-mode} to turn on
eef598a6a330 (Mouse Avoidance): New section.
Dave Love <fx@gnu.org>
parents: 27224
diff changeset
1339 the mode.
27224
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
1340
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1341 @node Misc X
Dave Love <fx@gnu.org>
parents:
diff changeset
1342 @section Miscellaneous X Window Features
Dave Love <fx@gnu.org>
parents:
diff changeset
1343
Dave Love <fx@gnu.org>
parents:
diff changeset
1344 The following commands let you create, delete and operate on frames:
Dave Love <fx@gnu.org>
parents:
diff changeset
1345
Dave Love <fx@gnu.org>
parents:
diff changeset
1346 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
1347 @item C-z
Dave Love <fx@gnu.org>
parents:
diff changeset
1348 @kindex C-z @r{(X windows)}
Dave Love <fx@gnu.org>
parents:
diff changeset
1349 @findex iconify-or-deiconify-frame
Dave Love <fx@gnu.org>
parents:
diff changeset
1350 Iconify the selected Emacs frame (@code{iconify-or-deiconify-frame}).
Dave Love <fx@gnu.org>
parents:
diff changeset
1351 The normal meaning of @kbd{C-z}, to suspend Emacs, is not useful under a
Dave Love <fx@gnu.org>
parents:
diff changeset
1352 window system, so it has a different binding in that case.
Dave Love <fx@gnu.org>
parents:
diff changeset
1353
Dave Love <fx@gnu.org>
parents:
diff changeset
1354 If you type this command on an Emacs frame's icon, it deiconifies the frame.
Dave Love <fx@gnu.org>
parents:
diff changeset
1355
Dave Love <fx@gnu.org>
parents:
diff changeset
1356 @item C-x 5 0
Dave Love <fx@gnu.org>
parents:
diff changeset
1357 @kindex C-x 5 0
Dave Love <fx@gnu.org>
parents:
diff changeset
1358 @findex delete-frame
Dave Love <fx@gnu.org>
parents:
diff changeset
1359 Delete the selected frame (@code{delete-frame}). This is not allowed if
Dave Love <fx@gnu.org>
parents:
diff changeset
1360 there is only one frame.
Dave Love <fx@gnu.org>
parents:
diff changeset
1361
Dave Love <fx@gnu.org>
parents:
diff changeset
1362 @item C-x 5 o
Dave Love <fx@gnu.org>
parents:
diff changeset
1363 @kindex C-x 5 o
Dave Love <fx@gnu.org>
parents:
diff changeset
1364 @findex other-frame
Dave Love <fx@gnu.org>
parents:
diff changeset
1365 Select another frame, raise it, and warp the mouse to it so that it
Dave Love <fx@gnu.org>
parents:
diff changeset
1366 stays selected. If you repeat this command, it cycles through all the
Dave Love <fx@gnu.org>
parents:
diff changeset
1367 frames on your terminal.
28432
a232089b2eea Tooltips extra. C-x 5 1.
Dave Love <fx@gnu.org>
parents: 28126
diff changeset
1368
a232089b2eea Tooltips extra. C-x 5 1.
Dave Love <fx@gnu.org>
parents: 28126
diff changeset
1369 @item C-x 5 1
a232089b2eea Tooltips extra. C-x 5 1.
Dave Love <fx@gnu.org>
parents: 28126
diff changeset
1370 @kindex C-x 5 1
a232089b2eea Tooltips extra. C-x 5 1.
Dave Love <fx@gnu.org>
parents: 28126
diff changeset
1371 @findex delete-other-frames
a232089b2eea Tooltips extra. C-x 5 1.
Dave Love <fx@gnu.org>
parents: 28126
diff changeset
1372 Delete all frames except the selected one.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1373 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
1374
31039
d0bdb413e900 Document the busy-cursor feature.
Eli Zaretskii <eliz@gnu.org>
parents: 30984
diff changeset
1375 @cindex busy-cursor display
d0bdb413e900 Document the busy-cursor feature.
Eli Zaretskii <eliz@gnu.org>
parents: 30984
diff changeset
1376 @vindex busy-cursor-delay
d0bdb413e900 Document the busy-cursor feature.
Eli Zaretskii <eliz@gnu.org>
parents: 30984
diff changeset
1377 Emacs can optionally display a busy cursor on X and other window
d0bdb413e900 Document the busy-cursor feature.
Eli Zaretskii <eliz@gnu.org>
parents: 30984
diff changeset
1378 systems. To turn this on or off, customize the group @code{cursor}.
d0bdb413e900 Document the busy-cursor feature.
Eli Zaretskii <eliz@gnu.org>
parents: 30984
diff changeset
1379 You can also control the amount of time Emacs is busy before the
d0bdb413e900 Document the busy-cursor feature.
Eli Zaretskii <eliz@gnu.org>
parents: 30984
diff changeset
1380 busy-cursor is displayed, by customizing the value of the variable
d0bdb413e900 Document the busy-cursor feature.
Eli Zaretskii <eliz@gnu.org>
parents: 30984
diff changeset
1381 @code{busy-cursor-delay}.
d0bdb413e900 Document the busy-cursor feature.
Eli Zaretskii <eliz@gnu.org>
parents: 30984
diff changeset
1382
31044
13ccb42ca18c Document the x-stretch-cursor variable.
Eli Zaretskii <eliz@gnu.org>
parents: 31039
diff changeset
1383 @vindex x-stretch-cursor
13ccb42ca18c Document the x-stretch-cursor variable.
Eli Zaretskii <eliz@gnu.org>
parents: 31039
diff changeset
1384 @cindex wide block cursor
13ccb42ca18c Document the x-stretch-cursor variable.
Eli Zaretskii <eliz@gnu.org>
parents: 31039
diff changeset
1385 Emacs on X can draw the block cursor as wide as the glyph under the
13ccb42ca18c Document the x-stretch-cursor variable.
Eli Zaretskii <eliz@gnu.org>
parents: 31039
diff changeset
1386 cursor. For example, if the cursor is on a TAB character, it is drawn
13ccb42ca18c Document the x-stretch-cursor variable.
Eli Zaretskii <eliz@gnu.org>
parents: 31039
diff changeset
1387 as wide as that TAB is on the display. To turn on this feature, set the
13ccb42ca18c Document the x-stretch-cursor variable.
Eli Zaretskii <eliz@gnu.org>
parents: 31039
diff changeset
1388 variable @code{x-stretch-cursor} to a non-nil value.
13ccb42ca18c Document the x-stretch-cursor variable.
Eli Zaretskii <eliz@gnu.org>
parents: 31039
diff changeset
1389
31046
304299758ed5 Document the indicate-empty-lines variable.
Eli Zaretskii <eliz@gnu.org>
parents: 31044
diff changeset
1390 @vindex indicate-empty-lines
304299758ed5 Document the indicate-empty-lines variable.
Eli Zaretskii <eliz@gnu.org>
parents: 31044
diff changeset
1391 @vindex default-indicate-empty-lines
304299758ed5 Document the indicate-empty-lines variable.
Eli Zaretskii <eliz@gnu.org>
parents: 31044
diff changeset
1392 @cindex empty lines
304299758ed5 Document the indicate-empty-lines variable.
Eli Zaretskii <eliz@gnu.org>
parents: 31044
diff changeset
1393 Empty display lines at the end of the buffer can be optionally marked
31187
ffe1a73989c5 Another typo.
Eli Zaretskii <eliz@gnu.org>
parents: 31186
diff changeset
1394 with a special bitmap on the left fringe of the window. This is
31046
304299758ed5 Document the indicate-empty-lines variable.
Eli Zaretskii <eliz@gnu.org>
parents: 31044
diff changeset
1395 activated by setting the buffer-local variable
304299758ed5 Document the indicate-empty-lines variable.
Eli Zaretskii <eliz@gnu.org>
parents: 31044
diff changeset
1396 @code{indicate-empty-lines} to a non-nil value. The default value of
304299758ed5 Document the indicate-empty-lines variable.
Eli Zaretskii <eliz@gnu.org>
parents: 31044
diff changeset
1397 this variable is found in @code{default-indicate-empty-lines}.
304299758ed5 Document the indicate-empty-lines variable.
Eli Zaretskii <eliz@gnu.org>
parents: 31044
diff changeset
1398
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1399 @node Non-Window Terminals
Dave Love <fx@gnu.org>
parents:
diff changeset
1400 @section Non-Window Terminals
Dave Love <fx@gnu.org>
parents:
diff changeset
1401 @cindex non-window terminals
Dave Love <fx@gnu.org>
parents:
diff changeset
1402 @cindex single-frame terminals
Dave Love <fx@gnu.org>
parents:
diff changeset
1403
Dave Love <fx@gnu.org>
parents:
diff changeset
1404 If your terminal does not have a window system that Emacs supports,
Dave Love <fx@gnu.org>
parents:
diff changeset
1405 then it can display only one Emacs frame at a time. However, you can
Dave Love <fx@gnu.org>
parents:
diff changeset
1406 still create multiple Emacs frames, and switch between them. Switching
Dave Love <fx@gnu.org>
parents:
diff changeset
1407 frames on these terminals is much like switching between different
Dave Love <fx@gnu.org>
parents:
diff changeset
1408 window configurations.
Dave Love <fx@gnu.org>
parents:
diff changeset
1409
Dave Love <fx@gnu.org>
parents:
diff changeset
1410 Use @kbd{C-x 5 2} to create a new frame and switch to it; use @kbd{C-x
Dave Love <fx@gnu.org>
parents:
diff changeset
1411 5 o} to cycle through the existing frames; use @kbd{C-x 5 0} to delete
Dave Love <fx@gnu.org>
parents:
diff changeset
1412 the current frame.
Dave Love <fx@gnu.org>
parents:
diff changeset
1413
Dave Love <fx@gnu.org>
parents:
diff changeset
1414 Each frame has a number to distinguish it. If your terminal can
Dave Love <fx@gnu.org>
parents:
diff changeset
1415 display only one frame at a time, the selected frame's number @var{n}
Dave Love <fx@gnu.org>
parents:
diff changeset
1416 appears near the beginning of the mode line, in the form
Dave Love <fx@gnu.org>
parents:
diff changeset
1417 @samp{F@var{n}}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1418
Dave Love <fx@gnu.org>
parents:
diff changeset
1419 @findex set-frame-name
Dave Love <fx@gnu.org>
parents:
diff changeset
1420 @findex select-frame-by-name
Dave Love <fx@gnu.org>
parents:
diff changeset
1421 @samp{F@var{n}} is actually the frame's name. You can also specify a
Dave Love <fx@gnu.org>
parents:
diff changeset
1422 different name if you wish, and you can select a frame by its name. Use
Dave Love <fx@gnu.org>
parents:
diff changeset
1423 the command @kbd{M-x set-frame-name @key{RET} @var{name} @key{RET}} to
Dave Love <fx@gnu.org>
parents:
diff changeset
1424 specify a new name for the selected frame, and use @kbd{M-x
Dave Love <fx@gnu.org>
parents:
diff changeset
1425 select-frame-by-name @key{RET} @var{name} @key{RET}} to select a frame
Dave Love <fx@gnu.org>
parents:
diff changeset
1426 according to its name. The name you specify appears in the mode line
Dave Love <fx@gnu.org>
parents:
diff changeset
1427 when the frame is selected.
Dave Love <fx@gnu.org>
parents:
diff changeset
1428
27224
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
1429 @node XTerm Mouse
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
1430 @section Using a Mouse in Terminal Emulators
28124
eef598a6a330 (Mouse Avoidance): New section.
Dave Love <fx@gnu.org>
parents: 27224
diff changeset
1431 @cindex xterm, mouse support
eef598a6a330 (Mouse Avoidance): New section.
Dave Love <fx@gnu.org>
parents: 27224
diff changeset
1432 @cindex terminal emulators, mouse support
27224
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
1433
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
1434 Some terminal emulators under X support mouse clicks in the terminal
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
1435 window. In a terminal emulator which is compatible with @code{xterm},
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
1436 you can use @kbd{M-x xterm-mouse-mode} to enable simple use of the
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
1437 mouse---only single clicks are supported. The normal @code{xterm} mouse
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
1438 functionality is still available by holding down the @kbd{SHIFT} key
d9c8c29ec5c4 Features may work other than under X.
Dave Love <fx@gnu.org>
parents: 25829
diff changeset
1439 when you press the mouse button.