(Emergency Escape): Simplify.
[bpt/emacs.git] / man / frames.texi
CommitLineData
6bf7aab6 1@c This is part of the Emacs manual.
b65d8176 2@c Copyright (C) 1985, 1986, 1987, 1993, 1994, 1995, 1997, 1999, 2000,
8d99e09d 3@c 2001, 2002, 2003, 2004, 2005, 2006 Free Software Foundation, Inc.
6bf7aab6
DL
4@c See file emacs.texi for copying conditions.
5@node Frames, International, Windows, Top
9c75b187 6@chapter Frames and Graphical Displays
6bf7aab6
DL
7@cindex frames
8
9c75b187
RS
9 When using a graphical display, you can create multiple windows at
10the system in a single Emacs session. Each system-level window that
11belongs to Emacs displays a @dfn{frame} which can contain one or
12several Emacs windows. A frame initially contains a single
13general-purpose Emacs window which you can subdivide vertically or
14horizontally into smaller windows. A frame normally contains its own
15echo area and minibuffer, but you can make frames that don't have
16these---they use the echo area and minibuffer of another frame.
6bf7aab6 17
9c75b187
RS
18 To avoid confusion, we reserve the word ``window'' for the
19subdivisions that Emacs implements, and never use it to refer to a
20frame.
21
22 Editing you do in one frame affects the other frames. For
6bf7aab6
DL
23instance, if you put text in the kill ring in one frame, you can yank it
24in another frame. If you exit Emacs through @kbd{C-x C-c} in one frame,
25it terminates all the frames. To delete just one frame, use @kbd{C-x 5
85d6c6e7 260} (that is zero, not @kbd{o}).
6bf7aab6 27
9c75b187 28 Emacs compiled for MS-DOS emulates some windowing functionality,
6bf7aab6 29so that you can use many of the features described in this chapter.
e691d082 30@xref{MS-DOS Mouse,,,emacs-xtra,Specialized Emacs Features}.
6bf7aab6
DL
31
32@menu
33* Mouse Commands:: Moving, cutting, and pasting, with the mouse.
34* Secondary Selection:: Cutting without altering point and mark.
d235b2db 35* Clipboard:: Using the clipboard for selections.
6bf7aab6
DL
36* Mouse References:: Using the mouse to select an item from a list.
37* Menu Mouse Clicks:: Mouse clicks that bring up menus.
38* Mode Line Mouse:: Mouse clicks on the mode line.
6bf7aab6 39* Creating Frames:: Creating additional Emacs frames with various contents.
099bfef9
RS
40* Frame Commands:: Iconifying, deleting, and switching frames.
41* Speedbar:: How to make and use a speedbar frame.
6bf7aab6
DL
42* Multiple Displays:: How one Emacs job can talk to several displays.
43* Special Buffer Frames:: You can make certain buffers have their own frames.
44* Frame Parameters:: Changing the colors and other modes of frames.
45* Scroll Bars:: How to enable and disable scroll bars; how to use them.
70c88b57 46* Wheeled Mice:: Using mouse wheels for scrolling.
cc9355ea 47* Drag and Drop:: Using drag and drop to open files and insert text.
6bf7aab6 48* Menu Bars:: Enabling and disabling the menu bar.
2beab0db 49* Tool Bars:: Enabling and disabling the tool bar.
70c88b57 50* Dialog Boxes:: Controlling use of dialog boxes.
6f58eede 51* Tooltips:: Displaying information at the current mouse position.
43391ff3 52* Mouse Avoidance:: Moving the mouse pointer out of the way.
6bf7aab6 53* Non-Window Terminals:: Multiple frames on terminals that show only one.
70c88b57 54* XTerm Mouse:: Using the mouse in an XTerm terminal emulator.
6bf7aab6
DL
55@end menu
56
57@node Mouse Commands
58@section Mouse Commands for Editing
59@cindex mouse buttons (what they do)
60
61 The mouse commands for selecting and copying a region are mostly
62compatible with the @code{xterm} program. You can use the same mouse
511002e9
RS
63commands for copying between Emacs and other window-based programs.
64Most of these commands also work in Emacs when you run it under an
65@code{xterm} terminal.
6bf7aab6 66
0e824f4f 67@kindex DELETE @r{(and mouse selection)}
6bf7aab6
DL
68 If you select a region with any of these mouse commands, and then
69immediately afterward type the @key{DELETE} function key, it deletes the
70region that you selected. The @key{BACKSPACE} function key and the
76dd3692 71@acronym{ASCII} character @key{DEL} do not do this; if you type any other key
6bf7aab6
DL
72in between the mouse command and @key{DELETE}, it does not do this.
73
74@findex mouse-set-region
75@findex mouse-set-point
76@findex mouse-yank-at-click
77@findex mouse-save-then-click
78@kindex Mouse-1
79@kindex Mouse-2
80@kindex Mouse-3
81@table @kbd
82@item Mouse-1
83Move point to where you click (@code{mouse-set-point}).
84This is normally the left button.
85
360b756f
RS
86@vindex x-mouse-click-focus-ignore-position
87Normally, Emacs does not distinguish between ordinary mouse clicks and
88clicks that select a frame. When you click on a frame to select it,
89that also changes the selected window and cursor position according to
90the mouse click position. On the X window system, you can change this
91behavior by setting the variable
92@code{x-mouse-click-focus-ignore-position} to @code{t}. Then the
93first click selects the frame, but does not affect the selected window
94or cursor position. If you click again in the same place, since that
95click will be in the selected frame, it will change the window or
96cursor position.
97
6bf7aab6
DL
98@item Drag-Mouse-1
99Set the region to the text you select by dragging, and copy it to the
100kill ring (@code{mouse-set-region}). You can specify both ends of the
101region with this single command.
102
103@vindex mouse-scroll-min-lines
104If you move the mouse off the top or bottom of the window while
105dragging, the window scrolls at a steady rate until you move the mouse
106back into the window. This way, you can select regions that don't fit
107entirely on the screen. The number of lines scrolled per step depends
108on how far away from the window edge the mouse has gone; the variable
109@code{mouse-scroll-min-lines} specifies a minimum step size.
110
360b756f
RS
111@vindex mouse-drag-copy-region
112If the variable @code{mouse-drag-copy-region} is @code{nil}, this
113mouse command does not copy the selected region into the kill ring.
114
6bf7aab6
DL
115@item Mouse-2
116Yank the last killed text, where you click (@code{mouse-yank-at-click}).
117This is normally the middle button.
118
119@item Mouse-3
120This command, @code{mouse-save-then-kill}, has several functions
121depending on where you click and the status of the region.
122
123The most basic case is when you click @kbd{Mouse-1} in one place and
124then @kbd{Mouse-3} in another. This selects the text between those two
125positions as the region. It also copies the new region to the kill
126ring, so that you can copy it to someplace else.
127
128If you click @kbd{Mouse-1} in the text, scroll with the scroll bar, and
129then click @kbd{Mouse-3}, it remembers where point was before scrolling
130(where you put it with @kbd{Mouse-1}), and uses that position as the
131other end of the region. This is so that you can select a region that
132doesn't fit entirely on the screen.
133
134More generally, if you do not have a highlighted region, @kbd{Mouse-3}
135selects the text between point and the click position as the region. It
136does this by setting the mark where point was, and moving point to where
137you click.
138
139If you have a highlighted region, or if the region was set just before
140by dragging button 1, @kbd{Mouse-3} adjusts the nearer end of the region
141by moving it to where you click. The adjusted region's text also
142replaces the old region's text in the kill ring.
143
144If you originally specified the region using a double or triple
145@kbd{Mouse-1}, so that the region is defined to consist of entire words
146or lines, then adjusting the region with @kbd{Mouse-3} also proceeds by
147entire words or lines.
148
149If you use @kbd{Mouse-3} a second time consecutively, at the same place,
150that kills the region already selected.
151
152@item Double-Mouse-1
153This key sets the region around the word which you click on. If you
154click on a character with ``symbol'' syntax (such as underscore, in C
155mode), it sets the region around the symbol surrounding that character.
156
157If you click on a character with open-parenthesis or close-parenthesis
57d28ead 158syntax, it sets the region around the parenthetical grouping
6bf7aab6
DL
159which that character starts or ends. If you click on a character with
160string-delimiter syntax (such as a singlequote or doublequote in C), it
161sets the region around the string constant (using heuristics to figure
162out whether that character is the beginning or the end of it).
163
164@item Double-Drag-Mouse-1
165This key selects a region made up of the words you drag across.
166
167@item Triple-Mouse-1
168This key sets the region around the line you click on.
169
170@item Triple-Drag-Mouse-1
171This key selects a region made up of the lines you drag across.
172@end table
173
174 The simplest way to kill text with the mouse is to press @kbd{Mouse-1}
175at one end, then press @kbd{Mouse-3} twice at the other end.
176@xref{Killing}. To copy the text into the kill ring without deleting it
177from the buffer, press @kbd{Mouse-3} just once---or just drag across the
178text with @kbd{Mouse-1}. Then you can copy it elsewhere by yanking it.
179
180@vindex mouse-yank-at-point
181 To yank the killed or copied text somewhere else, move the mouse there
182and press @kbd{Mouse-2}. @xref{Yanking}. However, if
183@code{mouse-yank-at-point} is non-@code{nil}, @kbd{Mouse-2} yanks at
184point. Then it does not matter where you click, or even which of the
185frame's windows you click on. The default value is @code{nil}. This
186variable also affects yanking the secondary selection.
187
9c75b187
RS
188@cindex cutting
189@cindex pasting
6bf7aab6 190@cindex X cutting and pasting
9c75b187
RS
191 To copy text to another windowing application, kill it or save it in
192the kill ring. Then use the ``paste'' or ``yank'' command of the
193other application to insert the text.
6bf7aab6 194
9c75b187
RS
195 To copy text from another windowing application, use its ``cut'' or
196``copy'' command to select the text you want. Then yank it in Emacs
197with @kbd{C-y} or @kbd{Mouse-2}.
6bf7aab6 198
6bf7aab6
DL
199@cindex primary selection
200@cindex cut buffer
201@cindex selection, primary
202@vindex x-cut-buffer-max
9c75b187
RS
203 When Emacs puts text into the kill ring, or rotates text to the
204front of the kill ring, it sets the @dfn{primary selection} in the
205window system. This is how other windowing applications can access
206the text. On the X Window System, emacs also stores the text in the
207cut buffer, but only if the text is short enough (the value of
208@code{x-cut-buffer-max} specifies the maximum number of characters);
209putting long strings in the cut buffer can be slow.
6bf7aab6
DL
210
211 The commands to yank the first entry in the kill ring actually check
212first for a primary selection in another program; after that, they check
213for text in the cut buffer. If neither of those sources provides text
214to yank, the kill ring contents are used.
215
9c75b187
RS
216 The standard coding system for X Window System selections is
217@code{compound-text-with-extensions}. To specify another coding
218system for selections, use @kbd{C-x @key{RET} x} or @kbd{C-x @key{RET}
219X}. @xref{Communication Coding}.
220
6bf7aab6
DL
221@node Secondary Selection
222@section Secondary Selection
223@cindex secondary selection
224
225 The @dfn{secondary selection} is another way of selecting text using
9c75b187
RS
226the X Window System. It does not use point or the mark, so you can
227use it to kill text without setting point or the mark.
6bf7aab6
DL
228
229@table @kbd
230@findex mouse-set-secondary
231@kindex M-Drag-Mouse-1
232@item M-Drag-Mouse-1
233Set the secondary selection, with one end at the place where you press
234down the button, and the other end at the place where you release it
235(@code{mouse-set-secondary}). The highlighting appears and changes as
85d6c6e7
RS
236you drag. You can control the appearance of the highlighting by
237customizing the @code{secondary-selection} face (@pxref{Face
238Customization}).
6bf7aab6
DL
239
240If you move the mouse off the top or bottom of the window while
241dragging, the window scrolls at a steady rate until you move the mouse
242back into the window. This way, you can mark regions that don't fit
243entirely on the screen.
244
779bc800
LT
245This way of setting the secondary selection does not alter the kill ring.
246
6bf7aab6
DL
247@findex mouse-start-secondary
248@kindex M-Mouse-1
249@item M-Mouse-1
250Set one endpoint for the @dfn{secondary selection}
251(@code{mouse-start-secondary}).
252
253@findex mouse-secondary-save-then-kill
254@kindex M-Mouse-3
255@item M-Mouse-3
256Make a secondary selection, using the place specified with @kbd{M-Mouse-1}
779bc800
LT
257as the other end (@code{mouse-secondary-save-then-kill}). This also
258puts the selected text in the kill ring. A second click at the same
259place kills the secondary selection just made.
6bf7aab6
DL
260
261@findex mouse-yank-secondary
262@kindex M-Mouse-2
263@item M-Mouse-2
264Insert the secondary selection where you click
265(@code{mouse-yank-secondary}). This places point at the end of the
266yanked text.
267@end table
268
269Double or triple clicking of @kbd{M-Mouse-1} operates on words and
270lines, much like @kbd{Mouse-1}.
271
272If @code{mouse-yank-at-point} is non-@code{nil}, @kbd{M-Mouse-2}
273yanks at point. Then it does not matter precisely where you click; all
274that matters is which window you click on. @xref{Mouse Commands}.
275
d235b2db
DL
276@node Clipboard
277@section Using the Clipboard
d235b2db
DL
278@cindex clipboard
279@vindex x-select-enable-clipboard
280@findex menu-bar-enable-clipboard
281@cindex OpenWindows
282@cindex Gnome
283
9c75b187
RS
284 Apart from the primary and secondary selection types, Emacs can
285handle the @dfn{clipboard} selection type which is used by some
286applications, particularly under OpenWindows and Gnome.
d235b2db 287
099bfef9 288 The command @kbd{M-x menu-bar-enable-clipboard} makes the @code{Cut},
d235b2db
DL
289@code{Paste} and @code{Copy} menu items, as well as the keys of the same
290names, all use the clipboard.
177c0ea7 291
19b2c4ca 292 You can customize the variable @code{x-select-enable-clipboard} to make
d235b2db
DL
293the Emacs yank functions consult the clipboard before the primary
294selection, and to make the kill functions to store in the clipboard as
295well as the primary selection. Otherwise they do not access the
99ce07a6 296clipboard at all. Using the clipboard is the default on MS-Windows and Mac,
9c75b187 297but not on other systems.
d235b2db 298
6bf7aab6
DL
299@node Mouse References
300@section Following References with the Mouse
511002e9 301@kindex Mouse-1 @r{(selection)}
6bf7aab6
DL
302@kindex Mouse-2 @r{(selection)}
303
511002e9
RS
304 Some read-only Emacs buffers include references you can follow, or
305commands you can activate. These include names of files, of buffers,
306of possible completions, of matches for a pattern, as well as the
307buttons in Help buffers and customization buffers. You can follow the
308reference or activate the command by moving point to it and typing
309@key{RET}. You can also do this with the mouse, using either
310@kbd{Mouse-1} or @kbd{Mouse-2}.
311
312 Since yanking text into a read-only buffer is not allowed, these
313buffers generally define @kbd{Mouse-2} to follow a reference or
314activate a command. For example, if you click @kbd{Mouse-2} on a file
315name in a Dired buffer, you visit that file. If you click
316@kbd{Mouse-2} on an error message in the @samp{*Compilation*} buffer,
317you go to the source code for that error message. If you click
318@kbd{Mouse-2} on a completion in the @samp{*Completions*} buffer, you
319choose that completion.
320
511002e9
RS
321 However, most applications use @kbd{Mouse-1} to do this sort of
322thing, so Emacs implements this too. If you click @kbd{Mouse-1}
323quickly on a reference or button, it follows or activates. If you
324click slowly, it moves point as usual. Dragging, meaning moving the
325mouse while it is held down, also has its usual behavior of setting
ab95e99c 326the region.
6bf7aab6 327
ab95e99c 328@vindex mouse-1-click-in-non-selected-windows
7f87b2b0
KS
329 Normally, the @kbd{Mouse-1} click behavior is performed on links in
330any window. The variable @code{mouse-1-click-in-non-selected-windows}
331controls whether @kbd{Mouse-1} has this behavior even in non-selected
332windows, or only in the selected window.
333
922bc663 334@vindex mouse-highlight
511002e9
RS
335 You can usually tell when @kbd{Mouse-1} and @kbd{Mouse-2} have this
336special sort of meaning because the sensitive text highlights when you
337move the mouse over it. The variable @code{mouse-highlight} controls
338whether to do this highlighting always (even when such text appears
339where the mouse already is), never, or only immediately after you move
340the mouse.
6bf7aab6 341
ab95e99c
LT
342@vindex mouse-1-click-follows-link
343 In Emacs versions before 22, only @kbd{Mouse-2} follows links and
9c75b187
RS
344@kbd{Mouse-1} always sets point. If you prefer this older behavior,
345set the variable @code{mouse-1-click-follows-link} to @code{nil}.
346This variable also lets you choose various other alternatives for
347following links with the mouse. Type @kbd{C-h v
348mouse-1-click-follows-link @key{RET}} for more details.
ab95e99c 349
6bf7aab6
DL
350@node Menu Mouse Clicks
351@section Mouse Clicks for Menus
352
9c75b187 353 Several mouse clicks with the @key{CTRL} and @key{SHIFT} modifiers
6bf7aab6
DL
354bring up menus.
355
6bf7aab6
DL
356@table @kbd
357@item C-Mouse-1
239e21e2 358@kindex C-Mouse-1
6bf7aab6
DL
359This menu is for selecting a buffer.
360
cb02ee3e
RS
361The MSB (``mouse select buffer'') global minor mode makes this
362menu smarter and more customizable. @xref{Buffer Menus}.
239e21e2 363
6bf7aab6 364@item C-Mouse-2
239e21e2 365@kindex C-Mouse-2
6bf7aab6
DL
366This menu is for specifying faces and other text properties
367for editing formatted text. @xref{Formatted Text}.
368
369@item C-Mouse-3
239e21e2 370@kindex C-Mouse-3
511002e9
RS
371This menu is mode-specific. For most modes if Menu-bar mode is on,
372this menu has the same items as all the mode-specific menu-bar menus
373put together. Some modes may specify a different menu for this
239e21e2
DL
374button.@footnote{Some systems use @kbd{Mouse-3} for a mode-specific
375menu. We took a survey of users, and found they preferred to keep
511002e9
RS
376@kbd{Mouse-3} for selecting and killing regions. Hence the decision
377to use @kbd{C-Mouse-3} for this menu. To use @kbd{Mouse-3} instead,
378do @code{(global-set-key [mouse-3] 'mouse-popup-menubar-stuff)}.} If
379Menu-bar mode is off, this menu contains all the items which would be
380present in the menu bar---not just the mode-specific ones---so that
381you can access them without having to display the menu bar.
6bf7aab6 382
099bfef9 383@item S-Mouse-1
9c75b187 384This menu is for specifying the frame's default font.
6bf7aab6
DL
385@end table
386
387@node Mode Line Mouse
388@section Mode Line Mouse Commands
239e21e2
DL
389@cindex mode line, mouse
390@cindex mouse on mode line
6bf7aab6
DL
391
392 You can use mouse clicks on window mode lines to select and manipulate
393windows.
394
07039174
EZ
395 Some areas of the mode line, such as the buffer name and the major
396mode name, have their own special mouse bindings. These areas are
397highlighted when you hold the mouse over them, and information about
9c75b187
RS
398the special bindings will be displayed (@pxref{Tooltips}). This
399section's commands do not apply in those areas.
07039174 400
6bf7aab6
DL
401@table @kbd
402@item Mouse-1
099bfef9 403@kindex Mouse-1 @r{(mode line)}
511002e9
RS
404@kbd{Mouse-1} on a mode line selects the window it belongs to. By
405dragging @kbd{Mouse-1} on the mode line, you can move it, thus
9c75b187
RS
406changing the height of the windows above and below. Changing heights
407with the mouse in this way never deletes windows, it just refuses to
408make any window smaller than the minimum height.
6bf7aab6
DL
409
410@item Mouse-2
099bfef9 411@kindex Mouse-2 @r{(mode line)}
6bf7aab6
DL
412@kbd{Mouse-2} on a mode line expands that window to fill its frame.
413
414@item Mouse-3
099bfef9 415@kindex Mouse-3 @r{(mode line)}
511002e9
RS
416@kbd{Mouse-3} on a mode line deletes the window it belongs to. If the
417frame has only one window, it buries the current buffer instead, and
418switches to another buffer.
6bf7aab6
DL
419
420@item C-Mouse-2
099bfef9 421@kindex C-mouse-2 @r{(mode line)}
6bf7aab6
DL
422@kbd{C-Mouse-2} on a mode line splits the window above
423horizontally, above the place in the mode line where you click.
424@end table
425
099bfef9 426@kindex C-Mouse-2 @r{(scroll bar)}
9c75b187
RS
427@kindex Mouse-1 @r{(scroll bar)}
428 Using @kbd{Mouse-1} on the divider between two side-by-side mode
429lines, you can move the vertical boundary left or right. Using
430@kbd{C-Mouse-2} on a scroll bar splits the corresponding window
779bc800 431vertically. @xref{Split Window}.
6bf7aab6
DL
432
433@node Creating Frames
434@section Creating Frames
435@cindex creating frames
436
437@kindex C-x 5
438 The prefix key @kbd{C-x 5} is analogous to @kbd{C-x 4}, with parallel
439subcommands. The difference is that @kbd{C-x 5} commands create a new
440frame rather than just a new window in the selected frame (@pxref{Pop
441Up Window}). If an existing visible or iconified frame already displays
442the requested material, these commands use the existing frame, after
177c0ea7 443raising or deiconifying as necessary.
6bf7aab6
DL
444
445 The various @kbd{C-x 5} commands differ in how they find or create the
446buffer to select:
447
448@table @kbd
449@item C-x 5 2
450@kindex C-x 5 2
451@findex make-frame-command
452Create a new frame (@code{make-frame-command}).
453@item C-x 5 b @var{bufname} @key{RET}
454Select buffer @var{bufname} in another frame. This runs
455@code{switch-to-buffer-other-frame}.
456@item C-x 5 f @var{filename} @key{RET}
457Visit file @var{filename} and select its buffer in another frame. This
458runs @code{find-file-other-frame}. @xref{Visiting}.
459@item C-x 5 d @var{directory} @key{RET}
460Select a Dired buffer for directory @var{directory} in another frame.
461This runs @code{dired-other-frame}. @xref{Dired}.
462@item C-x 5 m
463Start composing a mail message in another frame. This runs
464@code{mail-other-frame}. It is the other-frame variant of @kbd{C-x m}.
465@xref{Sending Mail}.
466@item C-x 5 .
467Find a tag in the current tag table in another frame. This runs
468@code{find-tag-other-frame}, the multiple-frame variant of @kbd{M-.}.
469@xref{Tags}.
470@item C-x 5 r @var{filename} @key{RET}
471@kindex C-x 5 r
472@findex find-file-read-only-other-frame
473Visit file @var{filename} read-only, and select its buffer in another
474frame. This runs @code{find-file-read-only-other-frame}.
475@xref{Visiting}.
476@end table
477
478@cindex default-frame-alist
479@cindex initial-frame-alist
480 You can control the appearance of new frames you create by setting the
481frame parameters in @code{default-frame-alist}. You can use the
482variable @code{initial-frame-alist} to specify parameters that affect
483only the initial frame. @xref{Initial Parameters,,, elisp, The Emacs
484Lisp Reference Manual}, for more information.
485
486@cindex font (default)
487 The easiest way to specify the principal font for all your Emacs
488frames is with an X resource (@pxref{Font X}), but you can also do it by
489modifying @code{default-frame-alist} to specify the @code{font}
490parameter, as shown here:
491
492@example
493(add-to-list 'default-frame-alist '(font . "10x20"))
494@end example
495
eba47cbd
EZ
496@noindent
497Here's a similar example for specifying a foreground color:
498
499@example
7ce1c508 500(add-to-list 'default-frame-alist '(foreground-color . "blue"))
eba47cbd
EZ
501@end example
502
099bfef9
RS
503@node Frame Commands
504@section Frame Commands
505
506 The following commands let you create, delete and operate on frames:
507
508@table @kbd
509@item C-z
510@kindex C-z @r{(X windows)}
511@findex iconify-or-deiconify-frame
512Iconify the selected Emacs frame (@code{iconify-or-deiconify-frame}).
f97b3732
RS
513The normal meaning of @kbd{C-z}, to suspend Emacs, is not useful under
514a graphical display that allows multiple applications to operate
515simultaneously in their own windies, so Emacs gives @kbd{C-z} a
516different binding in that case.
099bfef9
RS
517
518If you type this command on an Emacs frame's icon, it deiconifies the frame.
519
520@item C-x 5 0
521@kindex C-x 5 0
522@findex delete-frame
523Delete the selected frame (@code{delete-frame}). This is not allowed if
524there is only one frame.
525
526@item C-x 5 o
527@kindex C-x 5 o
528@findex other-frame
529Select another frame, raise it, and warp the mouse to it so that it
530stays selected. If you repeat this command, it cycles through all the
531frames on your terminal.
532
533@item C-x 5 1
534@kindex C-x 5 1
535@findex delete-other-frames
536Delete all frames except the selected one.
537@end table
538
93d177d5
RS
539@vindex focus-follows-mouse
540 To make the command @kbd{C-x 5 o} work properly, you must tell Emacs
541how the system (or the window manager) generally handles
542focus-switching between windows. There are two possibilities: either
543simply moving the mouse onto a window selects it (gives it focus), or
544you have to click on it in a suitable way to do so. Unfortunately
545there is no way Emacs can find out automatically which way the system
546handles this, so you have to explicitly say, by setting the variable
547@code{focus-follows-mouse}. If just moving the mouse onto a window
548selects it, that variable should be @code{t}; if a click is necessary,
549the variable should be @code{nil}.
550
6bf7aab6 551@node Speedbar
de22e5d1 552@section Speedbar Frames
6bf7aab6
DL
553@cindex speedbar
554
de22e5d1
RS
555@cindex attached frame (of speedbar)
556 The @dfn{speedbar} is a special frame for conveniently navigating in
557or operating on another frame. The speedbar, when it exists, is
558always associated with a specific frame, called its @dfn{attached
559frame}; all speedbar operations act on that frame.
560
561 Type @kbd{M-x speedbar} to create the speedbar and associate it with
92d22d48
CY
562the current frame. To dismiss the speedbar, type @kbd{M-x speedbar}
563again, or select the speedbar and type @kbd{q}. (You can also delete
564the speedbar frame like any other Emacs frame.) If you wish to
565associate the speedbar with a different frame, dismiss it and call
566@kbd{M-x speedbar} from that frame.
567
de22e5d1
RS
568 The speedbar can operate in various modes. Its default mode is
569@dfn{File Display} mode, which shows the files in the current
570directory of the selected window of the attached frame, one file per
92d22d48
CY
571line. Clicking on a file name visits that file in the selected window
572of the attached frame, and clicking on a directory name shows that
573directory in the speedbar (@pxref{Mouse References}). Each line also
574has a box, @samp{[+]} or @samp{<+>}, that you can click on to
575@dfn{expand} the contents of that item. Expanding a directory adds
576the contents of that directory to the speedbar display, underneath the
577directory's own line. Expanding an ordinary file adds a list of the
578tags in that file to the speedbar display; you can click on a tag name
579to jump to that tag in the selected window of the attached frame.
580When a file or directory is expanded, the @samp{[+]} changes to
581@samp{[-]}; you can click on that box to @dfn{contract} the item,
582hiding its contents.
de22e5d1
RS
583
584 You navigate through the speedbar using the keyboard, too. Typing
585@kbd{RET} while point is on a line in the speedbar is equivalent to
586clicking the item on the current line, and @kbd{SPC} expands or
587contracts the item. @kbd{U} displays the parent directory of the
588current directory. To copy, delete, or rename the file on the current
589line, type @kbd{C}, @kbd{D}, and @kbd{R} respectively. To create a
590new directory, type @kbd{M}.
591
592 Another general-purpose speedbar mode is @dfn{Buffer Display} mode;
593in this mode, the speedbar displays a list of Emacs buffers. To
594switch to this mode, type @kbd{b} in the speedbar. To return to File
595Display mode, type @kbd{f}. You can also change the display mode by
596clicking @kbd{mouse-3} anywhere in the speedbar window (or
597@kbd{mouse-1} on the mode-line) and selecting @samp{Displays} in the
598pop-up menu.
6bf7aab6
DL
599
600 Some major modes, including Rmail mode, Info, and GUD, have
601specialized ways of putting useful items into the speedbar for you to
602select. For example, in Rmail mode, the speedbar shows a list of Rmail
603files, and lets you move the current message to another Rmail file by
604clicking on its @samp{<M>} box.
605
3b6de082
CY
606 For more details on using and programming the speedbar, @xref{Top,
607Speedbar,,speedbar, Speedbar Manual}.
6bf7aab6
DL
608
609@node Multiple Displays
610@section Multiple Displays
611@cindex multiple displays
612
97878c08
EZ
613 A single Emacs can talk to more than one X display. Initially, Emacs
614uses just one display---the one specified with the @env{DISPLAY}
615environment variable or with the @samp{--display} option (@pxref{Initial
616Options}). To connect to another display, use the command
617@code{make-frame-on-display}:
6bf7aab6
DL
618
619@findex make-frame-on-display
620@table @kbd
621@item M-x make-frame-on-display @key{RET} @var{display} @key{RET}
622Create a new frame on display @var{display}.
623@end table
624
625 A single X server can handle more than one screen. When you open
626frames on two screens belonging to one server, Emacs knows they share a
627single keyboard, and it treats all the commands arriving from these
628screens as a single stream of input.
629
630 When you open frames on different X servers, Emacs makes a separate
631input stream for each server. This way, two users can type
632simultaneously on the two displays, and Emacs will not garble their
633input. Each server also has its own selected frame. The commands you
634enter with a particular X server apply to that server's selected frame.
635
636 Despite these features, people using the same Emacs job from different
637displays can still interfere with each other if they are not careful.
638For example, if any one types @kbd{C-x C-c}, that exits the Emacs job
639for all of them!
640
641@node Special Buffer Frames
642@section Special Buffer Frames
643
644@vindex special-display-buffer-names
9c75b187
RS
645 You can make certain chosen buffers, which Emacs normally displays
646in ``another window,'' appear in special frames of their own. To do
647this, set the variable @code{special-display-buffer-names} to a list
648of buffer names; any buffer whose name is in that list automatically
649gets a special frame, when an Emacs command wants to display it ``in
650another window.''
6bf7aab6
DL
651
652 For example, if you set the variable this way,
653
654@example
655(setq special-display-buffer-names
656 '("*Completions*" "*grep*" "*tex-shell*"))
657@end example
658
659@noindent
660then completion lists, @code{grep} output and the @TeX{} mode shell
661buffer get individual frames of their own. These frames, and the
662windows in them, are never automatically split or reused for any other
663buffers. They continue to show the buffers they were created for,
664unless you alter them by hand. Killing the special buffer deletes its
665frame automatically.
666
667@vindex special-display-regexps
668 More generally, you can set @code{special-display-regexps} to a list
669of regular expressions; then a buffer gets its own frame if its name
670matches any of those regular expressions. (Once again, this applies only
9c75b187 671to buffers that normally get displayed for you in ``another window.'')
6bf7aab6
DL
672
673@vindex special-display-frame-alist
674 The variable @code{special-display-frame-alist} specifies the frame
675parameters for these frames. It has a default value, so you don't need
676to set it.
677
678 For those who know Lisp, an element of
679@code{special-display-buffer-names} or @code{special-display-regexps}
680can also be a list. Then the first element is the buffer name or
681regular expression; the rest of the list specifies how to create the
c84d4f59
RS
682frame. It can be an association list specifying frame parameter
683values; these values take precedence over parameter values specified
684in @code{special-display-frame-alist}. If you specify the symbol
685@code{same-window} as a ``frame parameter'' in this list, with a
686non-@code{nil} value, that means to use the selected window if
687possible. If you use the symbol @code{same-frame} as a ``frame
688parameter'' in this list, with a non-@code{nil} value, that means to
689use the selected frame if possible.
690
691 Alternatively, the value can have this form:
6bf7aab6
DL
692
693@example
694(@var{function} @var{args}...)
695@end example
696
697@noindent
698where @var{function} is a symbol. Then the frame is constructed by
699calling @var{function}; its first argument is the buffer, and its
700remaining arguments are @var{args}.
701
702 An analogous feature lets you specify buffers which should be
703displayed in the selected window. @xref{Force Same Window}. The
704same-window feature takes precedence over the special-frame feature;
705therefore, if you add a buffer name to
706@code{special-display-buffer-names} and it has no effect, check to see
707whether that feature is also in use for the same buffer name.
708
709@node Frame Parameters
710@section Setting Frame Parameters
6bf7aab6
DL
711@cindex Auto-Raise mode
712@cindex Auto-Lower mode
713
9c75b187 714@kindex S-Mouse-1
9c75b187
RS
715 You can specify the font and colors used for text display, and the
716colors for the frame borders, the cursor, and the mouse cursor, by
717customizing the faces @code{default}, @code{border}, @code{cursor} and
718@code{mouse}. @xref{Face Customization}. You can also set a frame's
719default font through a pop-up menu. Press @kbd{S-Mouse-1} to activate
720this menu.
6bf7aab6 721
9c75b187
RS
722 These commands are available for controlling the window management
723behavior of the selected frame.
6bf7aab6 724
9c75b187
RS
725@table @kbd
726@findex auto-raise-mode
6bf7aab6
DL
727@item M-x auto-raise-mode
728Toggle whether or not the selected frame should auto-raise. Auto-raise
729means that every time you move the mouse onto the frame, it raises the
730frame.
731
9c75b187
RS
732Some window managers also implement auto-raise. If you enable
733auto-raise for Emacs frames in your window manager, it will work, but
734it is beyond Emacs' control, so @code{auto-raise-mode} has no effect
735on it.
6bf7aab6 736
9c75b187 737@findex auto-lower-mode
6bf7aab6
DL
738@item M-x auto-lower-mode
739Toggle whether or not the selected frame should auto-lower.
740Auto-lower means that every time you move the mouse off the frame,
9c75b187 741the frame moves to the bottom of the stack on the screen.
6bf7aab6
DL
742
743The command @code{auto-lower-mode} has no effect on auto-lower
9c75b187
RS
744implemented by the window manager. To control that, you must use the
745appropriate window manager features.
6bf7aab6
DL
746@end table
747
748 In Emacs versions that use an X toolkit, the color-setting and
749font-setting functions don't affect menus and the menu bar, since they
750are displayed by their own widget classes. To change the appearance of
186e9bcc 751the menus and menu bar, you must use X resources (@pxref{Resources}).
89c8e752 752@xref{Colors}, regarding colors. @xref{Font X}, regarding choice of
6bf7aab6
DL
753font.
754
eba47cbd
EZ
755 Colors, fonts, and other attributes of the frame's display can also
756be customized by setting frame parameters in the variable
757@code{default-frame-alist} (@pxref{Creating Frames}). For a detailed
758description of frame parameters and customization, see @ref{Frame
6bf7aab6
DL
759Parameters,,, elisp, The Emacs Lisp Reference Manual}.
760
761@node Scroll Bars
762@section Scroll Bars
763@cindex Scroll Bar mode
764@cindex mode, Scroll Bar
765
9c75b187
RS
766 On graphical displays, Emacs normally makes a @dfn{scroll bar} at
767the left of each Emacs window.@footnote{Placing it at the left is
768usually more useful with overlapping frames with text starting at the
769left margin.} The scroll bar runs the height of the window, and shows
770a moving rectangular inner box which represents the portion of the
771buffer currently displayed. The entire height of the scroll bar
772represents the entire length of the buffer.
6bf7aab6
DL
773
774 You can use @kbd{Mouse-2} (normally, the middle button) in the scroll
775bar to move or drag the inner box up and down. If you move it to the
776top of the scroll bar, you see the top of the buffer. If you move it to
777the bottom of the scroll bar, you see the bottom of the buffer.
778
779 The left and right buttons in the scroll bar scroll by controlled
780increments. @kbd{Mouse-1} (normally, the left button) moves the line at
781the level where you click up to the top of the window. @kbd{Mouse-3}
782(normally, the right button) moves the line at the top of the window
783down to the level where you click. By clicking repeatedly in the same
784place, you can scroll by the same distance over and over.
785
779bc800
LT
786 You can also click @kbd{C-Mouse-2} in the scroll bar to split a
787window vertically. The split occurs on the line where you click.
6bf7aab6
DL
788
789@findex scroll-bar-mode
70c88b57 790@vindex scroll-bar-mode
6bf7aab6 791 You can enable or disable Scroll Bar mode with the command @kbd{M-x
9c75b187
RS
792scroll-bar-mode}. With no argument, it toggles the use of scroll
793bars. With an argument, it turns use of scroll bars on if and only if
794the argument is positive. This command applies to all frames,
795including frames yet to be created. Customize the variable
796@code{scroll-bar-mode} to control the use of scroll bars at startup.
797You can use it to specify that they are placed at the right of windows
798if you prefer that. You have to set this variable through the
799@samp{Customize} interface (@pxref{Easy Customization}), or it will
800not work properly.
801
802 You can also use the X resource @samp{verticalScrollBars} to control
803the initial setting of Scroll Bar mode. @xref{Resources}.
6bf7aab6
DL
804
805@findex toggle-scroll-bar
806 To enable or disable scroll bars for just the selected frame, use the
eca274b1 807command @kbd{M-x toggle-scroll-bar}.
6bf7aab6 808
839736d5
EZ
809@vindex scroll-bar-width
810@cindex width of the scroll bar
811 You can control the scroll bar width by changing the value of the
812@code{scroll-bar-width} frame parameter.
813
70c88b57 814@node Wheeled Mice
099bfef9
RS
815@section Scrolling With ``Wheeled'' Mice
816
817@cindex mouse wheel
1b122be2
DL
818@cindex wheel, mouse
819@findex mouse-wheel-mode
820@cindex Mouse Wheel minor mode
821@cindex mode, Mouse Wheel
822 Some mice have a ``wheel'' instead of a third button. You can
823usually click the wheel to act as either @kbd{Mouse-2} or
824@kbd{Mouse-3}, depending on the setup. You can also use the wheel to
099bfef9 825scroll windows instead of using the scroll bar or keyboard commands.
b50352ec
RS
826Mouse wheel support only works if the system generates appropriate
827events; whenever possible, it is turned on by default. To toggle this
828feature, use @kbd{M-x mouse-wheel-mode}.
c08e161b
MB
829
830@vindex mouse-wheel-follow-mouse
831@vindex mouse-wheel-scroll-amount
b50352ec 832@vindex mouse-wheel-progressive-speed
099bfef9 833 The variables @code{mouse-wheel-follow-mouse} and
c08e161b 834@code{mouse-wheel-scroll-amount} determine where and by how much
b50352ec 835buffers are scrolled. The variable
d9cb626b 836@code{mouse-wheel-progressive-speed} determines whether the scroll
b50352ec 837speed is linked to how fast you move the wheel.
70c88b57 838
511002e9
RS
839@node Drag and Drop
840@section Drag and Drop
54900736 841@cindex drag and drop
54900736 842
cc9355ea
LK
843 Emacs supports @dfn{drag and drop} using the mouse. For instance,
844dropping text onto an Emacs frame inserts the text where it is dropped.
845Dropping a file onto an Emacs frame visits that file. As a special
846case, dropping the file on a Dired buffer moves or copies the file
847(according to the conventions of the application it came from) into the
848directory displayed in that buffer.
511002e9 849
9a49a36b 850@vindex dnd-open-file-other-window
511002e9
RS
851 Dropping a file normally visits it in the window you drop it on. If
852you prefer to visit the file in a new window in such cases, customize
9a49a36b 853the variable @code{dnd-open-file-other-window}.
511002e9 854
9c75b187
RS
855 The XDND and Motif drag and drop protocols, and the old KDE 1.x
856protocol, are currently supported.
54900736 857
6bf7aab6
DL
858@node Menu Bars
859@section Menu Bars
860@cindex Menu Bar mode
861@cindex mode, Menu Bar
862
863 You can turn display of menu bars on or off with @kbd{M-x
19b2c4ca 864menu-bar-mode} or by customizing the variable @code{menu-bar-mode}.
2beab0db 865With no argument, this command toggles Menu Bar mode, a
6bf7aab6
DL
866minor mode. With an argument, the command turns Menu Bar mode on if the
867argument is positive, off if the argument is not positive. You can use
868the X resource @samp{menuBarLines} to control the initial setting of
186e9bcc 869Menu Bar mode. @xref{Resources}.
2beab0db 870
099bfef9
RS
871@kindex C-Mouse-3 @r{(when menu bar is disabled)}
872 Expert users often turn off the menu bar, especially on text-only
873terminals, where this makes one additional line available for text.
874If the menu bar is off, you can still pop up a menu of its contents
47d7776c 875with @kbd{C-Mouse-3} on a display which supports pop-up menus.
099bfef9 876@xref{Menu Mouse Clicks}.
6bf7aab6
DL
877
878 @xref{Menu Bar}, for information on how to invoke commands with the
27c4f6c0 879menu bar. @xref{X Resources}, for how to customize the menu bar
9c75b187 880menus' visual appearance.
6bf7aab6 881
2beab0db
DL
882@node Tool Bars
883@section Tool Bars
884@cindex Tool Bar mode
885@cindex mode, Tool Bar
7114be0e 886@cindex icons, toolbar
2beab0db 887
511002e9
RS
888 The @dfn{tool bar} is a line (or lines) of icons at the top of the
889Emacs window, just below the menu bar. You can click on these icons
890with the mouse to do various jobs.
099bfef9 891
511002e9 892 The global tool bar contains general commands. Some major modes
099bfef9
RS
893define their own tool bars to replace it. A few ``special'' modes
894that are not designed for ordinary editing remove some items from the
895global tool bar.
943a8bb7 896
511002e9 897 Tool bars work only on a graphical display. The tool bar uses colored
84be61d6
DL
898XPM icons if Emacs was built with XPM support. Otherwise, the tool
899bar uses monochrome icons (PBM or XBM format).
099bfef9 900
511002e9 901 You can turn display of tool bars on or off with @kbd{M-x
d78e9711 902tool-bar-mode} or by customizing the option @code{tool-bar-mode}.
70c88b57
DL
903
904@node Dialog Boxes
905@section Using Dialog Boxes
906@cindex dialog boxes
907
908@vindex use-dialog-box
099bfef9
RS
909 A dialog box is a special kind of menu for asking you a yes-or-no
910question or some other special question. Many Emacs commands use a
911dialog box to ask a yes-or-no question, if you used the mouse to
912invoke the command to begin with.
913
19b2c4ca 914 You can customize the variable @code{use-dialog-box} to suppress the
099bfef9
RS
915use of dialog boxes. This also controls whether to use file selection
916windows (but those are not supported on all platforms).
70c88b57 917
1394f7f5 918@vindex use-file-dialog
9c75b187
RS
919 A file selection window is a special kind of dialog box for asking
920for file names. You can customize the variable @code{use-file-dialog}
921to suppress the use of file selection windows, even if you still want
922other kinds of dialogs. This variable has no effect if you have
923suppressed all dialog boxes with the variable @code{use-dialog-box}.
1394f7f5 924
9c75b187
RS
925@vindex x-gtk-show-hidden-files
926 For Gtk+ version 2.4 and newer, Emacs use the Gtk+ file chooser
927dialog. Emacs adds a toggle button that enables and disables showing
928of hidden files (files starting with a dot) in that dialog. The
929variable @code{x-gtk-show-hidden-files} controls whether to show
930hidden files by default.
1394f7f5 931
3a0ab7ec 932@vindex x-use-old-gtk-file-dialog
e7c55f23 933 For Gtk+ version 2.4 and 2.6, you can make Emacs use the old file dialog
3a0ab7ec 934by setting the variable @code{x-use-old-gtk-file-dialog} to a non-@code{nil}
49e6099b 935value. If Emacs is built with a Gtk+ version that has only one file dialog,
4f0d76fb 936the setting of this variable has no effect.
1394f7f5 937
70c88b57 938@node Tooltips
6f58eede 939@section Tooltips
aac19cea 940@cindex tooltips
70c88b57 941
aac19cea 942 @dfn{Tooltips} are small windows that display text information at the
6f58eede 943current mouse position. They activate when there is a pause in mouse
aac19cea
RS
944movement. There are two types of tooltip: help tooltips and GUD
945tooltips.
6f58eede 946
aac19cea 947 @dfn{Help tooltips} typically display over text---including the mode
9c75b187
RS
948line---but are also available for other parts of the Emacs frame, such
949as the tool bar and menu items.
d9701e91 950
099bfef9 951@findex tooltip-mode
9c75b187
RS
952 You can toggle display of help tooltips (Tooltip mode) with the
953command @kbd{M-x tooltip-mode}. When Tooltip mode is disabled, the
954help text is displayed in the echo area instead.
6f58eede 955
aac19cea
RS
956 @dfn{GUD tooltips} show values of variables. They are useful when
957you are debugging a program. @xref{Debugger Operation}.
70c88b57 958
c84d4f59
RS
959@vindex tooltip-delay
960 The variables @code{tooltip-delay} specifies how long Emacs should
961wait before displaying a tooltip. For additional customization
962options for displaying tooltips, use @kbd{M-x customize-group
963@key{RET} tooltip @key{RET}}. @xref{X Resources}, for information on
964customizing the windows that display tooltips.
9638f5c2 965
43391ff3
DL
966@node Mouse Avoidance
967@section Mouse Avoidance
099bfef9
RS
968@cindex avoiding mouse in the way of your typing
969@cindex mouse avoidance
43391ff3 970
099bfef9 971@vindex mouse-avoidance-mode
f97b3732
RS
972Mouse Avoidance mode keeps the mouse pointer away from point, to avoid
973obscuring text you want to edit. Whenever it moves the mouse, it also
19b2c4ca 974raises the frame. To use Mouse Avoidance mode, customize the variable
099bfef9
RS
975@code{mouse-avoidance-mode}. You can set this to various values to
976move the mouse in several ways:
43391ff3
DL
977
978@table @code
979@item banish
47d7776c 980Move the mouse to the upper-right corner on any key-press;
43391ff3
DL
981@item exile
982Move the mouse to the corner only if the cursor gets too close,
983and allow it to return once the cursor is out of the way;
984@item jump
985If the cursor gets too close to the mouse, displace the mouse
986a random distance & direction;
987@item animate
988As @code{jump}, but shows steps along the way for illusion of motion;
989@item cat-and-mouse
990The same as @code{animate};
991@item proteus
992As @code{animate}, but changes the shape of the mouse pointer too.
993@end table
994
099bfef9
RS
995@findex mouse-avoidance-mode
996You can also use the command @kbd{M-x mouse-avoidance-mode} to enable
43391ff3 997the mode.
70c88b57 998
6bf7aab6
DL
999@node Non-Window Terminals
1000@section Non-Window Terminals
1001@cindex non-window terminals
1002@cindex single-frame terminals
1003
9c75b187
RS
1004 On a text-only terminal, Emacs can display only one Emacs frame at a
1005time. However, you can still create multiple Emacs frames, and switch
1006between them. Switching frames on these terminals is much like
1007switching between different window configurations.
6bf7aab6
DL
1008
1009 Use @kbd{C-x 5 2} to create a new frame and switch to it; use @kbd{C-x
10105 o} to cycle through the existing frames; use @kbd{C-x 5 0} to delete
1011the current frame.
1012
1013 Each frame has a number to distinguish it. If your terminal can
1014display only one frame at a time, the selected frame's number @var{n}
1015appears near the beginning of the mode line, in the form
1016@samp{F@var{n}}.
1017
1018@findex set-frame-name
1019@findex select-frame-by-name
9c75b187
RS
1020 @samp{F@var{n}} is in fact the frame's initial name. You can give
1021frames more meaningful names if you wish, and you can select a frame
1022by its name. Use the command @kbd{M-x set-frame-name @key{RET}
1023@var{name} @key{RET}} to specify a new name for the selected frame,
1024and use @kbd{M-x select-frame-by-name @key{RET} @var{name} @key{RET}}
1025to select a frame according to its name. The name you specify appears
1026in the mode line when the frame is selected.
6bf7aab6 1027
70c88b57
DL
1028@node XTerm Mouse
1029@section Using a Mouse in Terminal Emulators
43391ff3
DL
1030@cindex xterm, mouse support
1031@cindex terminal emulators, mouse support
70c88b57 1032
9c75b187 1033 Some terminal emulators under X support mouse clicks in the terminal
70c88b57 1034window. In a terminal emulator which is compatible with @code{xterm},
6a9526ba
LT
1035you can use @kbd{M-x xterm-mouse-mode} to give Emacs control over
1036simple use of the mouse---basically, only non-modified single clicks
1037are supported. The normal @code{xterm} mouse functionality for such
1038clicks is still available by holding down the @kbd{SHIFT} key when you
1039press the mouse button.
1040
d4127a9a 1041 Xterm Mouse mode is a global minor mode (@pxref{Minor Modes}).
6a9526ba 1042Repeating the command turns the mode off again.
ab5796a9
MB
1043
1044@ignore
1045 arch-tag: 7dcf3a31-a43b-45d4-a900-445b10d77e49
1046@end ignore