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