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