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