(char_property_eq): Put in #if 0.
[emacs.git] / man / frames.texi
blobbd49e582316ded0598049bd343627f684bd99129
1 @c This is part of the Emacs manual.
2 @c Copyright (C) 1985, 86, 87, 93, 94, 95, 97, 99, 2000, 2001
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} (that is zero, not @kbd{o}).
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.  However, images, tool bars, and tooltips are not yet
35 available in Emacs version 21.1 on MS-Windows.
37 @menu
38 * Mouse Commands::      Moving, cutting, and pasting, with the mouse.
39 * Secondary Selection:: Cutting without altering point and mark.
40 * Clipboard::           Using the clipboard for selections.
41 * Mouse References::    Using the mouse to select an item from a list.
42 * Menu Mouse Clicks::   Mouse clicks that bring up menus.
43 * Mode Line Mouse::     Mouse clicks on the mode line.
44 * Creating Frames::     Creating additional Emacs frames with various contents.
45 * Frame Commands::      Iconifying, deleting, and switching frames.
46 * Speedbar::            How to make and use a speedbar frame.
47 * Multiple Displays::   How one Emacs job can talk to several displays.
48 * Special Buffer Frames::  You can make certain buffers have their own frames.
49 * Frame Parameters::    Changing the colors and other modes of frames.
50 * Scroll Bars::         How to enable and disable scroll bars; how to use them.
51 * Wheeled Mice::        Using mouse wheels for scrolling.
52 * Menu Bars::           Enabling and disabling the menu bar.
53 * Tool Bars::           Enabling and disabling the tool bar.
54 * Dialog Boxes::        Controlling use of dialog boxes.
55 * Tooltips::            Showing "tooltips", AKA "ballon help" for active text.
56 * Mouse Avoidance::     Moving the mouse pointer out of the way.
57 * Non-Window Terminals::  Multiple frames on terminals that show only one.
58 * XTerm Mouse::         Using the mouse in an XTerm terminal emulator.
59 @end menu
61 @node Mouse Commands
62 @section Mouse Commands for Editing
63 @cindex mouse buttons (what they do)
65   The mouse commands for selecting and copying a region are mostly
66 compatible with the @code{xterm} program.  You can use the same mouse
67 commands for copying between Emacs and other X client programs.
69 @kindex DELETE @r{(and mouse selection)}
70   If you select a region with any of these mouse commands, and then
71 immediately afterward type the @key{DELETE} function key, it deletes the
72 region that you selected.  The @key{BACKSPACE} function key and the
73 ASCII character @key{DEL} do not do this; if you type any other key
74 in between the mouse command and @key{DELETE}, it does not do this.
76 @findex mouse-set-region
77 @findex mouse-set-point
78 @findex mouse-yank-at-click
79 @findex mouse-save-then-click
80 @kindex Mouse-1
81 @kindex Mouse-2
82 @kindex Mouse-3
83 @table @kbd
84 @item Mouse-1
85 Move point to where you click (@code{mouse-set-point}).
86 This is normally the left button.
88 @item Drag-Mouse-1
89 Set the region to the text you select by dragging, and copy it to the
90 kill ring (@code{mouse-set-region}).  You can specify both ends of the
91 region with this single command.
93 @vindex mouse-scroll-min-lines
94 If you move the mouse off the top or bottom of the window while
95 dragging, the window scrolls at a steady rate until you move the mouse
96 back into the window.  This way, you can select regions that don't fit
97 entirely on the screen.  The number of lines scrolled per step depends
98 on how far away from the window edge the mouse has gone; the variable
99 @code{mouse-scroll-min-lines} specifies a minimum step size.
101 @item Mouse-2
102 Yank the last killed text, where you click (@code{mouse-yank-at-click}).
103 This is normally the middle button.
105 @item Mouse-3
106 This command, @code{mouse-save-then-kill}, has several functions
107 depending on where you click and the status of the region.
109 The most basic case is when you click @kbd{Mouse-1} in one place and
110 then @kbd{Mouse-3} in another.  This selects the text between those two
111 positions as the region.  It also copies the new region to the kill
112 ring, so that you can copy it to someplace else.
114 If you click @kbd{Mouse-1} in the text, scroll with the scroll bar, and
115 then click @kbd{Mouse-3}, it remembers where point was before scrolling
116 (where you put it with @kbd{Mouse-1}), and uses that position as the
117 other end of the region.  This is so that you can select a region that
118 doesn't fit entirely on the screen.
120 More generally, if you do not have a highlighted region, @kbd{Mouse-3}
121 selects the text between point and the click position as the region.  It
122 does this by setting the mark where point was, and moving point to where
123 you click.
125 If you have a highlighted region, or if the region was set just before
126 by dragging button 1, @kbd{Mouse-3} adjusts the nearer end of the region
127 by moving it to where you click.  The adjusted region's text also
128 replaces the old region's text in the kill ring.
130 If you originally specified the region using a double or triple
131 @kbd{Mouse-1}, so that the region is defined to consist of entire words
132 or lines, then adjusting the region with @kbd{Mouse-3} also proceeds by
133 entire words or lines.
135 If you use @kbd{Mouse-3} a second time consecutively, at the same place,
136 that kills the region already selected.
138 @item Double-Mouse-1
139 This key sets the region around the word which you click on.  If you
140 click on a character with ``symbol'' syntax (such as underscore, in C
141 mode), it sets the region around the symbol surrounding that character.
143 If you click on a character with open-parenthesis or close-parenthesis
144 syntax, it sets the region around the parenthetical grouping (sexp)
145 which that character starts or ends.  If you click on a character with
146 string-delimiter syntax (such as a singlequote or doublequote in C), it
147 sets the region around the string constant (using heuristics to figure
148 out whether that character is the beginning or the end of it).
150 @item Double-Drag-Mouse-1
151 This key selects a region made up of the words you drag across.
153 @item Triple-Mouse-1
154 This key sets the region around the line you click on.
156 @item Triple-Drag-Mouse-1
157 This key selects a region made up of the lines you drag across.
158 @end table
160   The simplest way to kill text with the mouse is to press @kbd{Mouse-1}
161 at one end, then press @kbd{Mouse-3} twice at the other end.
162 @xref{Killing}.  To copy the text into the kill ring without deleting it
163 from the buffer, press @kbd{Mouse-3} just once---or just drag across the
164 text with @kbd{Mouse-1}.  Then you can copy it elsewhere by yanking it.
166 @vindex mouse-yank-at-point
167   To yank the killed or copied text somewhere else, move the mouse there
168 and press @kbd{Mouse-2}.  @xref{Yanking}.  However, if
169 @code{mouse-yank-at-point} is non-@code{nil}, @kbd{Mouse-2} yanks at
170 point.  Then it does not matter where you click, or even which of the
171 frame's windows you click on.  The default value is @code{nil}.  This
172 variable also affects yanking the secondary selection.
174 @cindex cutting and X
175 @cindex pasting and X
176 @cindex X cutting and pasting
177   To copy text to another X window, kill it or save it in the kill ring.
178 Under X, this also sets the @dfn{primary selection}.  Then use the
179 ``paste'' or ``yank'' command of the program operating the other window
180 to insert the text from the selection.
182   To copy text from another X window, use the ``cut'' or ``copy''
183 command of the program operating the other window, to select the text
184 you want.  Then yank it in Emacs with @kbd{C-y} or @kbd{Mouse-2}.
186   The standard coding system for X selections is @code{compound-text}.
187 To specify another coding system for X selections, use @kbd{C-x
188 @key{RET} x} or @kbd{C-x @key{RET} X}.  @xref{Specify Coding}.
190   These cutting and pasting commands also work on MS-Windows.
192 @cindex primary selection
193 @cindex cut buffer
194 @cindex selection, primary
195 @vindex x-cut-buffer-max
196   When Emacs puts text into the kill ring, or rotates text to the front
197 of the kill ring, it sets the @dfn{primary selection} in the X server.
198 This is how other X clients can access the text.  Emacs also stores the
199 text in the cut buffer, but only if the text is short enough
200 (the value of @code{x-cut-buffer-max} specifies the maximum number of
201 characters); putting long strings in the cut buffer can be slow.
203   The commands to yank the first entry in the kill ring actually check
204 first for a primary selection in another program; after that, they check
205 for text in the cut buffer.  If neither of those sources provides text
206 to yank, the kill ring contents are used.
208 @node Secondary Selection
209 @section Secondary Selection
210 @cindex secondary selection
212   The @dfn{secondary selection} is another way of selecting text using
213 X.  It does not use point or the mark, so you can use it to kill text
214 without setting point or the mark.
216 @table @kbd
217 @findex mouse-set-secondary
218 @kindex M-Drag-Mouse-1
219 @item M-Drag-Mouse-1
220 Set the secondary selection, with one end at the place where you press
221 down the button, and the other end at the place where you release it
222 (@code{mouse-set-secondary}).  The highlighting appears and changes as
223 you drag.  You can control the appearance of the highlighting by
224 customizing the @code{secondary-selection} face (@pxref{Face
225 Customization}).
227 If you move the mouse off the top or bottom of the window while
228 dragging, the window scrolls at a steady rate until you move the mouse
229 back into the window.  This way, you can mark regions that don't fit
230 entirely on the screen.
232 @findex mouse-start-secondary
233 @kindex M-Mouse-1
234 @item M-Mouse-1
235 Set one endpoint for the @dfn{secondary selection}
236 (@code{mouse-start-secondary}).
238 @findex mouse-secondary-save-then-kill
239 @kindex M-Mouse-3
240 @item M-Mouse-3
241 Make a secondary selection, using the place specified with @kbd{M-Mouse-1}
242 as the other end (@code{mouse-secondary-save-then-kill}).  A second click
243 at the same place kills the secondary selection just made.
245 @findex mouse-yank-secondary
246 @kindex M-Mouse-2
247 @item M-Mouse-2
248 Insert the secondary selection where you click
249 (@code{mouse-yank-secondary}).  This places point at the end of the
250 yanked text.
251 @end table
253 Double or triple clicking of @kbd{M-Mouse-1} operates on words and
254 lines, much like @kbd{Mouse-1}.
256 If @code{mouse-yank-at-point} is non-@code{nil}, @kbd{M-Mouse-2}
257 yanks at point.  Then it does not matter precisely where you click; all
258 that matters is which window you click on.  @xref{Mouse Commands}.
260 @node Clipboard
261 @section Using the Clipboard
262 @cindex X clipboard
263 @cindex clipboard
264 @vindex x-select-enable-clipboard
265 @findex menu-bar-enable-clipboard
266 @cindex OpenWindows
267 @cindex Gnome
269   As well as the primary and secondary selection types, X supports a
270 @dfn{clipboard} selection type which is used by some applications,
271 particularly under OpenWindows and Gnome.
273   The command @kbd{M-x menu-bar-enable-clipboard} makes the @code{Cut},
274 @code{Paste} and @code{Copy} menu items, as well as the keys of the same
275 names, all use the clipboard.
277   You can customize the option @code{x-select-enable-clipboard} to make
278 the Emacs yank functions consult the clipboard before the primary
279 selection, and to make the kill functions to store in the clipboard as
280 well as the primary selection.  Otherwise they do not access the
281 clipboard at all.  Using the clipboard is the default on MS-Windows,
282 unlike most systems.
284 @node Mouse References
285 @section Following References with the Mouse
286 @kindex Mouse-2 @r{(selection)}
288   Some Emacs buffers display lists of various sorts.  These include
289 lists of files, of buffers, of possible completions, of matches for
290 a pattern, and so on.
292   Since yanking text into these buffers is not very useful, most of them
293 define @kbd{Mouse-2} specially, as a command to use or view the item you
294 click on.
296   For example, if you click @kbd{Mouse-2} on a file name in a Dired
297 buffer, you visit that file.  If you click @kbd{Mouse-2} on an error
298 message in the @samp{*Compilation*} buffer, you go to the source code
299 for that error message.  If you click @kbd{Mouse-2} on a completion in
300 the @samp{*Completions*} buffer, you choose that completion.
302   You can usually tell when @kbd{Mouse-2} has this special sort of
303 meaning because the sensitive text highlights when you move the mouse
304 over it.
306 @node Menu Mouse Clicks
307 @section Mouse Clicks for Menus
309   Mouse clicks modified with the @key{CTRL} and @key{SHIFT} keys
310 bring up menus.
312 @table @kbd
313 @item C-Mouse-1
314 @kindex C-Mouse-1
315 This menu is for selecting a buffer.
317 The MSB (``mouse select buffer'') global minor mode makes this
318 menu smarter and more customizable.  @xref{Buffer Menus}.
320 @item C-Mouse-2
321 @kindex C-Mouse-2
322 This menu is for specifying faces and other text properties
323 for editing formatted text.  @xref{Formatted Text}.
325 @item C-Mouse-3
326 @kindex C-Mouse-3
327 This menu is mode-specific.  For most modes if Menu-bar mode is on, this
328 menu has the same items as all the mode-specific menu-bar menus put
329 together.  Some modes may specify a different menu for this
330 button.@footnote{Some systems use @kbd{Mouse-3} for a mode-specific
331 menu.  We took a survey of users, and found they preferred to keep
332 @kbd{Mouse-3} for selecting and killing regions.  Hence the decision to
333 use @kbd{C-Mouse-3} for this menu.}  If Menu-bar mode is off, this menu
334 contains all the items which would be present in the menu bar---not just
335 the mode-specific ones---so that you can access them without having to
336 display the menu bar.
338 @item S-Mouse-1
339 This menu is for specifying the frame's principal font.
340 @end table
342 @node Mode Line Mouse
343 @section Mode Line Mouse Commands
344 @cindex mode line, mouse
345 @cindex mouse on mode line
347   You can use mouse clicks on window mode lines to select and manipulate
348 windows.
350 @table @kbd
351 @item Mouse-1
352 @kindex Mouse-1 @r{(mode line)}
353 @kbd{Mouse-1} on a mode line selects the window above.  By dragging
354 @kbd{Mouse-1} on the mode line, you can move it, thus changing the
355 height of the windows above and below.
357 @item Mouse-2
358 @kindex Mouse-2 @r{(mode line)}
359 @kbd{Mouse-2} on a mode line expands that window to fill its frame.
361 @item Mouse-3
362 @kindex Mouse-3 @r{(mode line)}
363 @kbd{Mouse-3} on a mode line deletes the window above.  If the frame has
364 only one window, it buries the current buffer instead and switches to
365 another buffer.
367 @item C-Mouse-2
368 @kindex C-mouse-2 @r{(mode line)}
369 @kbd{C-Mouse-2} on a mode line splits the window above
370 horizontally, above the place in the mode line where you click.
371 @end table
373 @kindex C-Mouse-2 @r{(scroll bar)}
374   @kbd{C-Mouse-2} on a scroll bar splits the corresponding window
375 vertically, unless you are using an X toolkit's implementation of
376 scroll bars.  @xref{Split Window}.
378   The commands above apply to areas of the mode line which do not have
379 special mouse bindings of their own.  Some areas, such as the buffer
380 name and the major mode name, have their own special mouse bindings.
381 Emacs displays information about these bindings when you hold the
382 mouse over such a place (@pxref{Tooltips}).
384 @node Creating Frames
385 @section Creating Frames
386 @cindex creating frames
388 @kindex C-x 5
389   The prefix key @kbd{C-x 5} is analogous to @kbd{C-x 4}, with parallel
390 subcommands.  The difference is that @kbd{C-x 5} commands create a new
391 frame rather than just a new window in the selected frame (@pxref{Pop
392 Up Window}).  If an existing visible or iconified frame already displays
393 the requested material, these commands use the existing frame, after
394 raising or deiconifying as necessary. 
396   The various @kbd{C-x 5} commands differ in how they find or create the
397 buffer to select:
399 @table @kbd
400 @item C-x 5 2
401 @kindex C-x 5 2
402 @findex make-frame-command
403 Create a new frame (@code{make-frame-command}).
404 @item C-x 5 b @var{bufname} @key{RET}
405 Select buffer @var{bufname} in another frame.  This runs
406 @code{switch-to-buffer-other-frame}.
407 @item C-x 5 f @var{filename} @key{RET}
408 Visit file @var{filename} and select its buffer in another frame.  This
409 runs @code{find-file-other-frame}.  @xref{Visiting}.
410 @item C-x 5 d @var{directory} @key{RET}
411 Select a Dired buffer for directory @var{directory} in another frame.
412 This runs @code{dired-other-frame}.  @xref{Dired}.
413 @item C-x 5 m
414 Start composing a mail message in another frame.  This runs
415 @code{mail-other-frame}.  It is the other-frame variant of @kbd{C-x m}.
416 @xref{Sending Mail}.
417 @item C-x 5 .
418 Find a tag in the current tag table in another frame.  This runs
419 @code{find-tag-other-frame}, the multiple-frame variant of @kbd{M-.}.
420 @xref{Tags}.
421 @item C-x 5 r @var{filename} @key{RET}
422 @kindex C-x 5 r
423 @findex find-file-read-only-other-frame
424 Visit file @var{filename} read-only, and select its buffer in another
425 frame.  This runs @code{find-file-read-only-other-frame}.
426 @xref{Visiting}.
427 @end table
429 @cindex default-frame-alist
430 @cindex initial-frame-alist
431   You can control the appearance of new frames you create by setting the
432 frame parameters in @code{default-frame-alist}.  You can use the
433 variable @code{initial-frame-alist} to specify parameters that affect
434 only the initial frame.  @xref{Initial Parameters,,, elisp, The Emacs
435 Lisp Reference Manual}, for more information.
437 @cindex font (default)
438   The easiest way to specify the principal font for all your Emacs
439 frames is with an X resource (@pxref{Font X}), but you can also do it by
440 modifying @code{default-frame-alist} to specify the @code{font}
441 parameter, as shown here:
443 @example
444 (add-to-list 'default-frame-alist '(font . "10x20"))
445 @end example
447 @node Frame Commands
448 @section Frame Commands
450   The following commands let you create, delete and operate on frames:
452 @table @kbd
453 @item C-z
454 @kindex C-z @r{(X windows)}
455 @findex iconify-or-deiconify-frame
456 Iconify the selected Emacs frame (@code{iconify-or-deiconify-frame}).
457 The normal meaning of @kbd{C-z}, to suspend Emacs, is not useful under a
458 window system, so it has a different binding in that case.
460 If you type this command on an Emacs frame's icon, it deiconifies the frame.
462 @item C-x 5 0
463 @kindex C-x 5 0
464 @findex delete-frame
465 Delete the selected frame (@code{delete-frame}).  This is not allowed if
466 there is only one frame.
468 @item C-x 5 o
469 @kindex C-x 5 o
470 @findex other-frame
471 Select another frame, raise it, and warp the mouse to it so that it
472 stays selected.  If you repeat this command, it cycles through all the
473 frames on your terminal.
475 @item C-x 5 1
476 @kindex C-x 5 1
477 @findex delete-other-frames
478 Delete all frames except the selected one.
479 @end table
481 @node Speedbar
482 @section Making and Using a Speedbar Frame
483 @cindex speedbar
485   An Emacs frame can have a @dfn{speedbar}, which is a vertical window
486 that serves as a scrollable menu of files you could visit and tags
487 within those files.  To create a speedbar, type @kbd{M-x speedbar}; this
488 creates a speedbar window for the selected frame.  From then on, you can
489 click on a file name in the speedbar to visit that file in the
490 corresponding Emacs frame, or click on a tag name to jump to that tag in
491 the Emacs frame.
493   Initially the speedbar lists the immediate contents of the current
494 directory, one file per line.  Each line also has a box, @samp{[+]} or
495 @samp{<+>}, that you can click on with @kbd{Mouse-2} to ``open up'' the
496 contents of that item.  If the line names a directory, opening it adds
497 the contents of that directory to the speedbar display, underneath the
498 directory's own line.  If the line lists an ordinary file, opening it up
499 adds a list of the tags in that file to the speedbar display.  When a
500 file is opened up, the @samp{[+]} changes to @samp{[-]}; you can click
501 on that box to ``close up'' that file (hide its contents).
503   Some major modes, including Rmail mode, Info, and GUD, have
504 specialized ways of putting useful items into the speedbar for you to
505 select.  For example, in Rmail mode, the speedbar shows a list of Rmail
506 files, and lets you move the current message to another Rmail file by
507 clicking on its @samp{<M>} box.
509   A speedbar belongs to one Emacs frame, and always operates on that
510 frame.  If you use multiple frames, you can make a speedbar for some or
511 all of the frames; type @kbd{M-x speedbar} in any given frame to make a
512 speedbar for it.
514 @node Multiple Displays
515 @section Multiple Displays
516 @cindex multiple displays
518   A single Emacs can talk to more than one X display.  Initially, Emacs
519 uses just one display---the one specified with the @env{DISPLAY}
520 environment variable or with the @samp{--display} option (@pxref{Initial
521 Options}).  To connect to another display, use the command
522 @code{make-frame-on-display}:
524 @findex make-frame-on-display
525 @table @kbd
526 @item M-x make-frame-on-display @key{RET} @var{display} @key{RET}
527 Create a new frame on display @var{display}.
528 @end table
530   A single X server can handle more than one screen.  When you open
531 frames on two screens belonging to one server, Emacs knows they share a
532 single keyboard, and it treats all the commands arriving from these
533 screens as a single stream of input.
535   When you open frames on different X servers, Emacs makes a separate
536 input stream for each server.  This way, two users can type
537 simultaneously on the two displays, and Emacs will not garble their
538 input.  Each server also has its own selected frame.  The commands you
539 enter with a particular X server apply to that server's selected frame.
541   Despite these features, people using the same Emacs job from different
542 displays can still interfere with each other if they are not careful.
543 For example, if any one types @kbd{C-x C-c}, that exits the Emacs job
544 for all of them!
546 @node Special Buffer Frames
547 @section Special Buffer Frames
549 @vindex special-display-buffer-names
550   You can make certain chosen buffers, for which Emacs normally creates
551 a second window when you have just one window, appear in special frames
552 of their own.  To do this, set the variable
553 @code{special-display-buffer-names} to a list of buffer names; any
554 buffer whose name is in that list automatically gets a special frame,
555 when an Emacs command wants to display it ``in another window.''
557   For example, if you set the variable this way,
559 @example
560 (setq special-display-buffer-names
561       '("*Completions*" "*grep*" "*tex-shell*"))
562 @end example
564 @noindent
565 then completion lists, @code{grep} output and the @TeX{} mode shell
566 buffer get individual frames of their own.  These frames, and the
567 windows in them, are never automatically split or reused for any other
568 buffers.  They continue to show the buffers they were created for,
569 unless you alter them by hand.  Killing the special buffer deletes its
570 frame automatically.
572 @vindex special-display-regexps
573   More generally, you can set @code{special-display-regexps} to a list
574 of regular expressions; then a buffer gets its own frame if its name
575 matches any of those regular expressions.  (Once again, this applies only
576 to buffers that normally get displayed for you in a separate window.)
578 @vindex special-display-frame-alist
579   The variable @code{special-display-frame-alist} specifies the frame
580 parameters for these frames.  It has a default value, so you don't need
581 to set it.
583   For those who know Lisp, an element of
584 @code{special-display-buffer-names} or @code{special-display-regexps}
585 can also be a list.  Then the first element is the buffer name or
586 regular expression; the rest of the list specifies how to create the
587 frame.  It can be an association list specifying frame parameter values;
588 these values take precedence over parameter values specified in
589 @code{special-display-frame-alist}.  Alternatively, it can have this
590 form:
592 @example
593 (@var{function} @var{args}...)
594 @end example
596 @noindent
597 where @var{function} is a symbol.  Then the frame is constructed by
598 calling @var{function}; its first argument is the buffer, and its
599 remaining arguments are @var{args}.
601    An analogous feature lets you specify buffers which should be
602 displayed in the selected window.  @xref{Force Same Window}.  The
603 same-window feature takes precedence over the special-frame feature;
604 therefore, if you add a buffer name to
605 @code{special-display-buffer-names} and it has no effect, check to see
606 whether that feature is also in use for the same buffer name.
608 @node Frame Parameters
609 @section Setting Frame Parameters
610 @cindex colors
611 @cindex Auto-Raise mode
612 @cindex Auto-Lower mode
614   This section describes commands for altering the display style and
615 window management behavior of the selected frame.
617 @findex set-foreground-color
618 @findex set-background-color
619 @findex set-cursor-color
620 @findex set-mouse-color
621 @findex set-border-color
622 @findex auto-raise-mode
623 @findex auto-lower-mode
624 @table @kbd
625 @item M-x set-foreground-color @key{RET} @var{color} @key{RET}
626 Specify color @var{color} for the foreground of the selected frame.
627 (This also changes the foreground color of the default face.)
629 @item M-x set-background-color @key{RET} @var{color} @key{RET}
630 Specify color @var{color} for the background of the selected frame.
631 (This also changes the background color of the default face.)
633 @item M-x set-cursor-color @key{RET} @var{color} @key{RET}
634 Specify color @var{color} for the cursor of the selected frame.
636 @item M-x set-mouse-color @key{RET} @var{color} @key{RET}
637 Specify color @var{color} for the mouse cursor when it is over the
638 selected frame.
640 @item M-x set-border-color @key{RET} @var{color} @key{RET}
641 Specify color @var{color} for the border of the selected frame.
643 @item M-x list-colors-display
644 Display the defined color names and show what the colors look like.
645 This command is somewhat slow.
647 @item M-x auto-raise-mode
648 Toggle whether or not the selected frame should auto-raise.  Auto-raise
649 means that every time you move the mouse onto the frame, it raises the
650 frame.
652 Note that this auto-raise feature is implemented by Emacs itself.  Some
653 window managers also implement auto-raise.  If you enable auto-raise for
654 Emacs frames in your X window manager, it should work, but it is beyond
655 Emacs's control and therefore @code{auto-raise-mode} has no effect on
658 @item M-x auto-lower-mode
659 Toggle whether or not the selected frame should auto-lower.
660 Auto-lower means that every time you move the mouse off the frame,
661 the frame moves to the bottom of the stack of X windows.
663 The command @code{auto-lower-mode} has no effect on auto-lower
664 implemented by the X window manager.  To control that, you must use
665 the appropriate window manager features.
667 @findex set-frame-font
668 @item M-x set-frame-font @key{RET} @var{font} @key{RET}
669 @cindex font (principal)
670 Specify font @var{font} as the principal font for the selected frame.
671 The principal font controls several face attributes of the
672 @code{default} face (@pxref{Faces}).  For example, if the principal font
673 has a height of 12 pt, all text will be drawn in 12 pt fonts, unless you
674 use another face that specifies a different height.  @xref{Font X}, for
675 ways to list the available fonts on your system.
677 @kindex S-Mouse-1
678 You can also set a frame's principal font through a pop-up menu.
679 Press @kbd{S-Mouse-1} to activate this menu.
680 @end table
682   In Emacs versions that use an X toolkit, the color-setting and
683 font-setting functions don't affect menus and the menu bar, since they
684 are displayed by their own widget classes.  To change the appearance of
685 the menus and menu bar, you must use X resources (@pxref{Resources X}).
686 @xref{Colors X}, regarding colors.  @xref{Font X}, regarding choice of
687 font.
689   For information on frame parameters and customization, see @ref{Frame
690 Parameters,,, elisp, The Emacs Lisp Reference Manual}.
692 @node Scroll Bars
693 @section Scroll Bars
694 @cindex Scroll Bar mode
695 @cindex mode, Scroll Bar
697   When using X, Emacs normally makes a @dfn{scroll bar} at the left of
698 each Emacs window.@footnote{Placing it at the left is usually more
699 useful with overlapping frames with text starting at the left margin.}
700 The scroll bar runs the height of the window, and shows a moving
701 rectangular inner box which represents the portion of the buffer
702 currently displayed.  The entire height of the scroll bar represents the
703 entire length of the buffer.
705   You can use @kbd{Mouse-2} (normally, the middle button) in the scroll
706 bar to move or drag the inner box up and down.  If you move it to the
707 top of the scroll bar, you see the top of the buffer.  If you move it to
708 the bottom of the scroll bar, you see the bottom of the buffer.
710   The left and right buttons in the scroll bar scroll by controlled
711 increments.  @kbd{Mouse-1} (normally, the left button) moves the line at
712 the level where you click up to the top of the window.  @kbd{Mouse-3}
713 (normally, the right button) moves the line at the top of the window
714 down to the level where you click.  By clicking repeatedly in the same
715 place, you can scroll by the same distance over and over.
717   If you are using Emacs's own implementation of scroll bars, as opposed
718 to scroll bars from an X toolkit, you can also click @kbd{C-Mouse-2} in
719 the scroll bar to split a window vertically.  The split occurs on the
720 line where you click.
722 @findex scroll-bar-mode
723 @vindex scroll-bar-mode
724   You can enable or disable Scroll Bar mode with the command @kbd{M-x
725 scroll-bar-mode}.  With no argument, it toggles the use of scroll bars.
726 With an argument, it turns use of scroll bars on if and only if the
727 argument is positive.  This command applies to all frames, including
728 frames yet to be created.  Customize the option @code{scroll-bar-mode}
729 to control the use of scroll bars at startup.  You can use it to specify
730 that they are placed at the right of windows if you prefer that.  You
731 can use the X resource @samp{verticalScrollBars} to control the initial
732 setting of Scroll Bar mode similarly.  @xref{Resources X}.
734 @findex toggle-scroll-bar
735   To enable or disable scroll bars for just the selected frame, use the
736 @kbd{M-x toggle-scroll-bar} command.
738 @vindex scroll-bar-width
739 @cindex width of the scroll bar
740   You can control the scroll bar width by changing the value of the
741 @code{scroll-bar-width} frame parameter.
743 @node Wheeled Mice
744 @section Scrolling With ``Wheeled'' Mice
746 @cindex mouse wheel
747 @cindex wheel, mouse
748 @findex mouse-wheel-mode
749 @cindex Mouse Wheel minor mode
750 @cindex mode, Mouse Wheel
751   Some mice have a ``wheel'' instead of a third button.  You can
752 usually click the wheel to act as either @kbd{Mouse-2} or
753 @kbd{Mouse-3}, depending on the setup.  You can also use the wheel to
754 scroll windows instead of using the scroll bar or keyboard commands.
755 To do so, turn on Mouse Wheel global minor mode with the command
756 @kbd{M-x mouse-wheel-mode} or by customizing the option
757 @code{mouse-wheel-mode}.  Support for the wheel depends on the system
758 generating appropriate events for Emacs.
760 @vindex mouse-wheel-follow-mouse
761 @vindex mouse-wheel-scroll-amount
762   The variables @code{mouse-wheel-follow-mouse} and
763 @code{mouse-wheel-scroll-amount} determine where and by how much
764 buffers are scrolled.
766 @node Menu Bars
767 @section Menu Bars
768 @cindex Menu Bar mode
769 @cindex mode, Menu Bar
771   You can turn display of menu bars on or off with @kbd{M-x
772 menu-bar-mode} or by customizing the option @code{menu-bar-mode}.
773 With no argument, this command toggles Menu Bar mode, a
774 minor mode.  With an argument, the command turns Menu Bar mode on if the
775 argument is positive, off if the argument is not positive.  You can use
776 the X resource @samp{menuBarLines} to control the initial setting of
777 Menu Bar mode.  @xref{Resources X}.
779 @kindex C-Mouse-3 @r{(when menu bar is disabled)}
780   Expert users often turn off the menu bar, especially on text-only
781 terminals, where this makes one additional line available for text.
782 If the menu bar is off, you can still pop up a menu of its contents
783 with @kbd{C-Mouse-3} on a display which supports popup menus.
784 @xref{Menu Mouse Clicks}.
786   @xref{Menu Bar}, for information on how to invoke commands with the
787 menu bar.
789 @node Tool Bars
790 @section Tool Bars
791 @cindex Tool Bar mode
792 @cindex mode, Tool Bar
793 @cindex icons, tool bar
795 The @dfn{tool bar} is a line (or multiple lines) of icons at the top
796 of the Emacs window.  You can click on these icons with the mouse
797 to do various jobs.
799 The global tool bar contains general commands.  Some major modes
800 define their own tool bars to replace it.  A few ``special'' modes
801 that are not designed for ordinary editing remove some items from the
802 global tool bar.
804 Tool bars work only on a graphical display.  The tool bar uses colored
805 XPM icons if Emacs was built with XPM support.  Otherwise, the tool
806 bar uses monochrome icons (PBM or XBM format).
808 You can turn display of tool bars on or off with @kbd{M-x
809 tool-bar-mode}.
811 @node Dialog Boxes
812 @section Using Dialog Boxes
813 @cindex dialog boxes
815 @vindex use-dialog-box
816   A dialog box is a special kind of menu for asking you a yes-or-no
817 question or some other special question.  Many Emacs commands use a
818 dialog box to ask a yes-or-no question, if you used the mouse to
819 invoke the command to begin with.
821   You can customize the option @code{use-dialog-box} to suppress the
822 use of dialog boxes.  This also controls whether to use file selection
823 windows (but those are not supported on all platforms).
825 @node Tooltips
826 @section Tooltips (or ``Balloon Help'')
828 @cindex balloon help
829   Tooltips are small X windows displaying a help string at the current
830 mouse position, typically over text---including the mode line---which
831 can be activated with the mouse or other keys.  (This facility is
832 sometimes known as @dfn{balloon help}.)  Help text may be available for
833 menu items too.
835 @findex tooltip-mode
836   To use tooltips, enable Tooltip mode with the command @kbd{M-x
837 tooltip-mode}.  The customization group @code{tooltip} controls
838 various aspects of how tooltips work.  When Tooltip mode is disabled,
839 the help text is displayed in the echo area instead.
841   As of Emacs 21.1, tooltips are not supported on MS-Windows.
842 So help text always appears in the echo area.
844 @node Mouse Avoidance
845 @section Mouse Avoidance
846 @cindex avoiding mouse in the way of your typing
847 @cindex mouse avoidance
849 @vindex mouse-avoidance-mode
850 Mouse Avoidance mode keeps the window system mouse pointer away from
851 point, to avoid obscuring text.  Whenever it moves the mouse, it also
852 raises the frame.  To use Mouse Avoidance mode, customize the option
853 @code{mouse-avoidance-mode}.  You can set this to various values to
854 move the mouse in several ways:
856 @table @code
857 @item banish
858 Move the mouse to the upper-right corner on any keypress;
859 @item exile
860 Move the mouse to the corner only if the cursor gets too close,
861 and allow it to return once the cursor is out of the way;
862 @item jump
863 If the cursor gets too close to the mouse, displace the mouse
864 a random distance & direction;
865 @item animate
866 As @code{jump}, but shows steps along the way for illusion of motion;
867 @item cat-and-mouse
868 The same as @code{animate};
869 @item proteus
870 As @code{animate}, but changes the shape of the mouse pointer too.
871 @end table
873 @findex mouse-avoidance-mode
874 You can also use the command @kbd{M-x mouse-avoidance-mode} to enable
875 the mode.
877 @node Non-Window Terminals
878 @section Non-Window Terminals
879 @cindex non-window terminals
880 @cindex single-frame terminals
882   If your terminal does not have a window system that Emacs supports,
883 then it can display only one Emacs frame at a time.  However, you can
884 still create multiple Emacs frames, and switch between them.  Switching
885 frames on these terminals is much like switching between different
886 window configurations.
888   Use @kbd{C-x 5 2} to create a new frame and switch to it; use @kbd{C-x
889 5 o} to cycle through the existing frames; use @kbd{C-x 5 0} to delete
890 the current frame.
892   Each frame has a number to distinguish it.  If your terminal can
893 display only one frame at a time, the selected frame's number @var{n}
894 appears near the beginning of the mode line, in the form
895 @samp{F@var{n}}.
897 @findex set-frame-name
898 @findex select-frame-by-name
899   @samp{F@var{n}} is actually the frame's name.  You can also specify a
900 different name if you wish, and you can select a frame by its name.  Use
901 the command @kbd{M-x set-frame-name @key{RET} @var{name} @key{RET}} to
902 specify a new name for the selected frame, and use @kbd{M-x
903 select-frame-by-name @key{RET} @var{name} @key{RET}} to select a frame
904 according to its name.  The name you specify appears in the mode line
905 when the frame is selected.
907 @node XTerm Mouse
908 @section Using a Mouse in Terminal Emulators
909 @cindex xterm, mouse support
910 @cindex terminal emulators, mouse support
912 Some terminal emulators under X support mouse clicks in the terminal
913 window.  In a terminal emulator which is compatible with @code{xterm},
914 you can use @kbd{M-x xterm-mouse-mode} to enable simple use of the
915 mouse---only single clicks are supported.  The normal @code{xterm} mouse
916 functionality is still available by holding down the @kbd{SHIFT} key
917 when you press the mouse button.  The Linux console supports this
918 mode if it has support for the mouse enabled, e.g.@: using the
919 @command{gpm} daemon.