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