*** empty log message ***
[emacs/old-mirror.git] / man / frames.texi
blobd08b25ad828177798352a2694407c2df48cda9a6
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 on MS Windows as of Emacs version 21.1.
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'' command
183 of the program operating the other window, to select the text you want.
184 Then yank it in Emacs with @kbd{C-y} or @kbd{Mouse-2}.
186   These cutting and pasting commands also work on MS-Windows.
188 @cindex primary selection
189 @cindex cut buffer
190 @cindex selection, primary
191 @vindex x-cut-buffer-max
192   When Emacs puts text into the kill ring, or rotates text to the front
193 of the kill ring, it sets the @dfn{primary selection} in the X server.
194 This is how other X clients can access the text.  Emacs also stores the
195 text in the cut buffer, but only if the text is short enough
196 (the value of @code{x-cut-buffer-max} specifies the maximum number of
197 characters); putting long strings in the cut buffer can be slow.
199   The commands to yank the first entry in the kill ring actually check
200 first for a primary selection in another program; after that, they check
201 for text in the cut buffer.  If neither of those sources provides text
202 to yank, the kill ring contents are used.
204 @node Secondary Selection
205 @section Secondary Selection
206 @cindex secondary selection
208   The @dfn{secondary selection} is another way of selecting text using
209 X.  It does not use point or the mark, so you can use it to kill text
210 without setting point or the mark.
212 @table @kbd
213 @findex mouse-set-secondary
214 @kindex M-Drag-Mouse-1
215 @item M-Drag-Mouse-1
216 Set the secondary selection, with one end at the place where you press
217 down the button, and the other end at the place where you release it
218 (@code{mouse-set-secondary}).  The highlighting appears and changes as
219 you drag.  You can control the appearance of the highlighting by
220 customizing the @code{secondary-selection} face (@pxref{Face
221 Customization}).
223 If you move the mouse off the top or bottom of the window while
224 dragging, the window scrolls at a steady rate until you move the mouse
225 back into the window.  This way, you can mark regions that don't fit
226 entirely on the screen.
228 @findex mouse-start-secondary
229 @kindex M-Mouse-1
230 @item M-Mouse-1
231 Set one endpoint for the @dfn{secondary selection}
232 (@code{mouse-start-secondary}).
234 @findex mouse-secondary-save-then-kill
235 @kindex M-Mouse-3
236 @item M-Mouse-3
237 Make a secondary selection, using the place specified with @kbd{M-Mouse-1}
238 as the other end (@code{mouse-secondary-save-then-kill}).  A second click
239 at the same place kills the secondary selection just made.
241 @findex mouse-yank-secondary
242 @kindex M-Mouse-2
243 @item M-Mouse-2
244 Insert the secondary selection where you click
245 (@code{mouse-yank-secondary}).  This places point at the end of the
246 yanked text.
247 @end table
249 Double or triple clicking of @kbd{M-Mouse-1} operates on words and
250 lines, much like @kbd{Mouse-1}.
252 If @code{mouse-yank-at-point} is non-@code{nil}, @kbd{M-Mouse-2}
253 yanks at point.  Then it does not matter precisely where you click; all
254 that matters is which window you click on.  @xref{Mouse Commands}.
256 @node Clipboard
257 @section Using the Clipboard
258 @cindex X clipboard
259 @cindex clipboard
260 @vindex x-select-enable-clipboard
261 @findex menu-bar-enable-clipboard
262 @cindex OpenWindows
263 @cindex Gnome
265   As well as the primary and secondary selection types, X supports a
266 @dfn{clipboard} selection type which is used by some applications,
267 particularly under OpenWindows and Gnome.
269   The command @kbd{M-x menu-bar-enable-clipboard} makes the @code{Cut},
270 @code{Paste} and @code{Copy} menu items, as well as the keys of the same
271 names, all use the clipboard.
273   You can customize the option @code{x-select-enable-clipboard} to make
274 the Emacs yank functions consult the clipboard before the primary
275 selection, and to make the kill functions to store in the clipboard as
276 well as the primary selection.  Otherwise they do not access the
277 clipboard at all.  Using the clipboard is the default on MS-Windows,
278 unlike most systems.
280 @node Mouse References
281 @section Following References with the Mouse
282 @kindex Mouse-2 @r{(selection)}
284   Some Emacs buffers display lists of various sorts.  These include
285 lists of files, of buffers, of possible completions, of matches for
286 a pattern, and so on.
288   Since yanking text into these buffers is not very useful, most of them
289 define @kbd{Mouse-2} specially, as a command to use or view the item you
290 click on.
292   For example, if you click @kbd{Mouse-2} on a file name in a Dired
293 buffer, you visit that file.  If you click @kbd{Mouse-2} on an error
294 message in the @samp{*Compilation*} buffer, you go to the source code
295 for that error message.  If you click @kbd{Mouse-2} on a completion in
296 the @samp{*Completions*} buffer, you choose that completion.
298   You can usually tell when @kbd{Mouse-2} has this special sort of
299 meaning because the sensitive text highlights when you move the mouse
300 over it.
302 @node Menu Mouse Clicks
303 @section Mouse Clicks for Menus
305   Mouse clicks modified with the @key{CTRL} and @key{SHIFT} keys
306 bring up menus.
308 @table @kbd
309 @item C-Mouse-1
310 @kindex C-Mouse-1
311 This menu is for selecting a buffer.
313 The MSB (``mouse select buffer'') global minor mode makes this
314 menu smarter and more customizable.  @xref{Buffer Menus}.
316 @item C-Mouse-2
317 @kindex C-Mouse-2
318 This menu is for specifying faces and other text properties
319 for editing formatted text.  @xref{Formatted Text}.
321 @item C-Mouse-3
322 @kindex C-Mouse-3
323 This menu is mode-specific.  For most modes if Menu-bar mode is on, this
324 menu has the same items as all the mode-specific menu-bar menus put
325 together.  Some modes may specify a different menu for this
326 button.@footnote{Some systems use @kbd{Mouse-3} for a mode-specific
327 menu.  We took a survey of users, and found they preferred to keep
328 @kbd{Mouse-3} for selecting and killing regions.  Hence the decision to
329 use @kbd{C-Mouse-3} for this menu.}  If Menu-bar mode is off, this menu
330 contains all the items which would be present in the menu bar---not just
331 the mode-specific ones---so that you can access them without having to
332 display the menu bar.
334 @item S-Mouse-1
335 This menu is for specifying the frame's principal font.
336 @end table
338 @node Mode Line Mouse
339 @section Mode Line Mouse Commands
340 @cindex mode line, mouse
341 @cindex mouse on mode line
343   You can use mouse clicks on window mode lines to select and manipulate
344 windows.
346 @table @kbd
347 @item Mouse-1
348 @kindex Mouse-1 @r{(mode line)}
349 @kbd{Mouse-1} on a mode line selects the window above.  By dragging
350 @kbd{Mouse-1} on the mode line, you can move it, thus changing the
351 height of the windows above and below.
353 @item Mouse-2
354 @kindex Mouse-2 @r{(mode line)}
355 @kbd{Mouse-2} on a mode line expands that window to fill its frame.
357 @item Mouse-3
358 @kindex Mouse-3 @r{(mode line)}
359 @kbd{Mouse-3} on a mode line deletes the window above.  If the frame has
360 only one window, it buries the current buffer instead and switches to
361 another buffer.
363 @item C-Mouse-2
364 @kindex C-mouse-2 @r{(mode line)}
365 @kbd{C-Mouse-2} on a mode line splits the window above
366 horizontally, above the place in the mode line where you click.
367 @end table
369 @kindex C-Mouse-2 @r{(scroll bar)}
370   @kbd{C-Mouse-2} on a scroll bar splits the corresponding window
371 vertically, unless you are using an X toolkit's implementation of
372 scroll bars.  @xref{Split Window}.
374   The commands above apply to areas of the mode line which do not have
375 special mouse bindings of their own.  Some areas, such as the buffer
376 name and the major mode name, have their own special mouse bindings.
377 Emacs displays information about these bindings when you hold the
378 mouse over such a place (@pxref{Tooltips}).
380 @node Creating Frames
381 @section Creating Frames
382 @cindex creating frames
384 @kindex C-x 5
385   The prefix key @kbd{C-x 5} is analogous to @kbd{C-x 4}, with parallel
386 subcommands.  The difference is that @kbd{C-x 5} commands create a new
387 frame rather than just a new window in the selected frame (@pxref{Pop
388 Up Window}).  If an existing visible or iconified frame already displays
389 the requested material, these commands use the existing frame, after
390 raising or deiconifying as necessary. 
392   The various @kbd{C-x 5} commands differ in how they find or create the
393 buffer to select:
395 @table @kbd
396 @item C-x 5 2
397 @kindex C-x 5 2
398 @findex make-frame-command
399 Create a new frame (@code{make-frame-command}).
400 @item C-x 5 b @var{bufname} @key{RET}
401 Select buffer @var{bufname} in another frame.  This runs
402 @code{switch-to-buffer-other-frame}.
403 @item C-x 5 f @var{filename} @key{RET}
404 Visit file @var{filename} and select its buffer in another frame.  This
405 runs @code{find-file-other-frame}.  @xref{Visiting}.
406 @item C-x 5 d @var{directory} @key{RET}
407 Select a Dired buffer for directory @var{directory} in another frame.
408 This runs @code{dired-other-frame}.  @xref{Dired}.
409 @item C-x 5 m
410 Start composing a mail message in another frame.  This runs
411 @code{mail-other-frame}.  It is the other-frame variant of @kbd{C-x m}.
412 @xref{Sending Mail}.
413 @item C-x 5 .
414 Find a tag in the current tag table in another frame.  This runs
415 @code{find-tag-other-frame}, the multiple-frame variant of @kbd{M-.}.
416 @xref{Tags}.
417 @item C-x 5 r @var{filename} @key{RET}
418 @kindex C-x 5 r
419 @findex find-file-read-only-other-frame
420 Visit file @var{filename} read-only, and select its buffer in another
421 frame.  This runs @code{find-file-read-only-other-frame}.
422 @xref{Visiting}.
423 @end table
425 @cindex default-frame-alist
426 @cindex initial-frame-alist
427   You can control the appearance of new frames you create by setting the
428 frame parameters in @code{default-frame-alist}.  You can use the
429 variable @code{initial-frame-alist} to specify parameters that affect
430 only the initial frame.  @xref{Initial Parameters,,, elisp, The Emacs
431 Lisp Reference Manual}, for more information.
433 @cindex font (default)
434   The easiest way to specify the principal font for all your Emacs
435 frames is with an X resource (@pxref{Font X}), but you can also do it by
436 modifying @code{default-frame-alist} to specify the @code{font}
437 parameter, as shown here:
439 @example
440 (add-to-list 'default-frame-alist '(font . "10x20"))
441 @end example
443 @node Frame Commands
444 @section Frame Commands
446   The following commands let you create, delete and operate on frames:
448 @table @kbd
449 @item C-z
450 @kindex C-z @r{(X windows)}
451 @findex iconify-or-deiconify-frame
452 Iconify the selected Emacs frame (@code{iconify-or-deiconify-frame}).
453 The normal meaning of @kbd{C-z}, to suspend Emacs, is not useful under a
454 window system, so it has a different binding in that case.
456 If you type this command on an Emacs frame's icon, it deiconifies the frame.
458 @item C-x 5 0
459 @kindex C-x 5 0
460 @findex delete-frame
461 Delete the selected frame (@code{delete-frame}).  This is not allowed if
462 there is only one frame.
464 @item C-x 5 o
465 @kindex C-x 5 o
466 @findex other-frame
467 Select another frame, raise it, and warp the mouse to it so that it
468 stays selected.  If you repeat this command, it cycles through all the
469 frames on your terminal.
471 @item C-x 5 1
472 @kindex C-x 5 1
473 @findex delete-other-frames
474 Delete all frames except the selected one.
475 @end table
477 @node Speedbar
478 @section Making and Using a Speedbar Frame
479 @cindex speedbar
481   An Emacs frame can have a @dfn{speedbar}, which is a vertical window
482 that serves as a scrollable menu of files you could visit and tags
483 within those files.  To create a speedbar, type @kbd{M-x speedbar}; this
484 creates a speedbar window for the selected frame.  From then on, you can
485 click on a file name in the speedbar to visit that file in the
486 corresponding Emacs frame, or click on a tag name to jump to that tag in
487 the Emacs frame.
489   Initially the speedbar lists the immediate contents of the current
490 directory, one file per line.  Each line also has a box, @samp{[+]} or
491 @samp{<+>}, that you can click on with @kbd{Mouse-2} to ``open up'' the
492 contents of that item.  If the line names a directory, opening it adds
493 the contents of that directory to the speedbar display, underneath the
494 directory's own line.  If the line lists an ordinary file, opening it up
495 adds a list of the tags in that file to the speedbar display.  When a
496 file is opened up, the @samp{[+]} changes to @samp{[-]}; you can click
497 on that box to ``close up'' that file (hide its contents).
499   Some major modes, including Rmail mode, Info, and GUD, have
500 specialized ways of putting useful items into the speedbar for you to
501 select.  For example, in Rmail mode, the speedbar shows a list of Rmail
502 files, and lets you move the current message to another Rmail file by
503 clicking on its @samp{<M>} box.
505   A speedbar belongs to one Emacs frame, and always operates on that
506 frame.  If you use multiple frames, you can make a speedbar for some or
507 all of the frames; type @kbd{M-x speedbar} in any given frame to make a
508 speedbar for it.
510 @node Multiple Displays
511 @section Multiple Displays
512 @cindex multiple displays
514   A single Emacs can talk to more than one X display.  Initially, Emacs
515 uses just one display---the one specified with the @env{DISPLAY}
516 environment variable or with the @samp{--display} option (@pxref{Initial
517 Options}).  To connect to another display, use the command
518 @code{make-frame-on-display}:
520 @findex make-frame-on-display
521 @table @kbd
522 @item M-x make-frame-on-display @key{RET} @var{display} @key{RET}
523 Create a new frame on display @var{display}.
524 @end table
526   A single X server can handle more than one screen.  When you open
527 frames on two screens belonging to one server, Emacs knows they share a
528 single keyboard, and it treats all the commands arriving from these
529 screens as a single stream of input.
531   When you open frames on different X servers, Emacs makes a separate
532 input stream for each server.  This way, two users can type
533 simultaneously on the two displays, and Emacs will not garble their
534 input.  Each server also has its own selected frame.  The commands you
535 enter with a particular X server apply to that server's selected frame.
537   Despite these features, people using the same Emacs job from different
538 displays can still interfere with each other if they are not careful.
539 For example, if any one types @kbd{C-x C-c}, that exits the Emacs job
540 for all of them!
542 @node Special Buffer Frames
543 @section Special Buffer Frames
545 @vindex special-display-buffer-names
546   You can make certain chosen buffers, for which Emacs normally creates
547 a second window when you have just one window, appear in special frames
548 of their own.  To do this, set the variable
549 @code{special-display-buffer-names} to a list of buffer names; any
550 buffer whose name is in that list automatically gets a special frame,
551 when an Emacs command wants to display it ``in another window.''
553   For example, if you set the variable this way,
555 @example
556 (setq special-display-buffer-names
557       '("*Completions*" "*grep*" "*tex-shell*"))
558 @end example
560 @noindent
561 then completion lists, @code{grep} output and the @TeX{} mode shell
562 buffer get individual frames of their own.  These frames, and the
563 windows in them, are never automatically split or reused for any other
564 buffers.  They continue to show the buffers they were created for,
565 unless you alter them by hand.  Killing the special buffer deletes its
566 frame automatically.
568 @vindex special-display-regexps
569   More generally, you can set @code{special-display-regexps} to a list
570 of regular expressions; then a buffer gets its own frame if its name
571 matches any of those regular expressions.  (Once again, this applies only
572 to buffers that normally get displayed for you in a separate window.)
574 @vindex special-display-frame-alist
575   The variable @code{special-display-frame-alist} specifies the frame
576 parameters for these frames.  It has a default value, so you don't need
577 to set it.
579   For those who know Lisp, an element of
580 @code{special-display-buffer-names} or @code{special-display-regexps}
581 can also be a list.  Then the first element is the buffer name or
582 regular expression; the rest of the list specifies how to create the
583 frame.  It can be an association list specifying frame parameter values;
584 these values take precedence over parameter values specified in
585 @code{special-display-frame-alist}.  Alternatively, it can have this
586 form:
588 @example
589 (@var{function} @var{args}...)
590 @end example
592 @noindent
593 where @var{function} is a symbol.  Then the frame is constructed by
594 calling @var{function}; its first argument is the buffer, and its
595 remaining arguments are @var{args}.
597    An analogous feature lets you specify buffers which should be
598 displayed in the selected window.  @xref{Force Same Window}.  The
599 same-window feature takes precedence over the special-frame feature;
600 therefore, if you add a buffer name to
601 @code{special-display-buffer-names} and it has no effect, check to see
602 whether that feature is also in use for the same buffer name.
604 @node Frame Parameters
605 @section Setting Frame Parameters
606 @cindex colors
607 @cindex Auto-Raise mode
608 @cindex Auto-Lower mode
610   This section describes commands for altering the display style and
611 window management behavior of the selected frame.
613 @findex set-foreground-color
614 @findex set-background-color
615 @findex set-cursor-color
616 @findex set-mouse-color
617 @findex set-border-color
618 @findex auto-raise-mode
619 @findex auto-lower-mode
620 @table @kbd
621 @item M-x set-foreground-color @key{RET} @var{color} @key{RET}
622 Specify color @var{color} for the foreground of the selected frame.
623 (This also changes the foreground color of the default face.)
625 @item M-x set-background-color @key{RET} @var{color} @key{RET}
626 Specify color @var{color} for the background of the selected frame.
627 (This also changes the background color of the default face.)
629 @item M-x set-cursor-color @key{RET} @var{color} @key{RET}
630 Specify color @var{color} for the cursor of the selected frame.
632 @item M-x set-mouse-color @key{RET} @var{color} @key{RET}
633 Specify color @var{color} for the mouse cursor when it is over the
634 selected frame.
636 @item M-x set-border-color @key{RET} @var{color} @key{RET}
637 Specify color @var{color} for the border of the selected frame.
639 @item M-x list-colors-display
640 Display the defined color names and show what the colors look like.
641 This command is somewhat slow.
643 @item M-x auto-raise-mode
644 Toggle whether or not the selected frame should auto-raise.  Auto-raise
645 means that every time you move the mouse onto the frame, it raises the
646 frame.
648 Note that this auto-raise feature is implemented by Emacs itself.  Some
649 window managers also implement auto-raise.  If you enable auto-raise for
650 Emacs frames in your X window manager, it should work, but it is beyond
651 Emacs's control and therefore @code{auto-raise-mode} has no effect on
654 @item M-x auto-lower-mode
655 Toggle whether or not the selected frame should auto-lower.
656 Auto-lower means that every time you move the mouse off the frame,
657 the frame moves to the bottom of the stack of X windows.
659 The command @code{auto-lower-mode} has no effect on auto-lower
660 implemented by the X window manager.  To control that, you must use
661 the appropriate window manager features.
663 @findex set-frame-font
664 @item M-x set-frame-font @key{RET} @var{font} @key{RET}
665 @cindex font (principal)
666 Specify font @var{font} as the principal font for the selected frame.
667 The principal font controls several face attributes of the
668 @code{default} face (@pxref{Faces}).  For example, if the principal font
669 has a height of 12 pt, all text will be drawn in 12 pt fonts, unless you
670 use another face that specifies a different height.  @xref{Font X}, for
671 ways to list the available fonts on your system.
673 @kindex S-Mouse-1
674 You can also set a frame's principal font through a pop-up menu.
675 Press @kbd{S-Mouse-1} to activate this menu.
676 @end table
678   In Emacs versions that use an X toolkit, the color-setting and
679 font-setting functions don't affect menus and the menu bar, since they
680 are displayed by their own widget classes.  To change the appearance of
681 the menus and menu bar, you must use X resources (@pxref{Resources X}).
682 @xref{Colors X}, regarding colors.  @xref{Font X}, regarding choice of
683 font.
685   For information on frame parameters and customization, see @ref{Frame
686 Parameters,,, elisp, The Emacs Lisp Reference Manual}.
688 @node Scroll Bars
689 @section Scroll Bars
690 @cindex Scroll Bar mode
691 @cindex mode, Scroll Bar
693   When using X, Emacs normally makes a @dfn{scroll bar} at the left of
694 each Emacs window.@footnote{Placing it at the left is usually more
695 useful with overlapping frames with text starting at the left margin.}
696 The scroll bar runs the height of the window, and shows a moving
697 rectangular inner box which represents the portion of the buffer
698 currently displayed.  The entire height of the scroll bar represents the
699 entire length of the buffer.
701   You can use @kbd{Mouse-2} (normally, the middle button) in the scroll
702 bar to move or drag the inner box up and down.  If you move it to the
703 top of the scroll bar, you see the top of the buffer.  If you move it to
704 the bottom of the scroll bar, you see the bottom of the buffer.
706   The left and right buttons in the scroll bar scroll by controlled
707 increments.  @kbd{Mouse-1} (normally, the left button) moves the line at
708 the level where you click up to the top of the window.  @kbd{Mouse-3}
709 (normally, the right button) moves the line at the top of the window
710 down to the level where you click.  By clicking repeatedly in the same
711 place, you can scroll by the same distance over and over.
713   If you are using Emacs's own implementation of scroll bars, as opposed
714 to scroll bars from an X toolkit, you can also click @kbd{C-Mouse-2} in
715 the scroll bar to split a window vertically.  The split occurs on the
716 line where you click.
718 @findex scroll-bar-mode
719 @vindex scroll-bar-mode
720   You can enable or disable Scroll Bar mode with the command @kbd{M-x
721 scroll-bar-mode}.  With no argument, it toggles the use of scroll bars.
722 With an argument, it turns use of scroll bars on if and only if the
723 argument is positive.  This command applies to all frames, including
724 frames yet to be created.  Customize the option @code{scroll-bar-mode}
725 to control the use of scroll bars at startup.  You can use it to specify
726 that they are placed at the right of windows if you prefer that.  You
727 can use the X resource @samp{verticalScrollBars} to control the initial
728 setting of Scroll Bar mode similarly.  @xref{Resources X}.
730 @findex toggle-scroll-bar
731   To enable or disable scroll bars for just the selected frame, use the
732 @kbd{M-x toggle-scroll-bar} command.
734 @vindex scroll-bar-width
735 @cindex width of the scroll bar
736   You can control the scroll bar width by changing the value of the
737 @code{scroll-bar-width} frame parameter.
739 @node Wheeled Mice
740 @section Scrolling With ``Wheeled'' Mice
742 @cindex mouse wheel
743 @cindex wheel, mouse
744 @findex mouse-wheel-mode
745 @cindex Mouse Wheel minor mode
746 @cindex mode, Mouse Wheel
747   Some mice have a ``wheel'' instead of a third button.  You can
748 usually click the wheel to act as either @kbd{Mouse-2} or
749 @kbd{Mouse-3}, depending on the setup.  You can also use the wheel to
750 scroll windows instead of using the scroll bar or keyboard commands.
751 To do so, turn on Mouse Wheel global minor mode with the command
752 @kbd{M-x mouse-wheel-mode} or by customizing the option
753 @code{mouse-wheel-mode}.  Support for the wheel depends on the system
754 generating appropriate events for Emacs.
756 @vindex mouse-wheel-follow-mouse
757 @vindex mouse-wheel-scroll-amount
758   The variables @code{mouse-wheel-follow-mouse} and
759 @code{mouse-wheel-scroll-amount} determine where and by how much
760 buffers are scrolled.
762 @node Menu Bars
763 @section Menu Bars
764 @cindex Menu Bar mode
765 @cindex mode, Menu Bar
767   You can turn display of menu bars on or off with @kbd{M-x
768 menu-bar-mode} or by customizing the option @code{menu-bar-mode}.
769 With no argument, this command toggles Menu Bar mode, a
770 minor mode.  With an argument, the command turns Menu Bar mode on if the
771 argument is positive, off if the argument is not positive.  You can use
772 the X resource @samp{menuBarLines} to control the initial setting of
773 Menu Bar mode.  @xref{Resources X}.
775 @kindex C-Mouse-3 @r{(when menu bar is disabled)}
776   Expert users often turn off the menu bar, especially on text-only
777 terminals, where this makes one additional line available for text.
778 If the menu bar is off, you can still pop up a menu of its contents
779 with @kbd{C-Mouse-3} on a display which supports popup menus.
780 @xref{Menu Mouse Clicks}.
782   @xref{Menu Bar}, for information on how to invoke commands with the
783 menu bar.
785 @node Tool Bars
786 @section Tool Bars
787 @cindex Tool Bar mode
788 @cindex mode, Tool Bar
789 @cindex icons, tool bar
791 The @dfn{tool bar} is a line (or multiple lines) of icons at the top
792 of the Emacs window.  You can click on these icons with the mouse
793 to do various jobs.
795 The global tool bar contains general commands.  Some major modes
796 define their own tool bars to replace it.  A few ``special'' modes
797 that are not designed for ordinary editing remove some items from the
798 global tool bar.
800 Tool bars work only on a graphical display.  The tool bar uses colored
801 XPM icons if Emacs was built with XPM support.  Otherwise, the tool
802 bar uses monochrome icons (PBM or XBM format).
804 You can turn display of tool bars on or off with @kbd{M-x
805 tool-bar-mode}.
807 @node Dialog Boxes
808 @section Using Dialog Boxes
809 @cindex dialog boxes
811 @vindex use-dialog-box
812   A dialog box is a special kind of menu for asking you a yes-or-no
813 question or some other special question.  Many Emacs commands use a
814 dialog box to ask a yes-or-no question, if you used the mouse to
815 invoke the command to begin with.
817   You can customize the option @code{use-dialog-box} to suppress the
818 use of dialog boxes.  This also controls whether to use file selection
819 windows (but those are not supported on all platforms).
821 @node Tooltips
822 @section Tooltips (or ``Balloon Help'')
824 @cindex balloon help
825   Tooltips are small X windows displaying a help string at the current
826 mouse position, typically over text---including the mode line---which
827 can be activated with the mouse or other keys.  (This facility is
828 sometimes known as @dfn{balloon help}.)  Help text may be available for
829 menu items too.
831 @findex tooltip-mode
832   To use tooltips, enable Tooltip mode with the command @kbd{M-x
833 tooltip-mode}.  The customization group @code{tooltip} controls
834 various aspects of how tooltips work.  When Tooltip mode is disabled,
835 the help text is displayed in the echo area instead.
837   As of Emacs 21.1, tooltips are not supported on MS-Windows.
838 So help text always appears in the echo area.
840 @node Mouse Avoidance
841 @section Mouse Avoidance
842 @cindex avoiding mouse in the way of your typing
843 @cindex mouse avoidance
845 @vindex mouse-avoidance-mode
846 Mouse Avoidance mode keeps the window system mouse pointer away from
847 point, to avoid obscuring text.  Whenever it moves the mouse, it also
848 raises the frame.  To use Mouse Avoidance mode, customize the option
849 @code{mouse-avoidance-mode}.  You can set this to various values to
850 move the mouse in several ways:
852 @table @code
853 @item banish
854 Move the mouse to the upper-right corner on any keypress;
855 @item exile
856 Move the mouse to the corner only if the cursor gets too close,
857 and allow it to return once the cursor is out of the way;
858 @item jump
859 If the cursor gets too close to the mouse, displace the mouse
860 a random distance & direction;
861 @item animate
862 As @code{jump}, but shows steps along the way for illusion of motion;
863 @item cat-and-mouse
864 The same as @code{animate};
865 @item proteus
866 As @code{animate}, but changes the shape of the mouse pointer too.
867 @end table
869 @findex mouse-avoidance-mode
870 You can also use the command @kbd{M-x mouse-avoidance-mode} to enable
871 the mode.
873 @node Non-Window Terminals
874 @section Non-Window Terminals
875 @cindex non-window terminals
876 @cindex single-frame terminals
878   If your terminal does not have a window system that Emacs supports,
879 then it can display only one Emacs frame at a time.  However, you can
880 still create multiple Emacs frames, and switch between them.  Switching
881 frames on these terminals is much like switching between different
882 window configurations.
884   Use @kbd{C-x 5 2} to create a new frame and switch to it; use @kbd{C-x
885 5 o} to cycle through the existing frames; use @kbd{C-x 5 0} to delete
886 the current frame.
888   Each frame has a number to distinguish it.  If your terminal can
889 display only one frame at a time, the selected frame's number @var{n}
890 appears near the beginning of the mode line, in the form
891 @samp{F@var{n}}.
893 @findex set-frame-name
894 @findex select-frame-by-name
895   @samp{F@var{n}} is actually the frame's name.  You can also specify a
896 different name if you wish, and you can select a frame by its name.  Use
897 the command @kbd{M-x set-frame-name @key{RET} @var{name} @key{RET}} to
898 specify a new name for the selected frame, and use @kbd{M-x
899 select-frame-by-name @key{RET} @var{name} @key{RET}} to select a frame
900 according to its name.  The name you specify appears in the mode line
901 when the frame is selected.
903 @node XTerm Mouse
904 @section Using a Mouse in Terminal Emulators
905 @cindex xterm, mouse support
906 @cindex terminal emulators, mouse support
908 Some terminal emulators under X support mouse clicks in the terminal
909 window.  In a terminal emulator which is compatible with @code{xterm},
910 you can use @kbd{M-x xterm-mouse-mode} to enable simple use of the
911 mouse---only single clicks are supported.  The normal @code{xterm} mouse
912 functionality is still available by holding down the @kbd{SHIFT} key
913 when you press the mouse button.  The Linux console supports this
914 mode if it has support for the mouse enabled, e.g.@: using the
915 @command{gpm} daemon.