Update copyright year to 2014 by running admin/update-copyright.
[emacs.git] / doc / emacs / frames.texi
blobb56068b6598b14b5ddb26d699141fef7c9cc1cc2
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
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).  Menus are supported on all text terminals.
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)
70 @cindex mouse, selecting text using
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}).
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}).
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}).
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
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.
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.
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}).
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}.
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.
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 point.
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}.
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:
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.
158 @item
159 If a region is active, clicking @kbd{Mouse-3} adjusts the nearer end
160 of the region by moving it to the clicked position.  The adjusted
161 region's text is copied to the kill ring; if the text in the original
162 region was already on the kill ring, it replaces it there.
164 @item
165 If you originally specified the region using a double or triple
166 @kbd{Mouse-1}, so that the region is defined to consist of entire
167 words or lines (@pxref{Word and Line Mouse}), then adjusting the
168 region with @kbd{Mouse-3} also proceeds by entire words or lines.
170 @item
171 If you use @kbd{Mouse-3} a second time consecutively, at the same
172 place, that kills the region already selected.  Thus, the simplest way
173 to kill text with the mouse is to click @kbd{Mouse-1} at one end, then
174 click @kbd{Mouse-3} twice at the other end.  To copy the text into the
175 kill ring without deleting it from the buffer, press @kbd{Mouse-3}
176 just once---or just drag across the text with @kbd{Mouse-1}.  Then you
177 can copy it elsewhere by yanking it.
178 @end itemize
180   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.
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}.
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.
208 @node Word and Line Mouse
209 @section Mouse Commands for Words and Lines
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.
215 @table @kbd
216 @item Double-Mouse-1
217 Select the text around the word which you click on.
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).
228 @item Double-Drag-Mouse-1
229 Select the text you drag across, in the form of whole words.
231 @item Triple-Mouse-1
232 Select the line you click on.
234 @item Triple-Drag-Mouse-1
235 Select the text you drag across, in the form of whole lines.
236 @end table
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
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.
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}).
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.
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.
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.
290 @node Menu Mouse Clicks
291 @section Mouse Clicks for Menus
293   Several mouse clicks with the @key{CTRL} and @key{SHIFT} modifiers
294 bring up menus.
296 @table @kbd
297 @item C-Mouse-1
298 @kindex C-Mouse-1
299 This menu is for selecting a buffer.
301 The MSB (``mouse select buffer'') global minor mode makes this
302 menu smarter and more customizable.  @xref{Buffer Menus}.
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}).
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.
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
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}):
331 @smallexample
332 (global-set-key [mouse-3] 'mouse-popup-menubar-stuff)
333 @end smallexample
335 @node Mode Line Mouse
336 @section Mode Line Mouse Commands
337 @cindex mode line, mouse
338 @cindex mouse on mode line
340   You can use mouse clicks on window mode lines to select and manipulate
341 windows.
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.
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.
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.
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.
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
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.
379 @node Creating Frames
380 @section Creating Frames
381 @cindex creating frames
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.
392   The various @kbd{C-x 5} commands differ in how they find or create the
393 buffer to select:
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
425   You can control the appearance and behavior of the newly-created
426 frames by specifying @dfn{frame parameters}.  @xref{Frame Parameters}.
428 @node Frame Commands
429 @section Frame Commands
431   The following commands are used to delete and operate on frames:
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.
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}.
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.
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.
457 @item M-<F10>
458 @kindex M-<F10>
459 @findex toggle-frame-maximized
460 Toggle maximization state of the current frame.
462 @item <F11>
463 @kindex <F11>
464 @findex toggle-frame-fullscreen
465 Toggle fullscreen mode of the current frame.
466 @end table
468   The @kbd{C-x 5 0} (@code{delete-frame}) command deletes the selected
469 frame.  However, it will refuse to delete the last frame in an Emacs
470 session, to prevent you from losing the ability to interact with the
471 Emacs session.  Note that when Emacs is run as a daemon (@pxref{Emacs
472 Server}), there is always a ``virtual frame'' that remains after all
473 the ordinary, interactive frames are deleted.  In this case, @kbd{C-x
474 5 0} can delete the last interactive frame; you can use
475 @command{emacsclient} to reconnect to the Emacs session.
477   The @kbd{C-x 5 1} (@code{delete-other-frames}) command deletes all
478 other frames on the current terminal (this terminal refers to either a
479 graphical display, or a text terminal; @pxref{Non-Window Terminals}).
480 If the Emacs session has frames open on other graphical displays or
481 text terminals, those are not deleted.
483 @vindex focus-follows-mouse
484   The @kbd{C-x 5 o} (@code{other-frame}) command selects the next
485 frame on the current terminal.  If you are using Emacs on the X Window
486 System with a window manager that selects (or @dfn{gives focus to})
487 whatever frame the mouse cursor is over, you have to change the
488 variable @code{focus-follows-mouse} to @code{t} in order for this
489 command to work properly.  Then invoking @kbd{C-x 5 o} will also warp
490 the mouse cursor to the chosen frame.
492 @node Fonts
493 @section Fonts
494 @cindex fonts
496   By default, Emacs displays text on graphical displays using a
497 12-point monospace font.  There are several different ways to specify
498 a different font:
500 @itemize
501 @item
502 Click on @samp{Set Default Font} in the @samp{Options} menu.  To save
503 this for future sessions, click on @samp{Save Options} in the
504 @samp{Options} menu.
506 @item
507 Add a line to your init file, modifying the variable
508 @code{default-frame-alist} to specify the @code{font} parameter
509 (@pxref{Frame Parameters}), like this:
511 @example
512 (add-to-list 'default-frame-alist
513              '(font . "DejaVu Sans Mono-10"))
514 @end example
516 @cindex X defaults file
517 @cindex X resources file
518 @item
519 Add an @samp{emacs.font} X resource setting to your X resource file,
520 like this:
522 @example
523 emacs.font: DejaVu Sans Mono-12
524 @end example
526 @noindent
527 You must restart X, or use the @command{xrdb} command, for the X
528 resources file to take effect.  @xref{Resources}.  Do not quote
529 font names in X resource files.
531 @item
532 If you are running Emacs on the GNOME desktop, you can tell Emacs to
533 use the default system font by setting the variable
534 @code{font-use-system-font} to @code{t} (the default is @code{nil}).
535 For this to work, Emacs must have been compiled with Gconf support.
537 @item
538 Use the command line option @samp{-fn} (or @samp{--font}).  @xref{Font
540 @end itemize
542   To check what font you're currently using, the @kbd{C-u C-x =}
543 command can be helpful.  It describes the character at point, and
544 names the font that it's rendered in.
546 @cindex fontconfig
547   On X, there are four different ways to express a ``font name''.  The
548 first is to use a @dfn{Fontconfig pattern}.  Fontconfig patterns have
549 the following form:
551 @example
552 @var{fontname}[-@var{fontsize}][:@var{name1}=@var{values1}][:@var{name2}=@var{values2}]...
553 @end example
555 @noindent
556 Within this format, any of the elements in braces may be omitted.
557 Here, @var{fontname} is the @dfn{family name} of the font, such as
558 @samp{Monospace} or @samp{DejaVu Sans Mono}; @var{fontsize} is the
559 @dfn{point size} of the font (one @dfn{printer's point} is about 1/72
560 of an inch); and the @samp{@var{name}=@var{values}} entries specify
561 settings such as the slant and weight of the font.  Each @var{values}
562 may be a single value, or a list of values separated by commas.  In
563 addition, some property values are valid with only one kind of
564 property name, in which case the @samp{@var{name}=} part may be
565 omitted.
567 Here is a list of common font properties:
569 @table @samp
570 @item slant
571 One of @samp{italic}, @samp{oblique}, or @samp{roman}.
573 @item weight
574 One of @samp{light}, @samp{medium}, @samp{demibold}, @samp{bold} or
575 @samp{black}.
577 @item style
578 Some fonts define special styles which are a combination of slant and
579 weight.  For instance, @samp{Dejavu Sans} defines the @samp{book}
580 style, which overrides the slant and weight properties.
582 @item width
583 One of @samp{condensed}, @samp{normal}, or @samp{expanded}.
585 @item spacing
586 One of @samp{monospace}, @samp{proportional}, @samp{dual-width}, or
587 @samp{charcell}.
588 @end table
590 @noindent
591 Here are some examples of Fontconfig patterns:
593 @example
594 Monospace
595 Monospace-12
596 Monospace-12:bold
597 DejaVu Sans Mono:bold:italic
598 Monospace-12:weight=bold:slant=italic
599 @end example
601 For a more detailed description of Fontconfig patterns, see the
602 Fontconfig manual, which is distributed with Fontconfig and available
603 online at @url{http://fontconfig.org/fontconfig-user.html}.
605 @cindex GTK font pattern
606   The second way to specify a font is to use a @dfn{GTK font pattern}.
607 These have the syntax
609 @example
610 @var{fontname} [@var{properties}] [@var{fontsize}]
611 @end example
613 @noindent
614 where @var{fontname} is the family name, @var{properties} is a list of
615 property values separated by spaces, and @var{fontsize} is the point
616 size.  The properties that you may specify for GTK font patterns are
617 as follows:
619 @itemize
620 @item
621 Slant properties: @samp{Italic} or @samp{Oblique}.  If omitted, the
622 default (roman) slant is implied.
623 @item
624 Weight properties: @samp{Bold}, @samp{Book}, @samp{Light},
625 @samp{Medium}, @samp{Semi-bold}, or @samp{Ultra-light}.  If omitted,
626 @samp{Medium} weight is implied.
627 @item
628 Width properties: @samp{Semi-Condensed} or @samp{Condensed}.  If
629 omitted, a default width is used.
630 @end itemize
632 @noindent
633 Here are some examples of GTK font patterns:
635 @example
636 Monospace 12
637 Monospace Bold Italic 12
638 @end example
640 @cindex XLFD
641 @cindex X Logical Font Description
642   The third way to specify a font is to use an @dfn{XLFD} (@dfn{X
643 Logical Font Description}).  This is the traditional method for
644 specifying fonts under X@.  Each XLFD consists of fourteen words or
645 numbers, separated by dashes, like this:
647 @example
648 -misc-fixed-medium-r-semicondensed--13-*-*-*-c-60-iso8859-1
649 @end example
651 @noindent
652 A wildcard character (@samp{*}) in an XLFD matches any sequence of
653 characters (including none), and @samp{?} matches any single
654 character.  However, matching is implementation-dependent, and can be
655 inaccurate when wildcards match dashes in a long name.  For reliable
656 results, supply all 14 dashes and use wildcards only within a field.
657 Case is insignificant in an XLFD@.  The syntax for an XLFD is as
658 follows:
660 @example
661 -@var{maker}-@var{family}-@var{weight}-@var{slant}-@var{widthtype}-@var{style}@dots{}
662 @dots{}-@var{pixels}-@var{height}-@var{horiz}-@var{vert}-@var{spacing}-@var{width}-@var{registry}-@var{encoding}
663 @end example
665 @noindent
666 The entries have the following meanings:
668 @table @var
669 @item maker
670 The name of the font manufacturer.
671 @item family
672 The name of the font family (e.g., @samp{courier}).
673 @item weight
674 The font weight---normally either @samp{bold}, @samp{medium} or
675 @samp{light}.  Some font names support other values.
676 @item slant
677 The font slant---normally @samp{r} (roman), @samp{i} (italic),
678 @samp{o} (oblique), @samp{ri} (reverse italic), or @samp{ot} (other).
679 Some font names support other values.
680 @item widthtype
681 The font width---normally @samp{normal}, @samp{condensed},
682 @samp{semicondensed}, or @samp{extended}.  Some font names support
683 other values.
684 @item style
685 An optional additional style name.  Usually it is empty---most XLFDs
686 have two hyphens in a row at this point.
687 @item pixels
688 The font height, in pixels.
689 @item height
690 The font height on the screen, measured in tenths of a printer's
691 point.  This is the point size of the font, times ten.  For a given
692 vertical resolution, @var{height} and @var{pixels} are proportional;
693 therefore, it is common to specify just one of them and use @samp{*}
694 for the other.
695 @item horiz
696 The horizontal resolution, in pixels per inch, of the screen for which
697 the font is intended.
698 @item vert
699 The vertical resolution, in pixels per inch, of the screen for which
700 the font is intended.  Normally the resolution of the fonts on your
701 system is the right value for your screen; therefore, you normally
702 specify @samp{*} for this and @var{horiz}.
703 @item spacing
704 This is @samp{m} (monospace), @samp{p} (proportional) or @samp{c}
705 (character cell).
706 @item width
707 The average character width, in pixels, multiplied by ten.
708 @item registry
709 @itemx encoding
710 The X font character set that the font depicts.  (X font character
711 sets are not the same as Emacs character sets, but they are similar.)
712 You can use the @command{xfontsel} program to check which choices you
713 have.  Normally you should use @samp{iso8859} for @var{registry} and
714 @samp{1} for @var{encoding}.
715 @end table
717   The fourth and final method of specifying a font is to use a ``font
718 nickname''.  Certain fonts have shorter nicknames, which you can use
719 instead of a normal font specification.  For instance, @samp{6x13} is
720 equivalent to
722 @example
723 -misc-fixed-medium-r-semicondensed--13-*-*-*-c-60-iso8859-1
724 @end example
726 @cindex client-side fonts
727 @cindex server-side fonts
728   On X, Emacs recognizes two types of fonts: @dfn{client-side} fonts,
729 which are provided by the Xft and Fontconfig libraries, and
730 @dfn{server-side} fonts, which are provided by the X server itself.
731 Most client-side fonts support advanced font features such as
732 antialiasing and subpixel hinting, while server-side fonts do not.
733 Fontconfig and GTK patterns match only client-side fonts.
735 @cindex listing system fonts
736   You will probably want to use a fixed-width default font---that is,
737 a font in which all characters have the same width.  For Xft and
738 Fontconfig fonts, you can use the @command{fc-list} command to list
739 the available fixed-width fonts, like this:
741 @example
742 fc-list :spacing=mono fc-list :spacing=charcell
743 @end example
745 @noindent
746 For server-side X fonts, you can use the @command{xlsfonts} program to
747 list the available fixed-width fonts, like this:
749 @example
750 xlsfonts -fn '*x*' | egrep "^[0-9]+x[0-9]+"
751 xlsfonts -fn '*-*-*-*-*-*-*-*-*-*-*-m*'
752 xlsfonts -fn '*-*-*-*-*-*-*-*-*-*-*-c*'
753 @end example
755 @noindent
756 Any font with @samp{m} or @samp{c} in the @var{spacing} field of the
757 XLFD is a fixed-width font.  To see what a particular font looks like,
758 use the @command{xfd} command.  For example:
760 @example
761 xfd -fn 6x13
762 @end example
764 @noindent
765 displays the entire font @samp{6x13}.
767   While running Emacs, you can also set the font of a specific kind of
768 text (@pxref{Faces}), or a particular frame (@pxref{Frame
769 Parameters}).
771 @node Speedbar
772 @section Speedbar Frames
773 @cindex speedbar
775 @cindex attached frame (of speedbar)
776   The @dfn{speedbar} is a special frame for conveniently navigating in
777 or operating on another frame.  The speedbar, when it exists, is
778 always associated with a specific frame, called its @dfn{attached
779 frame}; all speedbar operations act on that frame.
781   Type @kbd{M-x speedbar} to create the speedbar and associate it with
782 the current frame.  To dismiss the speedbar, type @kbd{M-x speedbar}
783 again, or select the speedbar and type @kbd{q}.  (You can also delete
784 the speedbar frame like any other Emacs frame.)  If you wish to
785 associate the speedbar with a different frame, dismiss it and call
786 @kbd{M-x speedbar} from that frame.
788   The speedbar can operate in various modes.  Its default mode is
789 @dfn{File Display} mode, which shows the files in the current
790 directory of the selected window of the attached frame, one file per
791 line.  Clicking on a file name visits that file in the selected window
792 of the attached frame, and clicking on a directory name shows that
793 directory in the speedbar (@pxref{Mouse References}).  Each line also
794 has a box, @samp{[+]} or @samp{<+>}, that you can click on to
795 @dfn{expand} the contents of that item.  Expanding a directory adds
796 the contents of that directory to the speedbar display, underneath the
797 directory's own line.  Expanding an ordinary file adds a list of the
798 tags in that file to the speedbar display; you can click on a tag name
799 to jump to that tag in the selected window of the attached frame.
800 When a file or directory is expanded, the @samp{[+]} changes to
801 @samp{[-]}; you can click on that box to @dfn{contract} the item,
802 hiding its contents.
804   You navigate through the speedbar using the keyboard, too.  Typing
805 @kbd{RET} while point is on a line in the speedbar is equivalent to
806 clicking the item on the current line, and @kbd{SPC} expands or
807 contracts the item.  @kbd{U} displays the parent directory of the
808 current directory.  To copy, delete, or rename the file on the current
809 line, type @kbd{C}, @kbd{D}, and @kbd{R} respectively.  To create a
810 new directory, type @kbd{M}.
812   Another general-purpose speedbar mode is @dfn{Buffer Display} mode;
813 in this mode, the speedbar displays a list of Emacs buffers.  To
814 switch to this mode, type @kbd{b} in the speedbar.  To return to File
815 Display mode, type @kbd{f}.  You can also change the display mode by
816 clicking @kbd{mouse-3} anywhere in the speedbar window (or
817 @kbd{mouse-1} on the mode-line) and selecting @samp{Displays} in the
818 pop-up menu.
820   Some major modes, including Rmail mode, Info, and GUD, have
821 specialized ways of putting useful items into the speedbar for you to
822 select.  For example, in Rmail mode, the speedbar shows a list of Rmail
823 files, and lets you move the current message to another Rmail file by
824 clicking on its @samp{<M>} box.
826   For more details on using and programming the speedbar, @xref{Top,
827 Speedbar,,speedbar, Speedbar Manual}.
829 @node Multiple Displays
830 @section Multiple Displays
831 @cindex multiple displays
833   A single Emacs can talk to more than one X display.  Initially, Emacs
834 uses just one display---the one specified with the @env{DISPLAY}
835 environment variable or with the @samp{--display} option (@pxref{Initial
836 Options}).  To connect to another display, use the command
837 @code{make-frame-on-display}:
839 @findex make-frame-on-display
840 @table @kbd
841 @item M-x make-frame-on-display @key{RET} @var{display} @key{RET}
842 Create a new frame on display @var{display}.
843 @end table
845   A single X server can handle more than one screen.  When you open
846 frames on two screens belonging to one server, Emacs knows they share a
847 single keyboard, and it treats all the commands arriving from these
848 screens as a single stream of input.
850   When you open frames on different X servers, Emacs makes a separate
851 input stream for each server.  Each server also has its own selected
852 frame.  The commands you enter with a particular X server apply to
853 that server's selected frame.
855 @node Frame Parameters
856 @section Frame Parameters
857 @cindex default-frame-alist
859   You can control the default appearance and behavior of all frames by
860 specifying a default list of @dfn{frame parameters} in the variable
861 @code{default-frame-alist}.  Its value should be a list of entries,
862 each specifying a parameter name and a value for that parameter.
863 These entries take effect whenever Emacs creates a new frame,
864 including the initial frame.
866 @cindex frame size, specifying default
867   For example, you can add the following lines to your init file
868 (@pxref{Init File}) to set the default frame width to 90 character
869 columns, the default frame height to 40 character rows, and the
870 default font to @samp{Monospace-10}:
872 @example
873 (add-to-list 'default-frame-alist '(width  . 90))
874 (add-to-list 'default-frame-alist '(height . 40))
875 (add-to-list 'default-frame-alist '(font . "Monospace-10"))
876 @end example
878   For a list of frame parameters and their effects, see @ref{Frame
879 Parameters,,, elisp, The Emacs Lisp Reference Manual}.
881 @cindex initial-frame-alist
882   You can also specify a list of frame parameters which apply to just
883 the initial frame, by customizing the variable
884 @code{initial-frame-alist}.
886   If Emacs is compiled to use an X toolkit, frame parameters that
887 specify colors and fonts don't affect menus and the menu bar, since
888 those are drawn by the toolkit and not directly by Emacs.
890 @node Scroll Bars
891 @section Scroll Bars
892 @cindex Scroll Bar mode
893 @cindex mode, Scroll Bar
895   On graphical displays, there is a @dfn{scroll bar} on the side of
896 each Emacs window.  Clicking @kbd{Mouse-1} on the scroll bar's up and
897 down buttons scrolls the window by one line at a time.  Clicking
898 @kbd{Mouse-1} above or below the scroll bar's inner box scrolls the
899 window by nearly the entire height of the window, like @kbd{M-v} and
900 @kbd{C-v} respectively (@pxref{Moving Point}).  Dragging the inner box
901 scrolls continuously.
903   If Emacs is compiled on the X Window System without X toolkit
904 support, the scroll bar behaves differently.  Clicking @kbd{Mouse-1}
905 anywhere on the scroll bar scrolls forward like @kbd{C-v}, while
906 @kbd{Mouse-3} scrolls backward like @kbd{M-v}.  Clicking @kbd{Mouse-2}
907 in the scroll bar lets you drag the inner box up and down.
909 @findex scroll-bar-mode
910 @findex toggle-scroll-bar
911   To toggle the use of scroll bars, type @kbd{M-x scroll-bar-mode}.
912 This command applies to all frames, including frames yet to be
913 created.  To toggle scroll bars for just the selected frame, use the
914 command @kbd{M-x toggle-scroll-bar}.
916 @vindex scroll-bar-mode
917   To control the use of scroll bars at startup, customize the variable
918 @code{scroll-bar-mode}.  Its value should be either @code{right} (put
919 scroll bars on the right side of windows), @code{left} (put them on
920 the left), or @code{nil} (disable scroll bars).  By default, Emacs
921 puts scroll bars on the right if it was compiled with GTK+ support on
922 the X Window System, and on MS-Windows or Mac OS; Emacs puts scroll
923 bars on the left if compiled on the X Window System without GTK+
924 support (following the old convention for X applications).
926 @vindex scroll-bar-width
927 @cindex width of the scroll bar
928   You can also use the X resource @samp{verticalScrollBars} to enable
929 or disable the scroll bars (@pxref{Resources}).  To control the scroll
930 bar width, change the @code{scroll-bar-width} frame parameter
931 (@pxref{Frame Parameters,,, elisp, The Emacs Lisp Reference Manual}).
933 @vindex scroll-bar-adjust-thumb-portion
934 @cindex overscrolling
935 If you're using Emacs on X (with GTK+ or Motif), you can customize the
936 variable @code{scroll-bar-adjust-thumb-portion} to control
937 @dfn{overscrolling} of the scroll bar, i.e. dragging the thumb down even
938 when the end of the buffer is visible.  If its value is
939 non-@code{nil}, the scroll bar can be dragged downwards even if the
940 end of the buffer is shown; if @code{nil}, the thumb will be at the
941 bottom when the end of the buffer is shown.  You can not over-scroll
942 when the entire buffer is visible.
944 @node Drag and Drop
945 @section Drag and Drop
946 @cindex drag and drop
948   In most graphical desktop environments, Emacs has basic support for
949 @dfn{drag and drop} operations.  For instance, dropping text onto an
950 Emacs frame inserts the text where it is dropped.  Dropping a file
951 onto an Emacs frame visits that file.  As a special case, dropping the
952 file on a Dired buffer moves or copies the file (according to the
953 conventions of the application it came from) into the directory
954 displayed in that buffer.
956 @vindex dnd-open-file-other-window
957   Dropping a file normally visits it in the window you drop it on.  If
958 you prefer to visit the file in a new window in such cases, customize
959 the variable @code{dnd-open-file-other-window}.
961   The XDND and Motif drag and drop protocols, and the old KDE 1.x
962 protocol, are currently supported.
964 @node Menu Bars
965 @section Menu Bars
966 @cindex Menu Bar mode
967 @cindex mode, Menu Bar
968 @findex menu-bar-mode
969 @vindex menu-bar-mode
971   You can toggle the use of menu bars with @kbd{M-x menu-bar-mode}.
972 With no argument, this command toggles Menu Bar mode, a global minor
973 mode.  With an argument, the command turns Menu Bar mode on if the
974 argument is positive, off if the argument is not positive.  To control
975 the use of menu bars at startup, customize the variable
976 @code{menu-bar-mode}.
978 @kindex C-Mouse-3 @r{(when menu bar is disabled)}
979   Expert users often turn off the menu bar, especially on text
980 terminals, where this makes one additional line available for text.
981 If the menu bar is off, you can still pop up a menu of its contents
982 with @kbd{C-Mouse-3} on a display which supports pop-up menus.
983 @xref{Menu Mouse Clicks}.
985   @xref{Menu Bar}, for information on how to invoke commands with the
986 menu bar.  @xref{X Resources}, for how to customize the menu bar
987 menus' visual appearance.
989 @node Tool Bars
990 @section Tool Bars
991 @cindex Tool Bar mode
992 @cindex mode, Tool Bar
993 @cindex icons, toolbar
995   On graphical displays, Emacs puts a @dfn{tool bar} at the top of
996 each frame, just below the menu bar.  This is a row of icons which you
997 can click on with the mouse to invoke various commands.
999   The global (default) tool bar contains general commands.  Some major
1000 modes define their own tool bars; whenever a buffer with such a major
1001 mode is current, the mode's tool bar replaces the global tool bar.
1003 @findex tool-bar-mode
1004 @vindex tool-bar-mode
1005   To toggle the use of tool bars, type @kbd{M-x tool-bar-mode}.  This
1006 command applies to all frames, including frames yet to be created.  To
1007 control the use of tool bars at startup, customize the variable
1008 @code{tool-bar-mode}.
1010 @vindex tool-bar-style
1011 @cindex Tool Bar style
1012   When Emacs is compiled with GTK+ support, each tool bar item can
1013 consist of an image, or a text label, or both.  By default, Emacs
1014 follows the Gnome desktop's tool bar style setting; if none is
1015 defined, it displays tool bar items as just images.  To impose a
1016 specific tool bar style, customize the variable @code{tool-bar-style}.
1018 @cindex Tool Bar position
1019   You can also control the placement of the tool bar for the GTK+ tool
1020 bar with the frame parameter @code{tool-bar-position}.  @xref{Frame
1021 Parameters,,, elisp, The Emacs Lisp Reference Manual}.
1023 @node Dialog Boxes
1024 @section Using Dialog Boxes
1025 @cindex dialog boxes
1027 @vindex use-dialog-box
1028   A dialog box is a special kind of menu for asking you a yes-or-no
1029 question or some other special question.  Many Emacs commands use a
1030 dialog box to ask a yes-or-no question, if you used the mouse to
1031 invoke the command that led to the question.
1033   To disable the use of dialog boxes, change the variable
1034 @code{use-dialog-box} to @code{nil}.  In that case, Emacs always
1035 performs yes-or-no prompts using the echo area and keyboard input.
1036 This variable also controls whether to use file selection windows (but
1037 those are not supported on all platforms).
1039 @vindex use-file-dialog
1040 @cindex file selection dialog, how to disable
1041   A file selection window is a special kind of dialog box for asking
1042 for file names.  You can customize the variable @code{use-file-dialog}
1043 to suppress the use of file selection windows, even if you still want
1044 other kinds of dialogs.  This variable has no effect if you have
1045 suppressed all dialog boxes with the variable @code{use-dialog-box}.
1047 @vindex x-gtk-show-hidden-files
1048 @vindex x-gtk-file-dialog-help-text
1049 @cindex hidden files, in GTK+ file chooser
1050 @cindex help text, in GTK+ file chooser
1051   When Emacs is compiled with GTK+ support, it uses the GTK+ ``file
1052 chooser'' dialog.  Emacs adds an additional toggle button to this
1053 dialog, which you can use to enable or disable the display of hidden
1054 files (files starting with a dot) in that dialog.  If you want this
1055 toggle to be activated by default, change the variable
1056 @code{x-gtk-show-hidden-files} to @code{t}.  In addition, Emacs adds
1057 help text to the GTK+ file chooser dialog; to disable this help text,
1058 change the variable @code{x-gtk-file-dialog-help-text} to @code{nil}.
1060 @node Tooltips
1061 @section Tooltips
1062 @cindex tooltips
1064   @dfn{Tooltips} are small windows that display text information at
1065 the current mouse position.  They activate when there is a pause in
1066 mouse movement over some significant piece of text in a window, or the
1067 mode line, or some other part of the Emacs frame such as a tool bar
1068 button or menu item.
1070 @findex tooltip-mode
1071   You can toggle the use of tooltips with the command @kbd{M-x
1072 tooltip-mode}.  When Tooltip mode is disabled, the help text is
1073 displayed in the echo area instead.  To control the use of tooltips at
1074 startup, customize the variable @code{tooltip-mode}.
1076 @vindex tooltip-delay
1077   The variables @code{tooltip-delay} specifies how long Emacs should
1078 wait before displaying a tooltip.  For additional customization
1079 options for displaying tooltips, use @kbd{M-x customize-group
1080 @key{RET} tooltip @key{RET}}.
1082 @vindex x-gtk-use-system-tooltips
1083   If Emacs is built with GTK+ support, it displays tooltips via GTK+,
1084 using the default appearance of GTK+ tooltips.  To disable this,
1085 change the variable @code{x-gtk-use-system-tooltips} to @code{nil}.
1086 If you do this, or if Emacs is built without GTK+ support, most
1087 attributes of the tooltip text are specified by the @code{tooltip}
1088 face, and by X resources (@pxref{X Resources}).
1090   @dfn{GUD tooltips} are special tooltips that show the values of
1091 variables when debugging a program with GUD@.  @xref{Debugger
1092 Operation}.
1094 @node Mouse Avoidance
1095 @section Mouse Avoidance
1096 @cindex avoiding mouse in the way of your typing
1097 @cindex mouse avoidance
1099   On graphical terminals, the mouse pointer may obscure the text in
1100 the Emacs frame.  Emacs provides two methods to avoid this problem.
1102 @vindex make-pointer-invisible
1103   Firstly, Emacs hides the mouse pointer each time you type a
1104 self-inserting character, if the pointer lies inside an Emacs frame;
1105 moving the mouse pointer makes it visible again.  To disable this
1106 feature, set the variable @code{make-pointer-invisible} to @code{nil}.
1108 @vindex mouse-avoidance-mode
1109   Secondly, you can use Mouse Avoidance mode, a minor mode, to keep
1110 the mouse pointer away from point.  To use Mouse Avoidance mode,
1111 customize the variable @code{mouse-avoidance-mode}.  You can set this
1112 to various values to move the mouse in several ways:
1114 @table @code
1115 @item banish
1116 Move the pointer to a corner of the frame on any key-press.  You can
1117 customize the variable @code{mouse-avoidance-banish-position} to
1118 specify where the pointer goes when it is banished.
1119 @item exile
1120 Banish the pointer only if the cursor gets too close, and allow it to
1121 return once the cursor is out of the way.
1122 @item jump
1123 If the cursor gets too close to the pointer, displace the pointer by a
1124 random distance and direction.
1125 @item animate
1126 As @code{jump}, but shows steps along the way for illusion of motion.
1127 @item cat-and-mouse
1128 The same as @code{animate}.
1129 @item proteus
1130 As @code{animate}, but changes the shape of the mouse pointer too.
1131 @end table
1133 @findex mouse-avoidance-mode
1134 You can also use the command @kbd{M-x mouse-avoidance-mode} to enable
1135 the mode.  Whenever Mouse Avoidance mode moves the mouse, it also
1136 raises the frame.
1138 @node Non-Window Terminals
1139 @section Non-Window Terminals
1140 @cindex text terminal
1142   On a text terminal, Emacs can display only one Emacs frame at a
1143 time.  However, you can still create multiple Emacs frames, and switch
1144 between them.  Switching frames on these terminals is much like
1145 switching between different window configurations.
1147   Use @kbd{C-x 5 2} to create a new frame and switch to it; use @kbd{C-x
1148 5 o} to cycle through the existing frames; use @kbd{C-x 5 0} to delete
1149 the current frame.
1151   Each frame has a number to distinguish it.  If your terminal can
1152 display only one frame at a time, the selected frame's number @var{n}
1153 appears near the beginning of the mode line, in the form
1154 @samp{F@var{n}}.
1156 @findex set-frame-name
1157 @findex select-frame-by-name
1158   @samp{F@var{n}} is in fact the frame's initial name.  You can give
1159 frames more meaningful names if you wish, and you can select a frame
1160 by its name.  Use the command @kbd{M-x set-frame-name @key{RET}
1161 @var{name} @key{RET}} to specify a new name for the selected frame,
1162 and use @kbd{M-x select-frame-by-name @key{RET} @var{name} @key{RET}}
1163 to select a frame according to its name.  The name you specify appears
1164 in the mode line when the frame is selected.
1166 @node Text-Only Mouse
1167 @section Using a Mouse in Text Terminals
1168 @cindex mouse support
1169 @cindex terminal emulators, mouse support
1171 Some text terminals support mouse clicks in the terminal window.
1173 @cindex xterm
1174   In a terminal emulator which is compatible with @command{xterm}, you
1175 can use @kbd{M-x xterm-mouse-mode} to give Emacs control over simple
1176 uses of the mouse---basically, only non-modified single clicks are
1177 supported.  The normal @command{xterm} mouse functionality for such
1178 clicks is still available by holding down the @kbd{SHIFT} key when you
1179 press the mouse button.  Xterm Mouse mode is a global minor mode
1180 (@pxref{Minor Modes}).  Repeating the command turns the mode off
1181 again.
1183 @findex gpm-mouse-mode
1184   In the console on GNU/Linux, you can use @kbd{M-x gpm-mouse-mode} to
1185 enable mouse support.  You must have the gpm server installed and
1186 running on your system in order for this to work.
1188 @iftex
1189 @xref{MS-DOS Mouse,,,emacs-xtra,Specialized Emacs Features},
1190 @end iftex
1191 @ifnottex
1192 @xref{MS-DOS Mouse},
1193 @end ifnottex
1194 for information about mouse support on MS-DOS.