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