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