* doc/emacs/frames.texi (Text-Only Mouse): Fix xref.
[emacs.git] / doc / emacs / frames.texi
blob80a12afeb1b036d15a5dae1d364cbf39147241dc
1 @c This is part of the Emacs manual.
2 @c Copyright (C) 1985-1987, 1993-1995, 1997, 1999-2012
3 @c   Free Software Foundation, Inc.
4 @c See file emacs.texi for copying conditions.
5 @node Frames, International, Windows, Top
6 @chapter Frames and Graphical Displays
7 @cindex frames
9   When Emacs is started on a graphical display, e.g.@: on the X Window
10 System, it occupies a graphical system-level ``window''.  In this
11 manual, we call this a @dfn{frame}, reserving the word ``window'' for
12 the part of the frame used for displaying a buffer.  A frame initially
13 contains one window, but it can be subdivided into multiple windows
14 (@pxref{Windows}).  A frame normally also contains a menu bar, tool
15 bar, and echo area.
17   You can also create additional frames (@pxref{Creating Frames}).
18 All frames created in the same Emacs session have access to the same
19 underlying buffers and other data.  For instance, if a buffer is being
20 shown in more than one frame, any changes made to it in one frame show
21 up immediately in the other frames too.
23   Typing @kbd{C-x C-c} closes all the frames on the current display,
24 and ends the Emacs session if it has no frames open on any other
25 displays (@pxref{Exiting}).  To close just the selected frame, type
26 @kbd{C-x 5 0} (that is zero, not @kbd{o}).
28   This chapter describes Emacs features specific to graphical displays
29 (particularly mouse commands), and features for managing multiple
30 frames.  On text terminals, many of these features are unavailable.
31 However, it is still possible to create multiple ``frames'' on text
32 terminals; such frames are displayed one at a time, filling the entire
33 terminal screen (@pxref{Non-Window Terminals}).  It is also possible
34 to use the mouse on some text terminals (@pxref{Text-Only Mouse}, for
35 doing so on GNU and Unix systems; and
36 @iftex
37 @pxref{MS-DOS Mouse,,,emacs-xtra,Specialized Emacs Features},
38 @end iftex
39 @ifnottex
40 @pxref{MS-DOS Mouse},
41 @end ifnottex
42 for doing so on MS-DOS).
44 @menu
45 * Mouse Commands::      Moving, cutting, and pasting, with the mouse.
46 * Word and Line Mouse:: Mouse commands for selecting whole words or lines.
47 * Mouse References::    Using the mouse to select an item from a list.
48 * Menu Mouse Clicks::   Mouse clicks that bring up menus.
49 * Mode Line Mouse::     Mouse clicks on the mode line.
50 * Creating Frames::     Creating additional Emacs frames with various contents.
51 * Frame Commands::      Iconifying, deleting, and switching frames.
52 * Fonts::               Changing the frame font.
53 * Speedbar::            How to make and use a speedbar frame.
54 * Multiple Displays::   How one Emacs instance can talk to several displays.
55 * Frame Parameters::    Changing the colors and other modes of frames.
56 * Scroll Bars::         How to enable and disable scroll bars; how to use them.
57 * Drag and Drop::       Using drag and drop to open files and insert text.
58 * Menu Bars::           Enabling and disabling the menu bar.
59 * Tool Bars::           Enabling and disabling the tool bar.
60 * Dialog Boxes::        Controlling use of dialog boxes.
61 * Tooltips::            Displaying information at the current mouse position.
62 * Mouse Avoidance::     Preventing the mouse pointer from obscuring text.
63 * Non-Window Terminals::  Multiple frames on terminals that show only one.
64 * Text-Only Mouse::     Using the mouse in text terminals.
65 @end menu
67 @node Mouse Commands
68 @section Mouse Commands for Editing
69 @cindex mouse buttons (what they do)
71 @kindex Mouse-1
72 @kindex Mouse-2
73 @kindex Mouse-3
74 @table @kbd
75 @item Mouse-1
76 Move point to where you click (@code{mouse-set-point}).
78 @item Drag-Mouse-1
79 Activate the region around the text selected by dragging, and copy it
80 to the kill ring (@code{mouse-set-region}).
82 @item Mouse-2
83 Yank the last killed text at the click position
84 (@code{mouse-yank-at-click}).
86 @item Mouse-3
87 If the region is active, move the nearer end of the region to the
88 click position; otherwise, set mark at the current value of point and
89 point at the click position.  Save the resulting region in the kill
90 ring; on a second click, kill it (@code{mouse-save-then-kill}).
91 @end table
93 @findex mouse-set-point
94   The most basic mouse command is @code{mouse-set-point}, which is
95 invoked by clicking with the left mouse button, @kbd{Mouse-1}, in the
96 text area of a window.  This moves point to the position where you
97 clicked.  If that window was not the selected window, it becomes the
98 selected window.
100 @vindex x-mouse-click-focus-ignore-position
101   Normally, if the frame you clicked in was not the selected frame, it
102 is made the selected frame, in addition to selecting the window and
103 setting the cursor.  On the X Window System, you can change this by
104 setting the variable @code{x-mouse-click-focus-ignore-position} to
105 @code{t}.  In that case, the initial click on an unselected frame just
106 selects the frame, without doing anything else; clicking again selects
107 the window and sets the cursor position.
109 @findex mouse-set-region
110   Holding down @kbd{Mouse-1} and ``dragging'' the mouse over a stretch
111 of text activates the region around that text
112 (@code{mouse-set-region}), placing the mark where you started holding
113 down the mouse button, and point where you release it (@pxref{Mark}).
114 In addition, the text in the region becomes the primary selection
115 (@pxref{Primary Selection}).
117 @vindex mouse-drag-copy-region
118   If you change the variable @code{mouse-drag-copy-region} to a
119 non-@code{nil} value, dragging the mouse over a stretch of text also
120 adds the text to the kill ring.  The default is @code{nil}.
122 @vindex mouse-scroll-min-lines
123   If you move the mouse off the top or bottom of the window while
124 dragging, the window scrolls at a steady rate until you move the mouse
125 back into the window.  This way, you can select regions that don't fit
126 entirely on the screen.  The number of lines scrolled per step depends
127 on how far away from the window edge the mouse has gone; the variable
128 @code{mouse-scroll-min-lines} specifies a minimum step size.
130 @findex mouse-yank-primary
131 @findex mouse-yank-at-click
132   Clicking with the middle mouse button, @kbd{Mouse-2}, moves point to
133 the position where you clicked and inserts the contents of the primary
134 selection (@code{mouse-yank-primary}).  @xref{Primary Selection}.
135 This behavior is consistent with other X applications.  Alternatively,
136 you can rebind @kbd{Mouse-2} to @code{mouse-yank-at-click}, which
137 performs a yank at point.
139 @vindex mouse-yank-at-point
140   If you change the variable @code{mouse-yank-at-point} to a
141 non-@code{nil} value, @kbd{Mouse-2} does not move point; it inserts
142 the text at point, regardless of where you clicked or even which of
143 the frame's windows you clicked on.  This variable affects both
144 @code{mouse-yank-primary} and @code{mouse-yank-at-click}.
146 @findex mouse-save-then-kill
147   Clicking with the right mouse button, @kbd{Mouse-3}, runs the
148 command @code{mouse-save-then-kill}.  This performs several actions
149 depending on where you click and the status of the region:
151 @itemize @bullet
152 @item
153 If no region is active, clicking @kbd{Mouse-3} activates the region,
154 placing the mark where point was and point at the clicked position.
156 @item
157 If a region is active, clicking @kbd{Mouse-3} adjusts the nearer end
158 of the region by moving it to the clicked position.  The adjusted
159 region's text is copied to the kill ring; if the text in the original
160 region was already on the kill ring, it replaces it there.
162 @item
163 If you originally specified the region using a double or triple
164 @kbd{Mouse-1}, so that the region is defined to consist of entire
165 words or lines (@pxref{Word and Line Mouse}), then adjusting the
166 region with @kbd{Mouse-3} also proceeds by entire words or lines.
168 @item
169 If you use @kbd{Mouse-3} a second time consecutively, at the same
170 place, that kills the region already selected.  Thus, the simplest way
171 to kill text with the mouse is to click @kbd{Mouse-1} at one end, then
172 click @kbd{Mouse-3} twice at the other end.  To copy the text into the
173 kill ring without deleting it from the buffer, press @kbd{Mouse-3}
174 just once---or just drag across the text with @kbd{Mouse-1}.  Then you
175 can copy it elsewhere by yanking it.
176 @end itemize
178   The @code{mouse-save-then-kill} command also obeys the variable
179 @code{mouse-drag-copy-region} (described above).  If the value is
180 non-@code{nil}, then whenever the command sets or adjusts the active
181 region, the text in the region is also added to the kill ring.  If the
182 latest kill ring entry had been added the same way, that entry is
183 replaced rather than making a new entry.
185   Whenever you set the region using any of the mouse commands
186 described above, the mark will be deactivated by any subsequent
187 unshifted cursor motion command, in addition to the usual ways of
188 deactivating the mark.  @xref{Shift Selection}.
190 @cindex mouse wheel
191 @findex mouse-wheel-mode
192 @cindex Mouse Wheel minor mode
193 @cindex mode, Mouse Wheel
194 @vindex mouse-wheel-follow-mouse
195 @vindex mouse-wheel-scroll-amount
196 @vindex mouse-wheel-progressive-speed
197   Some mice have a ``wheel'' which can be used for scrolling.  Emacs
198 supports scrolling windows with the mouse wheel, by default, on most
199 graphical displays.  To toggle this feature, use @kbd{M-x
200 mouse-wheel-mode}.  The variables @code{mouse-wheel-follow-mouse} and
201 @code{mouse-wheel-scroll-amount} determine where and by how much
202 buffers are scrolled.  The variable
203 @code{mouse-wheel-progressive-speed} determines whether the scroll
204 speed is linked to how fast you move the wheel.
206 @node Word and Line Mouse
207 @section Mouse Commands for Words and Lines
209   These variants of @kbd{Mouse-1} select entire words or lines at a
210 time.  Emacs activates the region around the selected text, which is
211 also copied to the kill ring.
213 @table @kbd
214 @item Double-Mouse-1
215 Select the text around the word which you click on.
217 Double-clicking on a character with ``symbol'' syntax (such as
218 underscore, in C mode) selects the symbol surrounding that character.
219 Double-clicking on a character with open- or close-parenthesis syntax
220 selects the parenthetical grouping which that character starts or
221 ends.  Double-clicking on a character with string-delimiter syntax
222 (such as a single-quote or double-quote in C) selects the string
223 constant (Emacs uses heuristics to figure out whether that character
224 is the beginning or the end of it).
226 @item Double-Drag-Mouse-1
227 Select the text you drag across, in the form of whole words.
229 @item Triple-Mouse-1
230 Select the line you click on.
232 @item Triple-Drag-Mouse-1
233 Select the text you drag across, in the form of whole lines.
234 @end table
236 @node Mouse References
237 @section Following References with the Mouse
238 @kindex Mouse-1 @r{(selection)}
239 @kindex Mouse-2 @r{(selection)}
240 @cindex hyperlinks
241 @cindex links
242 @cindex text buttons
243 @cindex buttons
245 @vindex mouse-highlight
246   Some Emacs buffers include @dfn{buttons}, or @dfn{hyperlinks}:
247 pieces of text that perform some action (e.g.@: following a reference)
248 when activated (e.g.@: by clicking on them).  Usually, a button's text
249 is visually highlighted: it is underlined, or a box is drawn around
250 it.  If you move the mouse over a button, the shape of the mouse
251 cursor changes and the button lights up.  If you change the variable
252 @code{mouse-highlight} to @code{nil}, Emacs disables this
253 highlighting.
255   You can activate a button by moving point to it and typing
256 @key{RET}, or by clicking either @kbd{Mouse-1} or @kbd{Mouse-2} on the
257 button.  For example, in a Dired buffer, each file name is a button;
258 activating it causes Emacs to visit that file (@pxref{Dired}).  In a
259 @file{*Compilation*} buffer, each error message is a button, and
260 activating it visits the source code for that error
261 (@pxref{Compilation}).
263   Although clicking @kbd{Mouse-1} on a button usually activates the
264 button, if you hold the mouse button down for a period of time before
265 releasing it (specifically, for more than 450 milliseconds), then
266 Emacs moves point where you clicked, without activating the button.
267 In this way, you can use the mouse to move point over a button without
268 activating it.  Dragging the mouse over or onto a button has its usual
269 behavior of setting the region, and does not activate the button.
271   You can change how @kbd{Mouse-1} applies to buttons by customizing
272 the variable @code{mouse-1-click-follows-link}.  If the value is a
273 positive integer, that determines how long you need to hold the mouse
274 button down for, in milliseconds, to cancel button activation; the
275 default is 450, as described in the previous paragraph.  If the value
276 is @code{nil}, @kbd{Mouse-1} just sets point where you clicked, and
277 does not activate buttons.  If the value is @code{double}, double
278 clicks activate buttons but single clicks just set point.
280 @vindex mouse-1-click-in-non-selected-windows
281   Normally, @kbd{Mouse-1} on a button activates the button even if it
282 is in a non-selected window.  If you change the variable
283 @code{mouse-1-click-in-non-selected-windows} to @code{nil},
284 @kbd{Mouse-1} on a button in an unselected window moves point to the
285 clicked position and selects that window, without activating the
286 button.
288 @node Menu Mouse Clicks
289 @section Mouse Clicks for Menus
291   Several mouse clicks with the @key{CTRL} and @key{SHIFT} modifiers
292 bring up menus.
294 @table @kbd
295 @item C-Mouse-1
296 @kindex C-Mouse-1
297 This menu is for selecting a buffer.
299 The MSB (``mouse select buffer'') global minor mode makes this
300 menu smarter and more customizable.  @xref{Buffer Menus}.
302 @item C-Mouse-2
303 @kindex C-Mouse-2
304 This menu contains entries for examining faces and other text
305 properties, and well as for setting them (the latter is mainly useful
306 when editing enriched text; @pxref{Enriched Text}).
308 @item C-Mouse-3
309 @kindex C-Mouse-3
310 This menu is mode-specific.  For most modes if Menu-bar mode is on,
311 this menu has the same items as all the mode-specific menu-bar menus
312 put together.  Some modes may specify a different menu for this
313 button.  If Menu Bar mode is off, this menu contains all the items
314 which would be present in the menu bar---not just the mode-specific
315 ones---so that you can access them without having to display the menu
316 bar.
318 @item S-Mouse-1
319 This menu is for changing the default face within the window's buffer.
320 @xref{Text Scale}.
321 @end table
323   Some graphical applications use @kbd{Mouse-3} for a mode-specific
324 menu.  If you prefer @kbd{Mouse-3} in Emacs to bring up such a menu
325 instead of running the @code{mouse-save-then-kill} command, rebind
326 @kbd{Mouse-3} by adding the following line to your init file
327 (@pxref{Init Rebinding}):
329 @smallexample
330 (global-set-key [mouse-3] 'mouse-popup-menubar-stuff)
331 @end smallexample
333 @node Mode Line Mouse
334 @section Mode Line Mouse Commands
335 @cindex mode line, mouse
336 @cindex mouse on mode line
338   You can use mouse clicks on window mode lines to select and manipulate
339 windows.
341   Some areas of the mode line, such as the buffer name, and major and minor
342 mode names, have their own special mouse bindings.  These areas are
343 highlighted when you hold the mouse over them, and information about
344 the special bindings will be displayed (@pxref{Tooltips}).  This
345 section's commands do not apply in those areas.
347 @table @kbd
348 @item Mouse-1
349 @kindex Mouse-1 @r{(mode line)}
350 @kbd{Mouse-1} on a mode line selects the window it belongs to.  By
351 dragging @kbd{Mouse-1} on the mode line, you can move it, thus
352 changing the height of the windows above and below.  Changing heights
353 with the mouse in this way never deletes windows, it just refuses to
354 make any window smaller than the minimum height.
356 @item Mouse-2
357 @kindex Mouse-2 @r{(mode line)}
358 @kbd{Mouse-2} on a mode line expands that window to fill its frame.
360 @item Mouse-3
361 @kindex Mouse-3 @r{(mode line)}
362 @kbd{Mouse-3} on a mode line deletes the window it belongs to.  If the
363 frame has only one window, it does nothing.
365 @item C-Mouse-2
366 @kindex C-mouse-2 @r{(mode line)}
367 @kbd{C-Mouse-2} on a mode line splits that window, producing two
368 side-by-side windows with the boundary running through the click
369 position (@pxref{Split Window}).
370 @end table
372 @kindex Mouse-1 @r{(scroll bar)}
373   Furthermore, by clicking and dragging @kbd{Mouse-1} on the divider
374 between two side-by-side mode lines, you can move the vertical
375 boundary to the left or right.
377 @node Creating Frames
378 @section Creating Frames
379 @cindex creating frames
381 @kindex C-x 5
382   The prefix key @kbd{C-x 5} is analogous to @kbd{C-x 4}.  Whereas
383 each @kbd{C-x 4} command pops up a buffer in a different window in the
384 selected frame (@pxref{Pop Up Window}), the @kbd{C-x 5} commands use a
385 different frame.  If an existing visible or iconified (``minimized'')
386 frame already displays the requested buffer, that frame is raised and
387 deiconified (``un-minimized''); otherwise, a new frame is created on
388 the current display terminal.
390   The various @kbd{C-x 5} commands differ in how they find or create the
391 buffer to select:
393 @table @kbd
394 @item C-x 5 2
395 @kindex C-x 5 2
396 @findex make-frame-command
397 Create a new frame (@code{make-frame-command}).
398 @item C-x 5 b @var{bufname} @key{RET}
399 Select buffer @var{bufname} in another frame.  This runs
400 @code{switch-to-buffer-other-frame}.
401 @item C-x 5 f @var{filename} @key{RET}
402 Visit file @var{filename} and select its buffer in another frame.  This
403 runs @code{find-file-other-frame}.  @xref{Visiting}.
404 @item C-x 5 d @var{directory} @key{RET}
405 Select a Dired buffer for directory @var{directory} in another frame.
406 This runs @code{dired-other-frame}.  @xref{Dired}.
407 @item C-x 5 m
408 Start composing a mail message in another frame.  This runs
409 @code{mail-other-frame}.  It is the other-frame variant of @kbd{C-x m}.
410 @xref{Sending Mail}.
411 @item C-x 5 .
412 Find a tag in the current tag table in another frame.  This runs
413 @code{find-tag-other-frame}, the multiple-frame variant of @kbd{M-.}.
414 @xref{Tags}.
415 @item C-x 5 r @var{filename} @key{RET}
416 @kindex C-x 5 r
417 @findex find-file-read-only-other-frame
418 Visit file @var{filename} read-only, and select its buffer in another
419 frame.  This runs @code{find-file-read-only-other-frame}.
420 @xref{Visiting}.
421 @end table
423   You can control the appearance and behavior of the newly-created
424 frames by specifying @dfn{frame parameters}.  @xref{Frame Parameters}.
426 @node Frame Commands
427 @section Frame Commands
429   The following commands are used to delete and operate on frames:
431 @table @kbd
432 @item C-x 5 0
433 @kindex C-x 5 0
434 @findex delete-frame
435 Delete the selected frame (@code{delete-frame}).  This signals an
436 error if there is only one frame.
438 @item C-z
439 @kindex C-z @r{(X windows)}
440 @findex suspend-frame
441 Minimize (or ``iconify) the selected Emacs frame
442 (@code{suspend-frame}).  @xref{Exiting}.
444 @item C-x 5 o
445 @kindex C-x 5 o
446 @findex other-frame
447 Select another frame, and raise it.  If you repeat this command, it
448 cycles through all the frames on your terminal.
450 @item C-x 5 1
451 @kindex C-x 5 1
452 @findex delete-other-frames
453 Delete all frames on the current terminal, except the selected one.
454 @end table
456   The @kbd{C-x 5 0} (@code{delete-frame}) command deletes the selected
457 frame.  However, it will refuse to delete the last frame in an Emacs
458 session, to prevent you from losing the ability to interact with the
459 Emacs session.  Note that when Emacs is run as a daemon (@pxref{Emacs
460 Server}), there is always a ``virtual frame'' that remains after all
461 the ordinary, interactive frames are deleted.  In this case, @kbd{C-x
462 5 0} can delete the last interactive frame; you can use
463 @command{emacsclient} to reconnect to the Emacs session.
465   The @kbd{C-x 5 1} (@code{delete-other-frames}) command deletes all
466 other frames on the current terminal (this terminal refers to either a
467 graphical display, or a text terminal; @pxref{Non-Window Terminals}).
468 If the Emacs session has frames open on other graphical displays or
469 text terminals, those are not deleted.
471 @vindex focus-follows-mouse
472   The @kbd{C-x 5 o} (@code{other-frame}) command selects the next
473 frame on the current terminal.  If you are using Emacs on the X Window
474 System with a window manager that selects (or @dfn{gives focus to})
475 whatever frame the mouse cursor is over, you have to change the
476 variable @code{focus-follows-mouse} to @code{t} in order for this
477 command to work properly.  Then invoking @kbd{C-x 5 o} will also warp
478 the mouse cursor to the chosen frame.
480 @node Fonts
481 @section Fonts
482 @cindex fonts
484   By default, Emacs displays text on graphical displays using a
485 12-point monospace font.  There are several different ways to specify
486 a different font:
488 @itemize
489 @item
490 Click on @samp{Set Default Font} in the @samp{Options} menu.  To save
491 this for future sessions, click on @samp{Save Options} in the
492 @samp{Options} menu.
494 @item
495 Add a line to your init file, modifying the variable
496 @code{default-frame-alist} to specify the @code{font} parameter
497 (@pxref{Frame Parameters}), like this:
499 @example
500 (add-to-list 'default-frame-alist '(font . "DejaVu Sans Mono-10"))
501 @end example
503 @cindex X defaults file
504 @cindex X resources file
505 @item
506 Add an @samp{emacs.font} X resource setting to your X resource file,
507 like this:
509 @example
510 emacs.font: DejaVu Sans Mono-12
511 @end example
513 @noindent
514 You must restart X, or use the @command{xrdb} command, for the X
515 resources file to take effect.  @xref{Resources}.  Do not quote
516 font names in X resource files.
518 @item
519 If you are running Emacs on the GNOME desktop, you can tell Emacs to
520 use the default system font by setting the variable
521 @code{font-use-system-font} to @code{t} (the default is @code{nil}).
522 For this to work, Emacs must have been compiled with Gconf support.
524 @item
525 Use the command line option @samp{-fn} (or @samp{--font}).  @xref{Font
527 @end itemize
529   To check what font you're currently using, the @kbd{C-u C-x =}
530 command can be helpful.  It describes the character at point, and
531 names the font that it's rendered in.
533 @cindex fontconfig
534   On X, there are four different ways to express a ``font name''.  The
535 first is to use a @dfn{Fontconfig pattern}.  Fontconfig patterns have
536 the following form:
538 @example
539 @var{fontname}[-@var{fontsize}][:@var{name1}=@var{values1}][:@var{name2}=@var{values2}]...
540 @end example
542 @noindent
543 Within this format, any of the elements in braces may be omitted.
544 Here, @var{fontname} is the @dfn{family name} of the font, such as
545 @samp{Monospace} or @samp{DejaVu Sans Mono}; @var{fontsize} is the
546 @dfn{point size} of the font (one @dfn{printer's point} is about 1/72
547 of an inch); and the @samp{@var{name}=@var{values}} entries specify
548 settings such as the slant and weight of the font.  Each @var{values}
549 may be a single value, or a list of values separated by commas.  In
550 addition, some property values are valid with only one kind of
551 property name, in which case the @samp{@var{name}=} part may be
552 omitted.
554 Here is a list of common font properties:
556 @table @samp
557 @item slant
558 One of @samp{italic}, @samp{oblique}, or @samp{roman}.
560 @item weight
561 One of @samp{light}, @samp{medium}, @samp{demibold}, @samp{bold} or
562 @samp{black}.
564 @item style
565 Some fonts define special styles which are a combination of slant and
566 weight.  For instance, @samp{Dejavu Sans} defines the @samp{book}
567 style, which overrides the slant and weight properties.
569 @item width
570 One of @samp{condensed}, @samp{normal}, or @samp{expanded}.
572 @item spacing
573 One of @samp{monospace}, @samp{proportional}, @samp{dual-width}, or
574 @samp{charcell}.
575 @end table
577 @noindent
578 Here are some examples of Fontconfig patterns:
580 @example
581 Monospace
582 Monospace-12
583 Monospace-12:bold
584 DejaVu Sans Mono:bold:italic
585 Monospace-12:weight=bold:slant=italic
586 @end example
588 For a more detailed description of Fontconfig patterns, see the
589 Fontconfig manual, which is distributed with Fontconfig and available
590 online at @url{http://fontconfig.org/fontconfig-user.html}.
592 @cindex GTK font pattern
593   The second way to specify a font is to use a @dfn{GTK font pattern}.
594 These have the syntax
596 @example
597 @var{fontname} [@var{properties}] [@var{fontsize}]
598 @end example
600 @noindent
601 where @var{fontname} is the family name, @var{properties} is a list of
602 property values separated by spaces, and @var{fontsize} is the point
603 size.  The properties that you may specify for GTK font patterns are
604 as follows:
606 @itemize
607 @item
608 Slant properties: @samp{Italic} or @samp{Oblique}.  If omitted, the
609 default (roman) slant is implied.
610 @item
611 Weight properties: @samp{Bold}, @samp{Book}, @samp{Light},
612 @samp{Medium}, @samp{Semi-bold}, or @samp{Ultra-light}.  If omitted,
613 @samp{Medium} weight is implied.
614 @item
615 Width properties: @samp{Semi-Condensed} or @samp{Condensed}.  If
616 omitted, a default width is used.
617 @end itemize
619 @noindent
620 Here are some examples of GTK font patterns:
622 @example
623 Monospace 12
624 Monospace Bold Italic 12
625 @end example
627 @cindex XLFD
628 @cindex X Logical Font Description
629   The third way to specify a font is to use an @dfn{XLFD} (@dfn{X
630 Logical Font Description}).  This is the traditional method for
631 specifying fonts under X.  Each XLFD consists of fourteen words or
632 numbers, separated by dashes, like this:
634 @example
635 -misc-fixed-medium-r-semicondensed--13-*-*-*-c-60-iso8859-1
636 @end example
638 @noindent
639 A wildcard character (@samp{*}) in an XLFD matches any sequence of
640 characters (including none), and @samp{?} matches any single
641 character.  However, matching is implementation-dependent, and can be
642 inaccurate when wildcards match dashes in a long name.  For reliable
643 results, supply all 14 dashes and use wildcards only within a field.
644 Case is insignificant in an XLFD.  The syntax for an XLFD is as
645 follows:
647 @example
648 -@var{maker}-@var{family}-@var{weight}-@var{slant}-@var{widthtype}-@var{style}@dots{}
649 @dots{}-@var{pixels}-@var{height}-@var{horiz}-@var{vert}-@var{spacing}-@var{width}-@var{registry}-@var{encoding}
650 @end example
652 @noindent
653 The entries have the following meanings:
655 @table @var
656 @item maker
657 The name of the font manufacturer.
658 @item family
659 The name of the font family (e.g.@: @samp{courier}).
660 @item weight
661 The font weight---normally either @samp{bold}, @samp{medium} or
662 @samp{light}.  Some font names support other values.
663 @item slant
664 The font slant---normally @samp{r} (roman), @samp{i} (italic),
665 @samp{o} (oblique), @samp{ri} (reverse italic), or @samp{ot} (other).
666 Some font names support other values.
667 @item widthtype
668 The font width---normally @samp{normal}, @samp{condensed},
669 @samp{semicondensed}, or @samp{extended}.  Some font names support
670 other values.
671 @item style
672 An optional additional style name.  Usually it is empty---most XLFDs
673 have two hyphens in a row at this point.
674 @item pixels
675 The font height, in pixels.
676 @item height
677 The font height on the screen, measured in tenths of a printer's
678 point.  This is the point size of the font, times ten.  For a given
679 vertical resolution, @var{height} and @var{pixels} are proportional;
680 therefore, it is common to specify just one of them and use @samp{*}
681 for the other.
682 @item horiz
683 The horizontal resolution, in pixels per inch, of the screen for which
684 the font is intended.
685 @item vert
686 The vertical resolution, in pixels per inch, of the screen for which
687 the font is intended.  Normally the resolution of the fonts on your
688 system is the right value for your screen; therefore, you normally
689 specify @samp{*} for this and @var{horiz}.
690 @item spacing
691 This is @samp{m} (monospace), @samp{p} (proportional) or @samp{c}
692 (character cell).
693 @item width
694 The average character width, in pixels, multiplied by ten.
695 @item registry
696 @itemx encoding
697 The X font character set that the font depicts.  (X font character
698 sets are not the same as Emacs character sets, but they are similar.)
699 You can use the @command{xfontsel} program to check which choices you
700 have.  Normally you should use @samp{iso8859} for @var{registry} and
701 @samp{1} for @var{encoding}.
702 @end table
704   The fourth and final method of specifying a font is to use a ``font
705 nickname''.  Certain fonts have shorter nicknames, which you can use
706 instead of a normal font specification.  For instance, @samp{6x13} is
707 equivalent to
709 @example
710 -misc-fixed-medium-r-semicondensed--13-*-*-*-c-60-iso8859-1
711 @end example
713 @cindex client-side fonts
714 @cindex server-side fonts
715   On X, Emacs recognizes two types of fonts: @dfn{client-side} fonts,
716 which are provided by the Xft and Fontconfig libraries, and
717 @dfn{server-side} fonts, which are provided by the X server itself.
718 Most client-side fonts support advanced font features such as
719 antialiasing and subpixel hinting, while server-side fonts do not.
720 Fontconfig and GTK patterns match only client-side fonts.
722 @cindex listing system fonts
723   You will probably want to use a fixed-width default font---that is,
724 a font in which all characters have the same width.  For Xft and
725 Fontconfig fonts, you can use the @command{fc-list} command to list
726 the available fixed-width fonts, like this:
728 @example
729 fc-list :spacing=mono fc-list :spacing=charcell
730 @end example
732 @noindent
733 For server-side X fonts, you can use the @command{xlsfonts} program to
734 list the available fixed-width fonts, like this:
736 @example
737 xlsfonts -fn '*x*' | egrep "^[0-9]+x[0-9]+"
738 xlsfonts -fn '*-*-*-*-*-*-*-*-*-*-*-m*'
739 xlsfonts -fn '*-*-*-*-*-*-*-*-*-*-*-c*'
740 @end example
742 @noindent
743 Any font with @samp{m} or @samp{c} in the @var{spacing} field of the
744 XLFD is a fixed-width font.  To see what a particular font looks like,
745 use the @command{xfd} command.  For example:
747 @example
748 xfd -fn 6x13
749 @end example
751 @noindent
752 displays the entire font @samp{6x13}.
754   While running Emacs, you can also set the font of a specific kind of
755 text (@pxref{Faces}), or a particular frame (@pxref{Frame
756 Parameters}).
758 @node Speedbar
759 @section Speedbar Frames
760 @cindex speedbar
762 @cindex attached frame (of speedbar)
763   The @dfn{speedbar} is a special frame for conveniently navigating in
764 or operating on another frame.  The speedbar, when it exists, is
765 always associated with a specific frame, called its @dfn{attached
766 frame}; all speedbar operations act on that frame.
768   Type @kbd{M-x speedbar} to create the speedbar and associate it with
769 the current frame.  To dismiss the speedbar, type @kbd{M-x speedbar}
770 again, or select the speedbar and type @kbd{q}.  (You can also delete
771 the speedbar frame like any other Emacs frame.)  If you wish to
772 associate the speedbar with a different frame, dismiss it and call
773 @kbd{M-x speedbar} from that frame.
775   The speedbar can operate in various modes.  Its default mode is
776 @dfn{File Display} mode, which shows the files in the current
777 directory of the selected window of the attached frame, one file per
778 line.  Clicking on a file name visits that file in the selected window
779 of the attached frame, and clicking on a directory name shows that
780 directory in the speedbar (@pxref{Mouse References}).  Each line also
781 has a box, @samp{[+]} or @samp{<+>}, that you can click on to
782 @dfn{expand} the contents of that item.  Expanding a directory adds
783 the contents of that directory to the speedbar display, underneath the
784 directory's own line.  Expanding an ordinary file adds a list of the
785 tags in that file to the speedbar display; you can click on a tag name
786 to jump to that tag in the selected window of the attached frame.
787 When a file or directory is expanded, the @samp{[+]} changes to
788 @samp{[-]}; you can click on that box to @dfn{contract} the item,
789 hiding its contents.
791   You navigate through the speedbar using the keyboard, too.  Typing
792 @kbd{RET} while point is on a line in the speedbar is equivalent to
793 clicking the item on the current line, and @kbd{SPC} expands or
794 contracts the item.  @kbd{U} displays the parent directory of the
795 current directory.  To copy, delete, or rename the file on the current
796 line, type @kbd{C}, @kbd{D}, and @kbd{R} respectively.  To create a
797 new directory, type @kbd{M}.
799   Another general-purpose speedbar mode is @dfn{Buffer Display} mode;
800 in this mode, the speedbar displays a list of Emacs buffers.  To
801 switch to this mode, type @kbd{b} in the speedbar.  To return to File
802 Display mode, type @kbd{f}.  You can also change the display mode by
803 clicking @kbd{mouse-3} anywhere in the speedbar window (or
804 @kbd{mouse-1} on the mode-line) and selecting @samp{Displays} in the
805 pop-up menu.
807   Some major modes, including Rmail mode, Info, and GUD, have
808 specialized ways of putting useful items into the speedbar for you to
809 select.  For example, in Rmail mode, the speedbar shows a list of Rmail
810 files, and lets you move the current message to another Rmail file by
811 clicking on its @samp{<M>} box.
813   For more details on using and programming the speedbar, @xref{Top,
814 Speedbar,,speedbar, Speedbar Manual}.
816 @node Multiple Displays
817 @section Multiple Displays
818 @cindex multiple displays
820   A single Emacs can talk to more than one X display.  Initially, Emacs
821 uses just one display---the one specified with the @env{DISPLAY}
822 environment variable or with the @samp{--display} option (@pxref{Initial
823 Options}).  To connect to another display, use the command
824 @code{make-frame-on-display}:
826 @findex make-frame-on-display
827 @table @kbd
828 @item M-x make-frame-on-display @key{RET} @var{display} @key{RET}
829 Create a new frame on display @var{display}.
830 @end table
832   A single X server can handle more than one screen.  When you open
833 frames on two screens belonging to one server, Emacs knows they share a
834 single keyboard, and it treats all the commands arriving from these
835 screens as a single stream of input.
837   When you open frames on different X servers, Emacs makes a separate
838 input stream for each server.  Each server also has its own selected
839 frame.  The commands you enter with a particular X server apply to
840 that server's selected frame.
842 @node Frame Parameters
843 @section Frame Parameters
844 @cindex default-frame-alist
846   You can control the default appearance and behavior of all frames by
847 specifying a default list of @dfn{frame parameters} in the variable
848 @code{default-frame-alist}.  Its value should be a list of entries,
849 each specifying a parameter name and a value for that parameter.
850 These entries take effect whenever Emacs creates a new frame,
851 including the initial frame.
853 @cindex frame size, specifying default
854   For example, you can add the following lines to your init file
855 (@pxref{Init File}) to set the default frame width to 90 character
856 columns, the default frame height to 40 character rows, and the
857 default font to @samp{Monospace-10}:
859 @example
860 (add-to-list 'default-frame-alist '(width  . 90))
861 (add-to-list 'default-frame-alist '(height . 40))
862 (add-to-list 'default-frame-alist '(font . "Monospace-10"))
863 @end example
865   For a list of frame parameters and their effects, see @ref{Frame
866 Parameters,,, elisp, The Emacs Lisp Reference Manual}.
868 @cindex initial-frame-alist
869   You can also specify a list of frame parameters which apply to just
870 the initial frame, by customizing the variable
871 @code{initial-frame-alist}.
873   If Emacs is compiled to use an X toolkit, frame parameters that
874 specify colors and fonts don't affect menus and the menu bar, since
875 those are drawn by the toolkit and not directly by Emacs.
877 @node Scroll Bars
878 @section Scroll Bars
879 @cindex Scroll Bar mode
880 @cindex mode, Scroll Bar
882   On graphical displays, there is a @dfn{scroll bar} on the side of
883 each Emacs window.  Clicking @kbd{Mouse-1} on the scroll bar's up and
884 down buttons scrolls the window by one line at a time.  Clicking
885 @kbd{Mouse-1} above or below the scroll bar's inner box scrolls the
886 window by nearly the entire height of the window, like @kbd{M-v} and
887 @kbd{C-v} respectively (@pxref{Moving Point}).  Dragging the inner box
888 scrolls continuously.
890   If Emacs is compiled on the X Window System without X toolkit
891 support, the scroll bar behaves differently.  Clicking @kbd{Mouse-1}
892 anywhere on the scroll bar scrolls forward like @kbd{C-v}, while
893 @kbd{Mouse-3} scrolls backward like @kbd{M-v}.  Clicking @kbd{Mouse-2}
894 in the scroll bar lets you drag the inner box up and down.
896 @findex scroll-bar-mode
897 @findex toggle-scroll-bar
898   To toggle the use of scroll bars, type @kbd{M-x scroll-bar-mode}.
899 This command applies to all frames, including frames yet to be
900 created.  To toggle scroll bars for just the selected frame, use the
901 command @kbd{M-x toggle-scroll-bar}.
903 @vindex scroll-bar-mode
904   To control the use of scroll bars at startup, customize the variable
905 @code{scroll-bar-mode}.  Its value should be either @code{right} (put
906 scroll bars on the right side of windows), @code{left} (put them on
907 the left), or @code{nil} (disable scroll bars).  By default, Emacs
908 puts scroll bars on the right if it was compiled with GTK+ support on
909 the X Window System, and on MS-Windows or Mac OS; Emacs puts scroll
910 bars on the left if compiled on the X Window System without GTK+
911 support (following the old convention for X applications).
913 @vindex scroll-bar-width
914 @cindex width of the scroll bar
915   You can also use the X resource @samp{verticalScrollBars} to enable
916 or disable the scroll bars (@pxref{Resources}).  To control the scroll
917 bar width, change the @code{scroll-bar-width} frame parameter
918 (@pxref{Frame Parameters,,, elisp, The Emacs Lisp Reference Manual}).
920 @node Drag and Drop
921 @section Drag and Drop
922 @cindex drag and drop
924   In most graphical desktop environments, Emacs has basic support for
925 @dfn{drag and drop} operations.  For instance, dropping text onto an
926 Emacs frame inserts the text where it is dropped.  Dropping a file
927 onto an Emacs frame visits that file.  As a special case, dropping the
928 file on a Dired buffer moves or copies the file (according to the
929 conventions of the application it came from) into the directory
930 displayed in that buffer.
932 @vindex dnd-open-file-other-window
933   Dropping a file normally visits it in the window you drop it on.  If
934 you prefer to visit the file in a new window in such cases, customize
935 the variable @code{dnd-open-file-other-window}.
937   The XDND and Motif drag and drop protocols, and the old KDE 1.x
938 protocol, are currently supported.
940 @node Menu Bars
941 @section Menu Bars
942 @cindex Menu Bar mode
943 @cindex mode, Menu Bar
944 @findex menu-bar-mode
945 @vindex menu-bar-mode
947   You can toggle the use of menu bars with @kbd{M-x menu-bar-mode}.
948 With no argument, this command toggles Menu Bar mode, a global minor
949 mode.  With an argument, the command turns Menu Bar mode on if the
950 argument is positive, off if the argument is not positive.  To control
951 the use of menu bars at startup, customize the variable
952 @code{menu-bar-mode}.
954 @kindex C-Mouse-3 @r{(when menu bar is disabled)}
955   Expert users often turn off the menu bar, especially on text
956 terminals, where this makes one additional line available for text.
957 If the menu bar is off, you can still pop up a menu of its contents
958 with @kbd{C-Mouse-3} on a display which supports pop-up menus.
959 @xref{Menu Mouse Clicks}.
961   @xref{Menu Bar}, for information on how to invoke commands with the
962 menu bar.  @xref{X Resources}, for how to customize the menu bar
963 menus' visual appearance.
965 @node Tool Bars
966 @section Tool Bars
967 @cindex Tool Bar mode
968 @cindex mode, Tool Bar
969 @cindex icons, toolbar
971   On graphical displays, Emacs puts a @dfn{tool bar} at the top of
972 each frame, just below the menu bar.  This is a row of icons which you
973 can click on with the mouse to invoke various commands.
975   The global (default) tool bar contains general commands.  Some major
976 modes define their own tool bars; whenever a buffer with such a major
977 mode is current, the mode's tool bar replaces the global tool bar.
979 @findex tool-bar-mode
980 @vindex tool-bar-mode
981   To toggle the use of tool bars, type @kbd{M-x tool-bar-mode}.  This
982 command applies to all frames, including frames yet to be created.  To
983 control the use of tool bars at startup, customize the variable
984 @code{tool-bar-mode}.
986 @vindex tool-bar-style
987 @cindex Tool Bar style
988   When Emacs is compiled with GTK+ support, each tool bar item can
989 consist of an image, or a text label, or both.  By default, Emacs
990 follows the Gnome desktop's tool bar style setting; if none is
991 defined, it displays tool bar items as just images.  To impose a
992 specific tool bar style, customize the variable @code{tool-bar-style}.
994 @cindex Tool Bar position
995   You can also control the placement of the tool bar for the GTK+ tool
996 bar with the frame parameter @code{tool-bar-position}.  @xref{Frame
997 Parameters,,, elisp, The Emacs Lisp Reference Manual}.
999 @node Dialog Boxes
1000 @section Using Dialog Boxes
1001 @cindex dialog boxes
1003 @vindex use-dialog-box
1004   A dialog box is a special kind of menu for asking you a yes-or-no
1005 question or some other special question.  Many Emacs commands use a
1006 dialog box to ask a yes-or-no question, if you used the mouse to
1007 invoke the command that led to the question.
1009   To disable the use of dialog boxes, change the variable
1010 @code{use-dialog-box} to @code{nil}.  In that case, Emacs always
1011 performs yes-or-no prompts using the echo area and keyboard input.
1012 This variable also controls whether to use file selection windows (but
1013 those are not supported on all platforms).
1015 @vindex use-file-dialog
1016 @cindex file selection dialog, how to disable
1017   A file selection window is a special kind of dialog box for asking
1018 for file names.  You can customize the variable @code{use-file-dialog}
1019 to suppress the use of file selection windows, even if you still want
1020 other kinds of dialogs.  This variable has no effect if you have
1021 suppressed all dialog boxes with the variable @code{use-dialog-box}.
1023 @vindex x-gtk-show-hidden-files
1024 @vindex x-gtk-file-dialog-help-text
1025 @cindex hidden files, in GTK+ file chooser
1026 @cindex help text, in GTK+ file chooser
1027   When Emacs is compiled with GTK+ support, it uses the GTK+ ``file
1028 chooser'' dialog.  Emacs adds an additional toggle button to this
1029 dialog, which you can use to enable or disable the display of hidden
1030 files (files starting with a dot) in that dialog.  If you want this
1031 toggle to be activated by default, change the variable
1032 @code{x-gtk-show-hidden-files} to @code{t}.  In addition, Emacs adds
1033 help text to the GTK+ file chooser dialog; to disable this help text,
1034 change the variable @code{x-gtk-file-dialog-help-text} to @code{nil}.
1036 @node Tooltips
1037 @section Tooltips
1038 @cindex tooltips
1040   @dfn{Tooltips} are small windows that display text information at
1041 the current mouse position.  They activate when there is a pause in
1042 mouse movement over some significant piece of text in a window, or the
1043 mode line, or some other part of the Emacs frame such as a tool bar
1044 button or menu item.
1046 @findex tooltip-mode
1047   You can toggle the use of tooltips with the command @kbd{M-x
1048 tooltip-mode}.  When Tooltip mode is disabled, the help text is
1049 displayed in the echo area instead.  To control the use of tooltips at
1050 startup, customize the variable @code{tooltip-mode}.
1052 @vindex tooltip-delay
1053   The variables @code{tooltip-delay} specifies how long Emacs should
1054 wait before displaying a tooltip.  For additional customization
1055 options for displaying tooltips, use @kbd{M-x customize-group
1056 @key{RET} tooltip @key{RET}}.
1058 @vindex x-gtk-use-system-tooltips
1059   If Emacs is built with GTK+ support, it displays tooltips via GTK+,
1060 using the default appearance of GTK+ tooltips.  To disable this,
1061 change the variable @code{x-gtk-use-system-tooltips} to @code{nil}.
1062 If you do this, or if Emacs is built without GTK+ support, most
1063 attributes of the tooltip text are specified by the @code{tooltip}
1064 face, and by X resources (@pxref{X Resources}).
1066   @dfn{GUD tooltips} are special tooltips that show the values of
1067 variables when debugging a program with GUD.  @xref{Debugger
1068 Operation}.
1070 @node Mouse Avoidance
1071 @section Mouse Avoidance
1072 @cindex avoiding mouse in the way of your typing
1073 @cindex mouse avoidance
1075   On graphical terminals, the mouse pointer may obscure the text in
1076 the Emacs frame.  Emacs provides two methods to avoid this problem.
1078 @vindex make-pointer-invisible
1079   Firstly, Emacs hides the mouse pointer each time you type a
1080 self-inserting character, if the pointer lies inside an Emacs frame;
1081 moving the mouse pointer makes it visible again.  To disable this
1082 feature, set the variable @code{make-pointer-invisible} to @code{nil}.
1084 @vindex mouse-avoidance-mode
1085   Secondly, you can use Mouse Avoidance mode, a minor mode, to keep
1086 the mouse pointer away from point.  To use Mouse Avoidance mode,
1087 customize the variable @code{mouse-avoidance-mode}.  You can set this
1088 to various values to move the mouse in several ways:
1090 @table @code
1091 @item banish
1092 Move the mouse to the upper-right corner on any key-press;
1093 @item exile
1094 Move the mouse to the corner only if the cursor gets too close,
1095 and allow it to return once the cursor is out of the way;
1096 @item jump
1097 If the cursor gets too close to the mouse, displace the mouse
1098 a random distance & direction;
1099 @item animate
1100 As @code{jump}, but shows steps along the way for illusion of motion;
1101 @item cat-and-mouse
1102 The same as @code{animate};
1103 @item proteus
1104 As @code{animate}, but changes the shape of the mouse pointer too.
1105 @end table
1107 @findex mouse-avoidance-mode
1108 You can also use the command @kbd{M-x mouse-avoidance-mode} to enable
1109 the mode.  Whenever Mouse Avoidance mode moves the mouse, it also
1110 raises the frame.
1112 @node Non-Window Terminals
1113 @section Non-Window Terminals
1114 @cindex text terminal
1116   On a text terminal, Emacs can display only one Emacs frame at a
1117 time.  However, you can still create multiple Emacs frames, and switch
1118 between them.  Switching frames on these terminals is much like
1119 switching between different window configurations.
1121   Use @kbd{C-x 5 2} to create a new frame and switch to it; use @kbd{C-x
1122 5 o} to cycle through the existing frames; use @kbd{C-x 5 0} to delete
1123 the current frame.
1125   Each frame has a number to distinguish it.  If your terminal can
1126 display only one frame at a time, the selected frame's number @var{n}
1127 appears near the beginning of the mode line, in the form
1128 @samp{F@var{n}}.
1130 @findex set-frame-name
1131 @findex select-frame-by-name
1132   @samp{F@var{n}} is in fact the frame's initial name.  You can give
1133 frames more meaningful names if you wish, and you can select a frame
1134 by its name.  Use the command @kbd{M-x set-frame-name @key{RET}
1135 @var{name} @key{RET}} to specify a new name for the selected frame,
1136 and use @kbd{M-x select-frame-by-name @key{RET} @var{name} @key{RET}}
1137 to select a frame according to its name.  The name you specify appears
1138 in the mode line when the frame is selected.
1140 @node Text-Only Mouse
1141 @section Using a Mouse in Text Terminals
1142 @cindex mouse support
1143 @cindex terminal emulators, mouse support
1145 Some text terminals support mouse clicks in the terminal window.
1147 @cindex xterm
1148   In a terminal emulator which is compatible with @command{xterm}, you
1149 can use @kbd{M-x xterm-mouse-mode} to give Emacs control over simple
1150 uses of the mouse---basically, only non-modified single clicks are
1151 supported.  The normal @command{xterm} mouse functionality for such
1152 clicks is still available by holding down the @kbd{SHIFT} key when you
1153 press the mouse button.  Xterm Mouse mode is a global minor mode
1154 (@pxref{Minor Modes}).  Repeating the command turns the mode off
1155 again.
1157 @findex gpm-mouse-mode
1158   In the console on GNU/Linux, you can use @kbd{M-x gpm-mouse-mode} to
1159 enable mouse support.  You must have the gpm server installed and
1160 running on your system in order for this to work.
1162 @iftex
1163 @xref{MS-DOS Mouse,,,emacs-xtra,Specialized Emacs Features},
1164 @end iftex
1165 @ifnottex
1166 @xref{MS-DOS Mouse},
1167 @end ifnottex
1168 for information about mouse support on MS-DOS.