* README: Add a note about ranges in copyright years.
[bpt/emacs.git] / doc / emacs / frames.texi
CommitLineData
8cf51b2c
GM
1@c This is part of the Emacs manual.
2@c Copyright (C) 1985, 1986, 1987, 1993, 1994, 1995, 1997, 1999, 2000,
5df4f04c 3@c 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011
8838673e 4@c Free Software Foundation, Inc.
8cf51b2c
GM
5@c See file emacs.texi for copying conditions.
6@node Frames, International, Windows, Top
7@chapter Frames and Graphical Displays
8@cindex frames
9
2aee6012
CY
10 When using a graphical display, you can create multiple system-level
11``windows'' in a single Emacs session. We refer to these system-level
12windows as @dfn{frames}. A frame initially contains a single Emacs
13window; however, you can subdivide this Emacs window into smaller
14windows, all fitting into the same frame. Each frame normally
15contains its own echo area and minibuffer.
8cf51b2c
GM
16
17 To avoid confusion, we reserve the word ``window'' for the
18subdivisions that Emacs implements, and never use it to refer to a
19frame.
20
2aee6012
CY
21 Any editing you do in one frame affects the other frames. For
22instance, if you put text in the kill ring in one frame, you can yank
23it in another frame. If you exit Emacs through @kbd{C-x C-c} in one
24frame, it terminates all the frames. To delete just one frame, use
25@kbd{C-x 5 0} (that is zero, not @kbd{o}).
8cf51b2c
GM
26
27 Emacs compiled for MS-DOS emulates some windowing functionality,
28so that you can use many of the features described in this chapter.
29@iftex
30@xref{MS-DOS Mouse,,,emacs-xtra,Specialized Emacs Features}.
31@end iftex
32@ifnottex
33@xref{MS-DOS Mouse}.
34@end ifnottex
35
36@menu
37* Cut and Paste:: Mouse commands for cut and paste.
38* Mouse References:: Using the mouse to select an item from a list.
39* Menu Mouse Clicks:: Mouse clicks that bring up menus.
40* Mode Line Mouse:: Mouse clicks on the mode line.
41* Creating Frames:: Creating additional Emacs frames with various contents.
42* Frame Commands:: Iconifying, deleting, and switching frames.
d68eb23c 43* Fonts:: Changing the frame font.
8cf51b2c
GM
44* Speedbar:: How to make and use a speedbar frame.
45* Multiple Displays:: How one Emacs job can talk to several displays.
46* Special Buffer Frames:: You can make certain buffers have their own frames.
47* Frame Parameters:: Changing the colors and other modes of frames.
8838673e 48* Scroll Bars:: How to enable and disable scroll bars; how to use them.
8cf51b2c
GM
49* Wheeled Mice:: Using mouse wheels for scrolling.
50* Drag and Drop:: Using drag and drop to open files and insert text.
8838673e 51* Menu Bars:: Enabling and disabling the menu bar.
8cf51b2c
GM
52* Tool Bars:: Enabling and disabling the tool bar.
53* Dialog Boxes:: Controlling use of dialog boxes.
54* Tooltips:: Displaying information at the current mouse position.
b4a1a8b2 55* Mouse Avoidance:: Preventing the mouse pointer from obscuring text.
8cf51b2c
GM
56* Non-Window Terminals:: Multiple frames on terminals that show only one.
57* Text-Only Mouse:: Using the mouse in text-only terminals.
58@end menu
59
60@node Cut and Paste
2d34d523 61@section Cutting and Pasting on Graphical Displays
8cf51b2c 62
2d34d523
EZ
63 This section describes commands for selecting a region, cutting, and
64pasting using the mouse.
8cf51b2c
GM
65
66@menu
67* Mouse Commands:: Moving, cutting, and pasting, with the mouse.
8cf51b2c 68* Word and Line Mouse:: Mouse commands for selecting whole words or lines.
2aee6012 69* Cut/Paste Other App:: Transfering text between Emacs and other apps.
8cf51b2c
GM
70* Secondary Selection:: Cutting without altering point and mark.
71* Clipboard:: Using the clipboard for selections.
72@end menu
73
74@node Mouse Commands
75@subsection Mouse Commands for Editing
76@cindex mouse buttons (what they do)
77
8cf51b2c
GM
78@kindex Mouse-1
79@kindex Mouse-2
80@kindex Mouse-3
dc103cdc 81@table @kbd
8cf51b2c
GM
82@item Mouse-1
83Move point to where you click (@code{mouse-set-point}).
2aee6012
CY
84
85@item Drag-Mouse-1
86Activate the region around the text selected by dragging, and copy it
87to the kill ring (@code{mouse-set-region}).
88
89@item Mouse-2
90Yank the last killed text at the click position
91(@code{mouse-yank-at-click}).
92
93@item Mouse-3
94If the region is active, move the nearer end of the region to the
95click position; otherwise, set mark at the current value of point and
96point at the click position. Save the resulting region in the kill
97ring; on a second click, kill it (@code{mouse-save-then-kill}).
98@end table
99
100@findex mouse-set-point
101 The most basic mouse command is @code{mouse-set-point}, which is
dc103cdc 102called by clicking with the left mouse button, @kbd{Mouse-1}, in the
2aee6012
CY
103text area of a window. This moves point to the position where you
104clicked.
8cf51b2c
GM
105
106@vindex x-mouse-click-focus-ignore-position
2aee6012
CY
107 Normally, Emacs does not distinguish between ordinary mouse clicks
108and clicks that select a frame. When you click on a frame to select
109it, that also changes the selected window and cursor position
110according to the mouse click position. On the X window system, you
111can change this behavior by setting the variable
8cf51b2c
GM
112@code{x-mouse-click-focus-ignore-position} to @code{t}. Then the
113first click selects the frame, but does not affect the selected window
2aee6012
CY
114or cursor position. If you click again in the same place, that click
115will be in the selected frame, so it will change the window or cursor
116position.
8cf51b2c 117
2aee6012
CY
118@findex mouse-set-region
119@vindex mouse-drag-copy-region
dc103cdc 120 Holding down @kbd{Mouse-1} and ``dragging'' the mouse over a stretch
2aee6012
CY
121of text activates the region around that text
122(@code{mouse-set-region}). @xref{Mark}. Emacs places the mark where
123you started holding down the mouse button, and point where you release
124it. In addition, the region is copied into the kill ring (@pxref{Kill
125Ring}). If you don't want Emacs to copy the region, change the
126variable @code{mouse-drag-copy-region} to @code{nil}.
8cf51b2c
GM
127
128@vindex mouse-scroll-min-lines
2aee6012 129 If you move the mouse off the top or bottom of the window while
8cf51b2c
GM
130dragging, the window scrolls at a steady rate until you move the mouse
131back into the window. This way, you can select regions that don't fit
132entirely on the screen. The number of lines scrolled per step depends
133on how far away from the window edge the mouse has gone; the variable
134@code{mouse-scroll-min-lines} specifies a minimum step size.
135
2aee6012 136@findex mouse-yank-at-click
8cf51b2c 137@vindex mouse-yank-at-point
dc103cdc 138 Clicking with the middle mouse button, @kbd{Mouse-2}, moves point to
2aee6012
CY
139the position where you clicked and performs a yank
140(@code{mouse-yank-at-click}). @xref{Yanking}. If you change the
141variable @code{mouse-yank-at-point} to a non-@code{nil} value,
142@kbd{Mouse-2} does not move point. Then it does not matter where you
143click, or even which of the frame's windows you click on; the yank
144occurs at the existing point. This variable also affects yanking the
145primary and secondary selections (@pxref{Cut/Paste Other App}).
146
147@findex mouse-save-then-kill
dc103cdc 148 Clicking with the right mouse button, @kbd{Mouse-3}, runs the
2aee6012
CY
149command @code{mouse-save-then-kill}. This performs several actions
150depending on where you click and the status of the region:
151
152@itemize @bullet
153@item
dc103cdc 154If no region is active, clicking @kbd{Mouse-3} activates the region,
2aee6012
CY
155placing the mark where point was and point at the clicked position.
156In addition, the text in the region is copied to the kill ring.
157
158@item
dc103cdc 159If a region is active, clicking @kbd{Mouse-3} adjusts the nearer end
2aee6012
CY
160of the region by moving it to the clicked position. The adjusted
161region's text is copied to the kill ring; if the text in the original
162region was already on the kill ring, it replaces it there.
163
164@item
165If you originally specified the region using a double or triple
dc103cdc
CY
166@kbd{Mouse-1}, so that the region is defined to consist of entire
167words or lines, then adjusting the region with @kbd{Mouse-3} also
2aee6012
CY
168proceeds by entire words or lines.
169
170@item
dc103cdc 171If you use @kbd{Mouse-3} a second time consecutively, at the same
2aee6012 172place, that kills the region already selected. Thus, the simplest way
dc103cdc
CY
173to kill text with the mouse is to click @kbd{Mouse-1} at one end, then
174click @kbd{Mouse-3} twice at the other end. To copy the text into the
175kill ring without deleting it from the buffer, press @kbd{Mouse-3}
176just once---or just drag across the text with @kbd{Mouse-1}. Then you
2aee6012
CY
177can copy it elsewhere by yanking it.
178@end itemize
179
180 Whenever you set the region using any of the mouse commands
181described above, the mark will be deactivated by any subsequent
182unshifted cursor motion command, in addition to the usual ways of
183deactivating the mark. @xref{Shift Selection}. While the region
184remains active, typing @key{Backspace} or @key{Delete} deletes the
185text in that region and deactivates the mark; this behavior follows a
186convention established by other graphical programs, and it does
187@emph{not} apply when you set the region any other way, including
188shift-selection (@pxref{Shift Selection}).
8cf51b2c
GM
189
190@cindex Delete Selection mode
191@cindex mode, Delete Selection
192@findex delete-selection-mode
2aee6012
CY
193 Many graphical applications also follow the convention that
194insertion while text is selected deletes the selected text. You can
345fc770
CY
195make Emacs behave this way by enabling Delete Selection mode.
196@xref{Using Region}.
8cf51b2c
GM
197
198@node Word and Line Mouse
199@subsection Mouse Commands for Words and Lines
200
2aee6012
CY
201 These variants of @kbd{Mouse-1} select entire words or lines at a
202time. Emacs activates the region around the selected text, which is
203also copied to the kill ring.
8cf51b2c 204
dc103cdc 205@table @kbd
8cf51b2c 206@item Double-Mouse-1
2aee6012 207Select the text around the word which you click on.
8cf51b2c 208
2aee6012
CY
209Double-clicking on a character with ``symbol'' syntax (such as
210underscore, in C mode) selects the symbol surrounding that character.
211Double-clicking on a character with open- or close-parenthesis syntax
212selects the parenthetical grouping which that character starts or
213ends. Double-clicking on a character with string-delimiter syntax
214(such as a singlequote or doublequote in C) selects the string
215constant (Emacs uses heuristics to figure out whether that character
216is the beginning or the end of it).
8cf51b2c
GM
217
218@item Double-Drag-Mouse-1
2aee6012 219Select the text you drag across, in the form of whole words.
8cf51b2c
GM
220
221@item Triple-Mouse-1
2aee6012 222Select the line you click on.
8cf51b2c
GM
223
224@item Triple-Drag-Mouse-1
2aee6012 225Select the text you drag across, in the form of whole lines.
8cf51b2c
GM
226@end table
227
2aee6012
CY
228@node Cut/Paste Other App
229@subsection Cut and Paste with Other Window Applications
230
231@cindex X cutting and pasting
232@cindex X selection
233@cindex primary selection
234@cindex selection, primary
e9f5524e
CY
235 When running Emacs under the X window system, you can easily
236transfer text between Emacs and other X applications using the
237@dfn{primary selection} (also called the @dfn{X selection}). This is
238@emph{not} the same thing as the @dfn{clipboard}, which is a separate
239facility used on desktop environments such as Gnome, and on operating
240systems such as Microsoft Windows (@pxref{Clipboard}).
2aee6012
CY
241
242 Under X, whenever you select some text in Emacs by dragging or
243clicking the mouse (@pxref{Mouse Commands}), it is also saved in the
244primary selection. You can then @dfn{paste} that text into any other
dc103cdc 245X application, usually by clicking @kbd{Mouse-2} in that application.
2aee6012
CY
246Unlike the Emacs kill ring (@pxref{Kill Ring}), the primary selection
247has no ``memory'': each time you save something in the primary
248selection, either in Emacs or in another X application, the previous
249contents of the primary selection are lost.
250
2d34d523
EZ
251@cindex MS-Windows, and primary selection
252 MS-Windows provides no primary selection, but Emacs emulates it
58bdfa4c
EZ
253within a single Emacs session, by storing the selected text
254internally. Therefore, all the features and commands related to the
255primary selection work on Windows as they do on X, for cutting and
256pasting within the same session, but not across Emacs sessions or with
257other applications.
2d34d523 258
2aee6012
CY
259 Whenever you kill some text using a command such as @kbd{C-w}
260(@code{kill-region}), or copy it into the kill ring using a command
261such as @kbd{M-w} (@code{kill-ring-save}), that text is also saved in
262the primary selection. @xref{Killing}.
263
e9f5524e 264@vindex select-active-regions
91ed7ea8
CY
265 If you set the region using the keyboard---for instance, by typing
266@kbd{C-@key{SPC}} and moving point away from the mark---the text in
267the region is not normally saved to the primary selection. However,
268if you change the variable @code{select-active-regions} to @code{t},
269the region is saved to the primary selection whenever you activate the
270mark. Each change to the region also updates the primary selection.
271
e9f5524e 272@vindex yank-pop-change-selection
91ed7ea8
CY
273 If you change @code{yank-pop-change-selection} to @code{t}, rotating
274the kill ring with @kbd{M-y} (@code{yank-pop}) also saves the new yank
275to the primary selection (@pxref{Yanking}).
276
277@vindex save-interprogram-paste-before-kill
278 If you change @code{save-interprogram-paste-before-kill} to
279@code{t}, each kill command first saves the existing selection onto
280the kill ring. This prevents you from losing the existing selection,
281at the risk of large memory consumption if other applications generate
282large selections.
2aee6012 283
2aee6012 284 You can yank the primary selection into Emacs using the usual yank
dc103cdc 285commands, such as @kbd{C-y} (@code{yank}) and @kbd{Mouse-2}
2aee6012
CY
286(@code{mouse-yank-at-click}). These commands actually check the
287primary selection before referring to the kill ring; if no primary
288selection is available, the kill ring contents are used. To prevent
289yank commands from accessing the primary selection, set the variable
290@code{x-select-enable-primary} to @code{nil}.
291
292 The standard coding system for the primary selection is
293@code{compound-text-with-extensions}. You may find that the pasted
294text is not what you expected. In such a case, you can specify
295another coding system for the selection by typing @kbd{C-x @key{RET}
296x} or @kbd{C-x @key{RET} X}. Alternatively, you can request a
297different data type by modifying the variable
298@code{x-select-request-type}. @xref{Communication Coding}.
299
8cf51b2c
GM
300@node Secondary Selection
301@subsection Secondary Selection
302@cindex secondary selection
303
e9f5524e
CY
304 In addition to the primary selection, the X Window System provides a
305second similar facility known as the @dfn{secondary selection}.
306Nowadays, few X applications make use of the secondary selection, but
307you can access it using the following Emacs commands:
8cf51b2c 308
dc103cdc 309@table @kbd
8cf51b2c
GM
310@findex mouse-set-secondary
311@kindex M-Drag-Mouse-1
4fc2e5bf 312@item M-Drag-Mouse-1
8cf51b2c
GM
313Set the secondary selection, with one end at the place where you press
314down the button, and the other end at the place where you release it
e9f5524e
CY
315(@code{mouse-set-secondary}). The selected text is highlighted, using
316the @code{secondary-selection} face, as you drag. The window scrolls
317automatically if you drag the mouse off the top or bottom of the
318window, just like @code{mouse-set-region} (@pxref{Mouse Commands}).
8cf51b2c 319
e9f5524e 320This command does not alter the kill ring.
8cf51b2c
GM
321
322@findex mouse-start-secondary
323@kindex M-Mouse-1
4fc2e5bf 324@item M-Mouse-1
8cf51b2c
GM
325Set one endpoint for the @dfn{secondary selection}
326(@code{mouse-start-secondary}).
327
328@findex mouse-secondary-save-then-kill
329@kindex M-Mouse-3
4fc2e5bf 330@item M-Mouse-3
e9f5524e
CY
331Set the secondary selection, with one end at the position clicked and
332the other at the position specified with @kbd{M-Mouse-1}
333(@code{mouse-secondary-save-then-kill}). This also puts the selected
dc103cdc
CY
334text in the kill ring. A second @kbd{M-Mouse-3} at the same place
335kills the secondary selection just made.
8cf51b2c
GM
336
337@findex mouse-yank-secondary
338@kindex M-Mouse-2
4fc2e5bf 339@item M-Mouse-2
e9f5524e
CY
340Insert the secondary selection where you click, placing point at the
341end of the yanked text (@code{mouse-yank-secondary}).
8cf51b2c
GM
342@end table
343
dc103cdc
CY
344Double or triple clicking of @kbd{M-Mouse-1} operates on words and
345lines, much like @kbd{Mouse-1}.
8cf51b2c 346
dc103cdc 347If @code{mouse-yank-at-point} is non-@code{nil}, @kbd{M-Mouse-2} yanks
4fc2e5bf
CY
348at point. Then it does not matter precisely where you click, or even
349which of the frame's windows you click on. @xref{Mouse Commands}.
8cf51b2c
GM
350
351@node Clipboard
352@subsection Using the Clipboard
353@cindex clipboard
8cf51b2c 354
e9f5524e
CY
355 In desktop environments such as Gnome, and operating systems such as
356Microsoft Windows and Mac OS X, you can transfer data (usually text)
357between different applications using the @dfn{clipboard}. The
358clipboard is distinct from the primary selection and secondary
359selection discussed earlier. You can access the clipboard through the
360@samp{Edit} menu of the menu bar (@pxref{Menu Bar}).
8cf51b2c 361
e9f5524e
CY
362@cindex cut
363@findex clipboard-kill-region
364 The command @code{clipboard-kill-region}, which is bound to the
365@code{Cut} menu item, kills the region and saves it in the clipboard.
8cf51b2c 366
e9f5524e
CY
367@cindex copy
368@findex clipboard-kill-ring-save
369 The command @code{clipboard-kill-ring-save}, which is bound to the
370@code{Copy} menu item, copies the region to the kill ring and saves it
371in the clipboard.
372
edabb440 373@findex clipboard-yank
e9f5524e
CY
374@cindex paste
375 The @code{Paste} menu item in the Edit menu yanks the contents of
edabb440 376the clipboard at point (@code{clipboard-yank}).
e9f5524e
CY
377
378@vindex x-select-enable-clipboard
379 You can customize the variable @code{x-select-enable-clipboard} to
380make the Emacs yank functions consult the clipboard before the primary
8cf51b2c 381selection, and to make the kill functions to store in the clipboard as
e9f5524e
CY
382well as the primary selection. Otherwise, these commands do not
383access the clipboard at all. Using the clipboard is the default on
384MS-Windows and Mac OS, but not on other systems.
8cf51b2c
GM
385
386@node Mouse References
387@section Following References with the Mouse
388@kindex Mouse-1 @r{(selection)}
389@kindex Mouse-2 @r{(selection)}
390
4fc2e5bf 391@vindex mouse-highlight
713c75b0
CY
392 Some Emacs buffers include @dfn{buttons}. A button is a piece of
393text that performs some action when you activate it, such as following
394a reference. Usually, a button's text is visually highlighted: it is
395underlined, or a box is drawn around it. If you move the mouse over a
396button, the shape of the mouse cursor changes and the button lights up
397(if you change the variable @code{mouse-highlight} to @code{nil},
398Emacs disables this highlighting).
4fc2e5bf
CY
399
400 You can activate a button by moving point to it and typing
401@key{RET}, or by clicking either @kbd{Mouse-1} or @kbd{Mouse-2} on the
402button. For example, typing @key{RET} or clicking on a file name in a
403Dired buffer visits that file (@pxref{Dired}). Doing it on an error
404message in the @samp{*Compilation*} buffer goes to the source code for
405that error message (@pxref{Compilation}). Doing it on a completion in
406the @samp{*Completions*} buffer chooses that completion
407(@pxref{Completion}).
408
dc103cdc 409 Although clicking @kbd{Mouse-1} on a button usually activates that
4fc2e5bf
CY
410button, if you hold the mouse button down for a short period of time
411before releasing it (specifically, for more than 450 milliseconds),
412then Emacs moves point where you clicked instead. This behavior
413allows you to use the mouse to move point over a button without
713c75b0
CY
414following it. Dragging---moving the mouse while it is held down---has
415its usual behavior of setting the region, even if you drag from or
416onto a button.
8cf51b2c
GM
417
418@vindex mouse-1-click-in-non-selected-windows
dc103cdc 419 Normally, clicking @kbd{Mouse-1} on a button activates the button
713c75b0 420even if it is in a nonselected window. If you change the variable
4fc2e5bf 421@code{mouse-1-click-in-non-selected-windows} to @code{nil}, clicking
dc103cdc 422@kbd{Mouse-1} on a button in an un-selected window moves point to the
4fc2e5bf
CY
423clicked position and selects that window, without activating the
424button.
8cf51b2c
GM
425
426@vindex mouse-1-click-follows-link
4fc2e5bf
CY
427 In Emacs versions before 22, only @kbd{Mouse-2} activates buttons
428and @kbd{Mouse-1} always sets point. If you prefer this older
429behavior, set the variable @code{mouse-1-click-follows-link} to
430@code{nil}. This variable also lets you choose various other
431alternatives for following links with the mouse. Type @kbd{C-h v
8cf51b2c
GM
432mouse-1-click-follows-link @key{RET}} for more details.
433
434@node Menu Mouse Clicks
435@section Mouse Clicks for Menus
436
437 Several mouse clicks with the @key{CTRL} and @key{SHIFT} modifiers
438bring up menus.
439
dc103cdc 440@table @kbd
8cf51b2c
GM
441@item C-Mouse-1
442@kindex C-Mouse-1
443This menu is for selecting a buffer.
444
445The MSB (``mouse select buffer'') global minor mode makes this
446menu smarter and more customizable. @xref{Buffer Menus}.
447
448@item C-Mouse-2
449@kindex C-Mouse-2
450This menu is for specifying faces and other text properties
451for editing formatted text. @xref{Formatted Text}.
452
453@item C-Mouse-3
454@kindex C-Mouse-3
455This menu is mode-specific. For most modes if Menu-bar mode is on,
456this menu has the same items as all the mode-specific menu-bar menus
457put together. Some modes may specify a different menu for this
458button.@footnote{Some systems use @kbd{Mouse-3} for a mode-specific
459menu. We took a survey of users, and found they preferred to keep
460@kbd{Mouse-3} for selecting and killing regions. Hence the decision
461to use @kbd{C-Mouse-3} for this menu. To use @kbd{Mouse-3} instead,
462do @code{(global-set-key [mouse-3] 'mouse-popup-menubar-stuff)}.} If
463Menu-bar mode is off, this menu contains all the items which would be
464present in the menu bar---not just the mode-specific ones---so that
465you can access them without having to display the menu bar.
466
467@item S-Mouse-1
4fc2e5bf
CY
468This menu is for changing the default face within the window's buffer.
469@xref{Temporary Face Changes}.
8cf51b2c
GM
470@end table
471
472@node Mode Line Mouse
473@section Mode Line Mouse Commands
474@cindex mode line, mouse
475@cindex mouse on mode line
476
477 You can use mouse clicks on window mode lines to select and manipulate
478windows.
479
7b6be833
GM
480 Some areas of the mode line, such as the buffer name, and major and minor
481mode names, have their own special mouse bindings. These areas are
8cf51b2c
GM
482highlighted when you hold the mouse over them, and information about
483the special bindings will be displayed (@pxref{Tooltips}). This
484section's commands do not apply in those areas.
485
486@table @kbd
487@item Mouse-1
488@kindex Mouse-1 @r{(mode line)}
489@kbd{Mouse-1} on a mode line selects the window it belongs to. By
490dragging @kbd{Mouse-1} on the mode line, you can move it, thus
491changing the height of the windows above and below. Changing heights
492with the mouse in this way never deletes windows, it just refuses to
493make any window smaller than the minimum height.
494
495@item Mouse-2
496@kindex Mouse-2 @r{(mode line)}
497@kbd{Mouse-2} on a mode line expands that window to fill its frame.
498
499@item Mouse-3
500@kindex Mouse-3 @r{(mode line)}
501@kbd{Mouse-3} on a mode line deletes the window it belongs to. If the
502frame has only one window, it buries the current buffer instead, and
503switches to another buffer.
504
505@item C-Mouse-2
506@kindex C-mouse-2 @r{(mode line)}
507@kbd{C-Mouse-2} on a mode line splits the window above
508horizontally, above the place in the mode line where you click.
509@end table
510
511@kindex C-Mouse-2 @r{(scroll bar)}
512@kindex Mouse-1 @r{(scroll bar)}
513 Using @kbd{Mouse-1} on the divider between two side-by-side mode
514lines, you can move the vertical boundary left or right. Using
515@kbd{C-Mouse-2} on a scroll bar splits the corresponding window
516vertically. @xref{Split Window}.
517
518@node Creating Frames
519@section Creating Frames
520@cindex creating frames
521
522@kindex C-x 5
db37d8fc
CY
523 The prefix key @kbd{C-x 5} is analogous to @kbd{C-x 4}, with
524parallel subcommands. The difference is that @kbd{C-x 5} commands
525create a new frame rather than just a new window in the selected frame
526(@pxref{Pop Up Window}). If an existing visible or iconified
527(``minimized'') frame already displays the requested material, these
528commands use the existing frame, after raising or deiconifying
529(``un-minimizing'') as necessary.
8cf51b2c
GM
530
531 The various @kbd{C-x 5} commands differ in how they find or create the
532buffer to select:
533
534@table @kbd
535@item C-x 5 2
536@kindex C-x 5 2
537@findex make-frame-command
538Create a new frame (@code{make-frame-command}).
539@item C-x 5 b @var{bufname} @key{RET}
540Select buffer @var{bufname} in another frame. This runs
541@code{switch-to-buffer-other-frame}.
542@item C-x 5 f @var{filename} @key{RET}
543Visit file @var{filename} and select its buffer in another frame. This
544runs @code{find-file-other-frame}. @xref{Visiting}.
545@item C-x 5 d @var{directory} @key{RET}
546Select a Dired buffer for directory @var{directory} in another frame.
547This runs @code{dired-other-frame}. @xref{Dired}.
548@item C-x 5 m
549Start composing a mail message in another frame. This runs
550@code{mail-other-frame}. It is the other-frame variant of @kbd{C-x m}.
551@xref{Sending Mail}.
552@item C-x 5 .
553Find a tag in the current tag table in another frame. This runs
554@code{find-tag-other-frame}, the multiple-frame variant of @kbd{M-.}.
555@xref{Tags}.
556@item C-x 5 r @var{filename} @key{RET}
557@kindex C-x 5 r
558@findex find-file-read-only-other-frame
559Visit file @var{filename} read-only, and select its buffer in another
560frame. This runs @code{find-file-read-only-other-frame}.
561@xref{Visiting}.
562@end table
563
564@cindex default-frame-alist
565@cindex initial-frame-alist
4fc2e5bf
CY
566@cindex face customization, in init file
567@cindex color customization, in init file
8cf51b2c
GM
568 You can control the appearance of new frames you create by setting the
569frame parameters in @code{default-frame-alist}. You can use the
570variable @code{initial-frame-alist} to specify parameters that affect
571only the initial frame. @xref{Initial Parameters,,, elisp, The Emacs
572Lisp Reference Manual}, for more information.
573
574@cindex font (default)
d68eb23c
CY
575 Here is an example of using @code{default-frame-alist} to specify
576the default foreground color and font:
8cf51b2c
GM
577
578@example
579(add-to-list 'default-frame-alist '(font . "10x20"))
8cf51b2c
GM
580(add-to-list 'default-frame-alist '(foreground-color . "blue"))
581@end example
582
583@noindent
4fc2e5bf 584By putting such customizations in your init file, you can control the
d68eb23c
CY
585appearance of all the frames Emacs creates, including the initial one
586(@pxref{Init File}). @xref{Fonts}, for other ways to set the default
587font.
8cf51b2c
GM
588
589@node Frame Commands
590@section Frame Commands
591
592 The following commands let you create, delete and operate on frames:
593
594@table @kbd
595@item C-z
596@kindex C-z @r{(X windows)}
8ba46c89
CY
597@findex suspend-frame
598Minimize (or ``iconify) the selected Emacs frame
599(@code{suspend-frame}). @xref{Exiting}.
8cf51b2c
GM
600
601@item C-x 5 0
602@kindex C-x 5 0
603@findex delete-frame
4fc2e5bf
CY
604Delete the selected frame (@code{delete-frame}). This is not allowed
605if there is only one frame.
8cf51b2c
GM
606
607@item C-x 5 o
608@kindex C-x 5 o
609@findex other-frame
4fc2e5bf
CY
610Select another frame, raise it, and warp the mouse to it. If you
611repeat this command, it cycles through all the frames on your
612terminal.
8cf51b2c
GM
613
614@item C-x 5 1
615@kindex C-x 5 1
616@findex delete-other-frames
617Delete all frames except the selected one.
618@end table
619
a1e759cd
CY
620 The @kbd{C-x 5 0} (@code{delete-frame}) command will never delete
621the last frame, to prevent you from losing the ability to interact
622with the Emacs process. Note that when Emacs is run as a daemon
623(@pxref{Emacs Server}), there is always a ``virtual frame'' that
624remains after all the ordinary, interactive frames are deleted. In
625this case, @kbd{C-x 5 0} can delete the last interactive frame; you
626can use @command{emacsclient} to reconnect to the Emacs session.
627
8cf51b2c 628@vindex focus-follows-mouse
a1e759cd
CY
629 On X, you may have to tell Emacs how the system (or the window
630manager) handles focus-switching between windows, in order for the
631command @kbd{C-x 5 o} (@code{other-frame}) to work properly.
632Unfortunately, there is no way for Emacs to detect this automatically,
633so you should set the variable @code{focus-follows-mouse}. If simply
634moving the mouse onto a window selects it and gives it focus, the
635variable should be @code{t}; if you have to click on the window to
636select it, the variable should be @code{nil}. The default is
637@code{t}.
4fc2e5bf
CY
638
639 The window manager that is part of MS-Windows always gives focus to
640a frame that raises, so this variable has no effect in the native
8cf51b2c
GM
641MS-Windows build of Emacs.
642
d68eb23c
CY
643@node Fonts
644@section Fonts
645@cindex fonts
646
647 By default, Emacs displays text in X using a 12-point monospace
648font. There are several different ways to specify a different font:
649
650@itemize
651@item
652Click on @samp{Set Default Font} in the @samp{Options} menu. To save
653this for future sessions, click on @samp{Save Options} in the
654@samp{Options} menu.
655
656@item
657Add a line to your init file (@pxref{Init File}), modifying the
658variable @code{default-frame-alist} to specify the @code{font}
659parameter (@pxref{Creating Frames}), like this:
660
661@smallexample
662(add-to-list 'default-frame-alist '(font . "DejaVu Sans Mono-12"))
663@end smallexample
664
665@cindex X defaults file
666@cindex X resources file
667@item
668Add an @samp{emacs.font} X resource setting to your X resource file,
669like this:
670
671@smallexample
672emacs.font: DejaVu Sans Mono-12
673@end smallexample
674
675@noindent
676You must restart X, or use the @command{xrdb} command, for the X
677resources file to take effect. @xref{Resources}. When specifying a
678font in your X resources file, you should not quote it.
679
680@item
681If you are running Emacs on the GNOME desktop, you can tell Emacs to
682use the default system font by setting the variable
683@code{font-use-system-font} to @code{t} (the default is @code{nil}).
684For this to work, Emacs must be compiled with Gconf support; this is
685done automatically if the libraries are present at compile time.
686
687@item
688Use the command line option @samp{-fn} (or @samp{--font}). @xref{Font
689X}.
690@end itemize
691
692@cindex fontconfig
693 On X, there are four different ways to express a ``font name''. The
694first is to use a @dfn{Fontconfig pattern}. Fontconfig patterns have
695the following form:
696
697@smallexample
698@var{fontname}[-@var{fontsize}][:@var{name1}=@var{values1}][:@var{name2}=@var{values2}]...
699@end smallexample
700
701@noindent
702Within this format, any of the elements in braces may be omitted.
703Here, @var{fontname} is the @dfn{family name} of the font, such as
704@samp{Monospace} or @samp{DejaVu Serif}; @var{fontsize} is the
705@dfn{point size} of the font (one @dfn{printer's point} is about 1/72
706of an inch); and the @samp{@var{name}=@var{values}} entries specify
707settings such as the slant and weight of the font. Each @var{values}
708may be a single value, or a list of values separated by commas. In
709addition, some property values are valid with only one kind of
710property name, in which case the @samp{@var{name}=} part may be
711omitted.
712
713Here is a list of common font properties:
714
715@table @samp
716@item slant
717One of @samp{italic}, @samp{oblique} or @samp{roman}.
718
719@item weight
720One of @samp{light}, @samp{medium}, @samp{demibold}, @samp{bold} or
721@samp{black}.
722
723@item style
724Some fonts define special styles which are a combination of slant and
725weight. For instance, @samp{Dejavu Sans} defines the @samp{book}
726style, which overrides the slant and weight properties.
727
728@item width
729One of @samp{condensed}, @samp{normal}, or @samp{expanded}.
730
731@item spacing
732One of @samp{monospace}, @samp{proportional}, @samp{dual-width}, or
733@samp{charcell}.
734@end table
735
736@noindent
737Here are some examples of Fontconfig patterns:
738
739@smallexample
740Monospace
741Monospace-12
742Monospace-12:bold
743DejaVu Sans Mono:bold:italic
744Monospace-12:weight=bold:slant=italic
745@end smallexample
746
747See the Fontconfig manual for a more detailed description of
748Fontconfig patterns. This manual is located in the file
749@file{fontconfig-user.html}, distributed with Fontconfig. It is also
750available online at @url{http://fontconfig.org/fontconfig-user.html}.
751In particular, that manual describes additional font properties that
752influence how the font is hinted, antialiased, or scaled.
753
754 The second way to specify a font is to use a @dfn{GTK font
755description}. These have the syntax
756
757@smallexample
758@var{fontname} [@var{properties}] [@var{fontsize}]
759@end smallexample
760
761@noindent
762where @var{fontname} is the family name, @var{properties} is a list of
763property values separated by spaces, and @var{fontsize} is the point
764size. The properties that you may specify are as follows:
765
766@table @samp
767@item style
768One of @samp{roman}, @samp{italic} or @samp{oblique}. If omitted, the
769@samp{roman} style is used.
770@item weight
771One of @samp{medium}, @samp{ultra-light}, @samp{light},
772@samp{semi-bold}, or @samp{bold}. If omitted, @samp{medium} weight is
773used.
774@end table
775
776@noindent
777Here are some examples of GTK font descriptions:
778
779@smallexample
780Monospace 12
781Monospace Bold Italic 12
782@end smallexample
783
784@cindex XLFD
785@cindex X Logical Font Description
786 The third way to specify a font is to use an @dfn{XLFD} (@dfn{X
787Logical Font Description}). This is the traditional method for
788specifying fonts under X. Each XLFD consists of fourteen words or
789numbers, separated by dashes, like this:
790
791@smallexample
792-misc-fixed-medium-r-semicondensed--13-*-*-*-c-60-iso8859-1
793@end smallexample
794
795@noindent
796A wildcard character (@samp{*}) in an XLFD matches any sequence of
797characters (including none), and @samp{?} matches any single
798character. However, matching is implementation-dependent, and can be
799inaccurate when wildcards match dashes in a long name. For reliable
800results, supply all 14 dashes and use wildcards only within a field.
801Case is insignificant in an XLFD. The syntax for an XLFD is as
802follows:
803
804@smallexample
805-@var{maker}-@var{family}-@var{weight}-@var{slant}-@var{widthtype}-@var{style}@dots{}
806@dots{}-@var{pixels}-@var{height}-@var{horiz}-@var{vert}-@var{spacing}-@var{width}-@var{registry}-@var{encoding}
807@end smallexample
808
809@noindent
810The entries have the following meanings:
811
812@table @var
813@item maker
814The name of the font manufacturer.
815@item family
816The name of the font family (e.g. @samp{courier}).
817@item weight
818The font weight---normally either @samp{bold}, @samp{medium} or
819@samp{light}. Some font names support other values.
820@item slant
821The font slant---normally @samp{r} (roman), @samp{i} (italic),
822@samp{o} (oblique), @samp{ri} (reverse italic), or @samp{ot} (other).
823Some font names support other values.
824@item widthtype
825The font width---normally @samp{condensed}, @samp{extended},
826@samp{semicondensed} or @samp{normal} (some font names support other
827values).
828@item style
829An optional additional style name. Usually it is empty---most long
830font names have two hyphens in a row at this point.
831@item pixels
832The font height, in pixels.
833@item height
834The font height on the screen, measured in tenths of a printer's
835point. This is the point size of the font, times ten. For a given
836vertical resolution, @var{height} and @var{pixels} are proportional;
837therefore, it is common to specify just one of them and use @samp{*}
838for the other.
839@item horiz
840The horizontal resolution, in pixels per inch, of the screen for which
841the font is intended.
842@item vert
843The vertical resolution, in pixels per inch, of the screen for which
844the font is intended. Normally the resolution of the fonts on your
845system is the right value for your screen; therefore, you normally
846specify @samp{*} for this and @var{horiz}.
847@item spacing
848This is @samp{m} (monospace), @samp{p} (proportional) or @samp{c}
849(character cell).
850@item width
851The average character width, in pixels, multiplied by ten.
852@item registry
853@itemx encoding
854The X font character set that the font depicts. (X font character
855sets are not the same as Emacs character sets, but they are similar.)
856You can use the @command{xfontsel} program to check which choices you
857have. Normally you should use @samp{iso8859} for @var{registry} and
858@samp{1} for @var{encoding}.
859@end table
860
861 The fourth and final method of specifying a font is to use a ``font
862nickname''. Certain fonts have shorter nicknames, which you can use
863instead of a normal font specification. For instance, @samp{6x13} is
864equivalent to
865
866@smallexample
867-misc-fixed-medium-r-semicondensed--13-*-*-*-c-60-iso8859-1
868@end smallexample
869
870@cindex client-side fonts
871@cindex server-side fonts
872 On X, Emacs recognizes two types of fonts: @dfn{client-side} fonts,
873which are provided by the Xft and Fontconfig libraries, and
874@dfn{server-side} fonts, which are provided by the X server itself.
875Most client-side fonts support advanced font features such as
876antialiasing and subpixel hinting, while server-side fonts do not.
877Fontconfig and GTK patterns match only client-side fonts.
878
879@cindex listing system fonts
880 You will probably want to use a fixed-width default font---that is,
881a font in which all characters have the same width. For Xft and
882Fontconfig fonts, you can use the @command{fc-list} command to list
883the available fixed-width fonts, like this:
884
885@example
886fc-list :spacing=mono fc-list :spacing=charcell
887@end example
888
889@noindent
890For server-side X fonts, you can use the @command{xlsfonts} program to
891list the available fixed-width fonts, like this:
892
893@example
894xlsfonts -fn '*x*' | egrep "^[0-9]+x[0-9]+"
895xlsfonts -fn '*-*-*-*-*-*-*-*-*-*-*-m*'
896xlsfonts -fn '*-*-*-*-*-*-*-*-*-*-*-c*'
897@end example
898
899@noindent
900Any font with @samp{m} or @samp{c} in the @var{spacing} field of the
901XLFD is a fixed-width font. To see what a particular font looks like,
902use the @command{xfd} command. For example:
903
904@example
905xfd -fn 6x13
906@end example
907
908@noindent
909displays the entire font @samp{6x13}.
910
911 While running Emacs, you can also set the font of a specific kind of
912text (@pxref{Faces}), or a particular frame (@pxref{Frame
913Parameters}).
914
8cf51b2c
GM
915@node Speedbar
916@section Speedbar Frames
917@cindex speedbar
918
919@cindex attached frame (of speedbar)
920 The @dfn{speedbar} is a special frame for conveniently navigating in
921or operating on another frame. The speedbar, when it exists, is
922always associated with a specific frame, called its @dfn{attached
923frame}; all speedbar operations act on that frame.
924
925 Type @kbd{M-x speedbar} to create the speedbar and associate it with
926the current frame. To dismiss the speedbar, type @kbd{M-x speedbar}
927again, or select the speedbar and type @kbd{q}. (You can also delete
928the speedbar frame like any other Emacs frame.) If you wish to
929associate the speedbar with a different frame, dismiss it and call
930@kbd{M-x speedbar} from that frame.
931
932 The speedbar can operate in various modes. Its default mode is
933@dfn{File Display} mode, which shows the files in the current
934directory of the selected window of the attached frame, one file per
935line. Clicking on a file name visits that file in the selected window
936of the attached frame, and clicking on a directory name shows that
937directory in the speedbar (@pxref{Mouse References}). Each line also
938has a box, @samp{[+]} or @samp{<+>}, that you can click on to
939@dfn{expand} the contents of that item. Expanding a directory adds
940the contents of that directory to the speedbar display, underneath the
941directory's own line. Expanding an ordinary file adds a list of the
942tags in that file to the speedbar display; you can click on a tag name
943to jump to that tag in the selected window of the attached frame.
944When a file or directory is expanded, the @samp{[+]} changes to
945@samp{[-]}; you can click on that box to @dfn{contract} the item,
946hiding its contents.
947
948 You navigate through the speedbar using the keyboard, too. Typing
949@kbd{RET} while point is on a line in the speedbar is equivalent to
950clicking the item on the current line, and @kbd{SPC} expands or
951contracts the item. @kbd{U} displays the parent directory of the
952current directory. To copy, delete, or rename the file on the current
953line, type @kbd{C}, @kbd{D}, and @kbd{R} respectively. To create a
954new directory, type @kbd{M}.
955
956 Another general-purpose speedbar mode is @dfn{Buffer Display} mode;
957in this mode, the speedbar displays a list of Emacs buffers. To
958switch to this mode, type @kbd{b} in the speedbar. To return to File
959Display mode, type @kbd{f}. You can also change the display mode by
960clicking @kbd{mouse-3} anywhere in the speedbar window (or
961@kbd{mouse-1} on the mode-line) and selecting @samp{Displays} in the
962pop-up menu.
963
964 Some major modes, including Rmail mode, Info, and GUD, have
965specialized ways of putting useful items into the speedbar for you to
966select. For example, in Rmail mode, the speedbar shows a list of Rmail
967files, and lets you move the current message to another Rmail file by
968clicking on its @samp{<M>} box.
969
970 For more details on using and programming the speedbar, @xref{Top,
971Speedbar,,speedbar, Speedbar Manual}.
972
973@node Multiple Displays
974@section Multiple Displays
975@cindex multiple displays
976
977 A single Emacs can talk to more than one X display. Initially, Emacs
978uses just one display---the one specified with the @env{DISPLAY}
979environment variable or with the @samp{--display} option (@pxref{Initial
980Options}). To connect to another display, use the command
981@code{make-frame-on-display}:
982
983@findex make-frame-on-display
984@table @kbd
985@item M-x make-frame-on-display @key{RET} @var{display} @key{RET}
986Create a new frame on display @var{display}.
987@end table
988
989 A single X server can handle more than one screen. When you open
990frames on two screens belonging to one server, Emacs knows they share a
991single keyboard, and it treats all the commands arriving from these
992screens as a single stream of input.
993
994 When you open frames on different X servers, Emacs makes a separate
4fc2e5bf
CY
995input stream for each server. Each server also has its own selected
996frame. The commands you enter with a particular X server apply to
997that server's selected frame.
8cf51b2c 998
4fc2e5bf
CY
999 It is even possible to use this feature to let two or more users
1000type simultaneously on the two displays, within the same Emacs job.
1001In practice, however, the different users can easily interfere with
1002each others' edits if they are not careful.
8cf51b2c
GM
1003
1004@node Special Buffer Frames
1005@section Special Buffer Frames
1006
1007@vindex special-display-buffer-names
1008 You can make certain chosen buffers, which Emacs normally displays
1009in ``another window,'' appear in special frames of their own. To do
1010this, set the variable @code{special-display-buffer-names} to a list
1011of buffer names; any buffer whose name is in that list automatically
1012gets a special frame, when an Emacs command wants to display it ``in
1013another window.''
1014
1015 For example, if you set the variable this way,
1016
1017@example
1018(setq special-display-buffer-names
1019 '("*Completions*" "*grep*" "*tex-shell*"))
1020@end example
1021
1022@noindent
1023then completion lists, @code{grep} output and the @TeX{} mode shell
1024buffer get individual frames of their own. These frames, and the
1025windows in them, are never automatically split or reused for any other
1026buffers. They continue to show the buffers they were created for,
1027unless you alter them by hand. Killing the special buffer deletes its
1028frame automatically.
1029
1030@vindex special-display-regexps
1031 More generally, you can set @code{special-display-regexps} to a list
1032of regular expressions; then a buffer gets its own frame if its name
1033matches any of those regular expressions. (Once again, this applies only
1034to buffers that normally get displayed for you in ``another window.'')
1035
1036@vindex special-display-frame-alist
1037 The variable @code{special-display-frame-alist} specifies the frame
1038parameters for these frames. It has a default value, so you don't need
1039to set it.
1040
1041 For those who know Lisp, an element of
1042@code{special-display-buffer-names} or @code{special-display-regexps}
1043can also be a list. Then the first element is the buffer name or
1044regular expression; the rest of the list specifies how to create the
1045frame. It can be an association list specifying frame parameter
1046values; these values take precedence over parameter values specified
1047in @code{special-display-frame-alist}. If you specify the symbol
1048@code{same-window} as a ``frame parameter'' in this list, with a
1049non-@code{nil} value, that means to use the selected window if
1050possible. If you use the symbol @code{same-frame} as a ``frame
1051parameter'' in this list, with a non-@code{nil} value, that means to
1052use the selected frame if possible.
1053
1054 Alternatively, the value can have this form:
1055
1056@example
1057(@var{function} @var{args}...)
1058@end example
1059
1060@noindent
1061where @var{function} is a symbol. Then the frame is constructed by
1062calling @var{function}; its first argument is the buffer, and its
1063remaining arguments are @var{args}.
1064
1065 An analogous feature lets you specify buffers which should be
1066displayed in the selected window. @xref{Force Same Window}. The
1067same-window feature takes precedence over the special-frame feature;
1068therefore, if you add a buffer name to
1069@code{special-display-buffer-names} and it has no effect, check to see
1070whether that feature is also in use for the same buffer name.
1071
1072@node Frame Parameters
1073@section Setting Frame Parameters
1074@cindex Auto-Raise mode
1075@cindex Auto-Lower mode
1076
8cf51b2c 1077 These commands are available for controlling the window management
4fc2e5bf 1078behavior of the selected frame:
8cf51b2c
GM
1079
1080@table @kbd
1081@findex auto-raise-mode
1082@item M-x auto-raise-mode
1083Toggle whether or not the selected frame should auto-raise. Auto-raise
1084means that every time you move the mouse onto the frame, it raises the
1085frame.
1086
1087Some window managers also implement auto-raise. If you enable
1088auto-raise for Emacs frames in your window manager, it will work, but
1089it is beyond Emacs' control, so @code{auto-raise-mode} has no effect
1090on it.
1091
1092@findex auto-lower-mode
1093@item M-x auto-lower-mode
1094Toggle whether or not the selected frame should auto-lower.
1095Auto-lower means that every time you move the mouse off the frame,
1096the frame moves to the bottom of the stack on the screen.
1097
1098The command @code{auto-lower-mode} has no effect on auto-lower
1099implemented by the window manager. To control that, you must use the
1100appropriate window manager features.
1101@end table
1102
1103 In Emacs versions that use an X toolkit, the color-setting and
1104font-setting functions don't affect menus and the menu bar, since they
1105are displayed by their own widget classes. To change the appearance of
1106the menus and menu bar, you must use X resources (@pxref{Resources}).
1107@xref{Colors}, regarding colors. @xref{Font X}, regarding choice of
1108font.
1109
1110 Colors, fonts, and other attributes of the frame's display can also
1111be customized by setting frame parameters in the variable
1112@code{default-frame-alist} (@pxref{Creating Frames}). For a detailed
1113description of frame parameters and customization, see @ref{Frame
1114Parameters,,, elisp, The Emacs Lisp Reference Manual}.
1115
1116@node Scroll Bars
1117@section Scroll Bars
1118@cindex Scroll Bar mode
1119@cindex mode, Scroll Bar
1120
1121 On graphical displays, Emacs normally makes a @dfn{scroll bar} at
c5c040a7 1122the left of each Emacs window, running the height of the
4fc2e5bf
CY
1123window.@footnote{Placing it at the left is usually more useful with
1124overlapping frames with text starting at the left margin.}
1125
c5c040a7 1126 When Emacs is compiled with GTK+ support on the X window system, or
4fc2e5bf
CY
1127in operating systems such as Microsoft Windows or Mac OS, you can use
1128the scroll bar as you do in other graphical applications. If you
dc103cdc
CY
1129click @kbd{Mouse-1} on the scroll bar's up and down buttons, that
1130scrolls the window by one line at a time. Clicking @kbd{Mouse-1}
4fc2e5bf
CY
1131above or below the scroll bar's inner box scrolls the window by nearly
1132the entire height of the window, like @kbd{M-v} and @kbd{C-v}
1133respectively (@pxref{Moving Point}). Dragging the inner box with
dc103cdc 1134@kbd{Mouse-1} scrolls the window continuously.
4fc2e5bf 1135
c5c040a7
CY
1136 If Emacs is compiled without GTK+ support on the X window system,
1137the scroll bar behaves differently. The scroll bar's inner box is
1138drawn to represent the portion of the buffer currently displayed, with
1139the entire height of the scroll bar representing the entire length of
dc103cdc
CY
1140the buffer. @kbd{Mouse-1} anywhere on the scroll bar scrolls forward
1141like @kbd{C-v}, and @kbd{Mouse-3} scrolls backward like @kbd{M-v}.
1142Clicking @kbd{Mouse-2} in the scroll bar lets you move or drag the
4fc2e5bf 1143inner box up and down.
8cf51b2c
GM
1144
1145 You can also click @kbd{C-Mouse-2} in the scroll bar to split a
1146window vertically. The split occurs on the line where you click.
1147
1148@findex scroll-bar-mode
1149@vindex scroll-bar-mode
4fc2e5bf
CY
1150 You can toggle the use of the scroll bar with the command @kbd{M-x
1151scroll-bar-mode}. With a prefix argument, this command turns use of
1152scroll bars on if and only if the argument is positive. This command
1153applies to all frames, including frames yet to be created. Customize
1154the variable @code{scroll-bar-mode} to control the use of scroll bars
1155at startup. You can use it to specify that they are placed at the
1156right of windows if you prefer that. You have to set this variable
1157through the @samp{Customize} interface (@pxref{Easy Customization}),
1158or it will not work properly. You can also use the X resource
1159@samp{verticalScrollBars} to control the initial setting of Scroll Bar
1160mode. @xref{Resources}.
8cf51b2c
GM
1161
1162@findex toggle-scroll-bar
1163 To enable or disable scroll bars for just the selected frame, use the
1164command @kbd{M-x toggle-scroll-bar}.
1165
1166@vindex scroll-bar-width
1167@cindex width of the scroll bar
1168 You can control the scroll bar width by changing the value of the
1169@code{scroll-bar-width} frame parameter.
1170
1171@node Wheeled Mice
1172@section Scrolling With ``Wheeled'' Mice
1173
1174@cindex mouse wheel
1175@cindex wheel, mouse
1176@findex mouse-wheel-mode
1177@cindex Mouse Wheel minor mode
1178@cindex mode, Mouse Wheel
1179 Some mice have a ``wheel'' instead of a third button. You can
1180usually click the wheel to act as either @kbd{Mouse-2} or
1181@kbd{Mouse-3}, depending on the setup. You can also use the wheel to
1182scroll windows instead of using the scroll bar or keyboard commands.
1183Mouse wheel support only works if the system generates appropriate
1184events; whenever possible, it is turned on by default. To toggle this
1185feature, use @kbd{M-x mouse-wheel-mode}.
1186
1187@vindex mouse-wheel-follow-mouse
1188@vindex mouse-wheel-scroll-amount
1189@vindex mouse-wheel-progressive-speed
1190 The two variables @code{mouse-wheel-follow-mouse} and
1191@code{mouse-wheel-scroll-amount} determine where and by how much
1192buffers are scrolled. The variable
1193@code{mouse-wheel-progressive-speed} determines whether the scroll
1194speed is linked to how fast you move the wheel.
1195
1196@node Drag and Drop
1197@section Drag and Drop
1198@cindex drag and drop
1199
1200 Emacs supports @dfn{drag and drop} using the mouse. For instance,
1201dropping text onto an Emacs frame inserts the text where it is dropped.
1202Dropping a file onto an Emacs frame visits that file. As a special
1203case, dropping the file on a Dired buffer moves or copies the file
1204(according to the conventions of the application it came from) into the
1205directory displayed in that buffer.
1206
1207@vindex dnd-open-file-other-window
1208 Dropping a file normally visits it in the window you drop it on. If
1209you prefer to visit the file in a new window in such cases, customize
1210the variable @code{dnd-open-file-other-window}.
1211
1212 The XDND and Motif drag and drop protocols, and the old KDE 1.x
1213protocol, are currently supported.
1214
1215@node Menu Bars
1216@section Menu Bars
1217@cindex Menu Bar mode
1218@cindex mode, Menu Bar
1219@findex menu-bar-mode
1220@vindex menu-bar-mode
1221
1222 You can turn display of menu bars on or off with @kbd{M-x
1223menu-bar-mode} or by customizing the variable @code{menu-bar-mode}.
1224With no argument, this command toggles Menu Bar mode, a
1225minor mode. With an argument, the command turns Menu Bar mode on if the
1226argument is positive, off if the argument is not positive. You can use
93318cbd 1227the X resource @samp{menuBar} to control the initial setting of
8cf51b2c
GM
1228Menu Bar mode. @xref{Resources}.
1229
1230@kindex C-Mouse-3 @r{(when menu bar is disabled)}
1231 Expert users often turn off the menu bar, especially on text-only
1232terminals, where this makes one additional line available for text.
1233If the menu bar is off, you can still pop up a menu of its contents
1234with @kbd{C-Mouse-3} on a display which supports pop-up menus.
1235@xref{Menu Mouse Clicks}.
1236
1237 @xref{Menu Bar}, for information on how to invoke commands with the
1238menu bar. @xref{X Resources}, for how to customize the menu bar
1239menus' visual appearance.
1240
1241@node Tool Bars
1242@section Tool Bars
1243@cindex Tool Bar mode
1244@cindex mode, Tool Bar
1245@cindex icons, toolbar
1246
1247 The @dfn{tool bar} is a line (or lines) of icons at the top of the
1248Emacs window, just below the menu bar. You can click on these icons
1249with the mouse to do various jobs.
1250
1251 The global tool bar contains general commands. Some major modes
1252define their own tool bars to replace it. A few ``special'' modes
1253that are not designed for ordinary editing remove some items from the
1254global tool bar.
1255
1256 Tool bars work only on a graphical display. The tool bar uses colored
1257XPM icons if Emacs was built with XPM support. Otherwise, the tool
1258bar uses monochrome icons (PBM or XBM format).
1259
1260@findex tool-bar-mode
1261@vindex tool-bar-mode
1262 You can turn display of tool bars on or off with @kbd{M-x
1263tool-bar-mode} or by customizing the option @code{tool-bar-mode}.
1264
20fe03ad
JD
1265@vindex tool-bar-style
1266@cindex Tool Bar style
1267 When Emacs is compiled with GTK+ support, tool bars can have text and images.
1268Customize @code{tool-bar-style} to select style. The default style is
1269the same as for the desktop in the Gnome case. If no default is found,
1270the tool bar uses just images.
1271
8b2dd508
JD
1272@cindex Tool Bar position
1273 You can also control the placement of the tool bar for the GTK+ tool bar
1274with the frame parameter @code{tool-bar-position}.
1275For a detailed description of frame parameters and customization,
1276see @ref{Frame Parameters,,, elisp, The Emacs Lisp Reference Manual}.
1277
8cf51b2c
GM
1278@node Dialog Boxes
1279@section Using Dialog Boxes
1280@cindex dialog boxes
1281
1282@vindex use-dialog-box
1283 A dialog box is a special kind of menu for asking you a yes-or-no
1284question or some other special question. Many Emacs commands use a
1285dialog box to ask a yes-or-no question, if you used the mouse to
c5c040a7 1286invoke the command that led to the question.
8cf51b2c 1287
c5c040a7
CY
1288 To disable the use of dialog boxes, change the variable
1289@code{use-dialog-box} to @code{nil}. In that case, Emacs always
1290performs yes-or-no prompts using the echo area and keyboard input.
1291This variable also controls whether to use file selection windows (but
1292those are not supported on all platforms).
8cf51b2c
GM
1293
1294@vindex use-file-dialog
9c5e9396 1295@cindex file selection dialog, how to disable
8cf51b2c
GM
1296 A file selection window is a special kind of dialog box for asking
1297for file names. You can customize the variable @code{use-file-dialog}
1298to suppress the use of file selection windows, even if you still want
1299other kinds of dialogs. This variable has no effect if you have
1300suppressed all dialog boxes with the variable @code{use-dialog-box}.
1301
1302@vindex x-gtk-show-hidden-files
8cf51b2c 1303@vindex x-gtk-file-dialog-help-text
9c5e9396
EZ
1304@cindex hidden files, in GTK+ file chooser
1305@cindex help text, in GTK+ file chooser
c5c040a7
CY
1306 When Emacs is compiled with GTK+ support, it uses the GTK+ ``file
1307chooser'' dialog. Emacs adds an additional toggle button to this
1308dialog, which you can use to enable or disable the display of hidden
1309files (files starting with a dot) in that dialog. If you want this
1310toggle to be activated by default, change the variable
1311@code{x-gtk-show-hidden-files} to @code{t}. In addition, Emacs adds
1312help text to the GTK+ file chooser dialog; to disable this help text,
1313change the variable @code{x-gtk-file-dialog-help-text} to @code{nil}.
1314
9c5e9396 1315@vindex x-gtk-use-old-file-dialog
c5c040a7
CY
1316 In GTK+ versions 2.4 through 2.10, you can choose to use an older
1317version of the GTK+ file dialog by setting the variable
1318@code{x-gtk-use-old-file-dialog} to a non-@code{nil} value. If Emacs
1319is built with a GTK+ version that has only one file dialog, this
1320variable has no effect.
8cf51b2c
GM
1321
1322@node Tooltips
1323@section Tooltips
1324@cindex tooltips
1325
1326 @dfn{Tooltips} are small windows that display text information at the
1327current mouse position. They activate when there is a pause in mouse
1328movement. There are two types of tooltip: help tooltips and GUD
1329tooltips.
1330
1331 @dfn{Help tooltips} typically display over text---including the mode
1332line---but are also available for other parts of the Emacs frame, such
1333as the tool bar and menu items.
1334
1335@findex tooltip-mode
1336 You can toggle display of help tooltips (Tooltip mode) with the
1337command @kbd{M-x tooltip-mode}. When Tooltip mode is disabled, the
1338help text is displayed in the echo area instead.
1339
1340 @dfn{GUD tooltips} show values of variables. They are useful when
1341you are debugging a program. @xref{Debugger Operation}.
1342
1343@vindex tooltip-delay
1344 The variables @code{tooltip-delay} specifies how long Emacs should
1345wait before displaying a tooltip. For additional customization
1346options for displaying tooltips, use @kbd{M-x customize-group
1347@key{RET} tooltip @key{RET}}. @xref{X Resources}, for information on
1348customizing the windows that display tooltips.
1349
1350@node Mouse Avoidance
1351@section Mouse Avoidance
1352@cindex avoiding mouse in the way of your typing
1353@cindex mouse avoidance
1354
b4a1a8b2
CY
1355 On graphical terminals, the mouse pointer may obscure the text in
1356the Emacs frame. Emacs provides two methods to avoid this problem.
1357
1358@vindex make-pointer-invisible
1359 Firstly, Emacs hides the mouse pointer each time you type a
1360self-inserting character, if the pointer lies inside an Emacs frame;
1361moving the mouse pointer makes it visible again. To disable this
1362feature, set the variable @code{make-pointer-invisible} to @code{nil}.
1363
8cf51b2c 1364@vindex mouse-avoidance-mode
b4a1a8b2
CY
1365 Secondly, you can use Mouse Avoidance mode, a minor mode, to keep
1366the mouse pointer away from point. To use Mouse Avoidance mode,
1367customize the variable @code{mouse-avoidance-mode}. You can set this
1368to various values to move the mouse in several ways:
8cf51b2c
GM
1369
1370@table @code
1371@item banish
1372Move the mouse to the upper-right corner on any key-press;
1373@item exile
1374Move the mouse to the corner only if the cursor gets too close,
1375and allow it to return once the cursor is out of the way;
1376@item jump
1377If the cursor gets too close to the mouse, displace the mouse
1378a random distance & direction;
1379@item animate
1380As @code{jump}, but shows steps along the way for illusion of motion;
1381@item cat-and-mouse
1382The same as @code{animate};
1383@item proteus
1384As @code{animate}, but changes the shape of the mouse pointer too.
1385@end table
1386
1387@findex mouse-avoidance-mode
1388You can also use the command @kbd{M-x mouse-avoidance-mode} to enable
b4a1a8b2
CY
1389the mode. Whenever Mouse Avoidance mode moves the mouse, it also
1390raises the frame.
8cf51b2c
GM
1391
1392@node Non-Window Terminals
1393@section Non-Window Terminals
1394@cindex non-window terminals
1395@cindex single-frame terminals
1396
1397 On a text-only terminal, Emacs can display only one Emacs frame at a
1398time. However, you can still create multiple Emacs frames, and switch
1399between them. Switching frames on these terminals is much like
1400switching between different window configurations.
1401
1402 Use @kbd{C-x 5 2} to create a new frame and switch to it; use @kbd{C-x
14035 o} to cycle through the existing frames; use @kbd{C-x 5 0} to delete
1404the current frame.
1405
1406 Each frame has a number to distinguish it. If your terminal can
1407display only one frame at a time, the selected frame's number @var{n}
1408appears near the beginning of the mode line, in the form
1409@samp{F@var{n}}.
1410
1411@findex set-frame-name
1412@findex select-frame-by-name
1413 @samp{F@var{n}} is in fact the frame's initial name. You can give
1414frames more meaningful names if you wish, and you can select a frame
1415by its name. Use the command @kbd{M-x set-frame-name @key{RET}
1416@var{name} @key{RET}} to specify a new name for the selected frame,
1417and use @kbd{M-x select-frame-by-name @key{RET} @var{name} @key{RET}}
1418to select a frame according to its name. The name you specify appears
1419in the mode line when the frame is selected.
1420
1421@node Text-Only Mouse
1422@section Using a Mouse in Terminal Emulators
1423@cindex mouse support
1424@cindex terminal emulators, mouse support
1425
c5c040a7 1426Some text-only terminals support mouse clicks in the terminal window.
8cf51b2c
GM
1427
1428@cindex xterm
1429In a terminal emulator which is compatible with @code{xterm},
1430you can use @kbd{M-x xterm-mouse-mode} to give Emacs control over
1431simple use of the mouse---basically, only non-modified single clicks
1432are supported. The normal @code{xterm} mouse functionality for such
1433clicks is still available by holding down the @kbd{SHIFT} key when you
1434press the mouse button. Xterm Mouse mode is a global minor mode
1435(@pxref{Minor Modes}). Repeating the command turns the mode off
1436again.
1437
bc36ad1c
CY
1438@findex gpm-mouse-mode
1439In the console on GNU/Linux, you can use @kbd{M-x gpm-mouse-mode} to
c5c040a7
CY
1440enable terminal mouse support. You must have the gpm package
1441installed and running on your system in order for this to work.