[Emacs-diffs] /srv/bzr/emacs/trunk r99604: * frames.texi (Mouse Avoidance): Mention make-pointer-invisible.

[Chong Yidong]

------------------------------------------------------------
revno: 99604
committer: Chong Yidong <address@hidden>
branch nick: trunk
timestamp: Tue 2010-03-02 17:56:36 -0500
message:
  * frames.texi (Mouse Avoidance): Mention make-pointer-invisible.
  
  * display.texi (Display Custom): Document make-pointer-invisible and
  underline-minimum-offset.  Remove inverse-video.
modified:
  doc/emacs/ChangeLog
  doc/emacs/display.texi
  doc/emacs/frames.texi

=== modified file 'doc/emacs/ChangeLog'
--- a/doc/emacs/ChangeLog       2010-02-21 13:35:25 +0000
+++ b/doc/emacs/ChangeLog       2010-03-02 22:56:36 +0000
@@ -1,3 +1,10 @@
+2010-03-02  Chong Yidong  <address@hidden>
+
+       * frames.texi (Mouse Avoidance): Mention make-pointer-invisible.
+
+       * display.texi (Display Custom): Document make-pointer-invisible and
+       underline-minimum-offset.  Remove inverse-video.
+
 2010-02-21  Chong Yidong  <address@hidden>
 
        * frames.texi (Frame Commands): Note that the last ordinary frame can

=== modified file 'doc/emacs/display.texi'
--- a/doc/emacs/display.texi    2010-02-01 18:39:33 +0000
+++ b/doc/emacs/display.texi    2010-03-02 22:56:36 +0000
@@ -1278,10 +1278,6 @@
 @c the reason for that pxref is because an xref early in the
 @c ``echo area'' section leads here.
 
address@hidden inverse-video
-  If the variable @code{inverse-video} is address@hidden, Emacs attempts
-to invert all the lines of the display from what they normally are.
-
 @vindex visible-bell
   If the variable @code{visible-bell} is address@hidden, Emacs attempts
 to make the whole screen blink when it would normally make an audible bell
@@ -1296,35 +1292,51 @@
 
 @vindex baud-rate
   The variable @address@hidden holds the output
-speed of the terminal, as far as Emacs knows.  Setting this variable
-does not change the speed of actual data transmission, but the value
-is used for calculations.  On text-only terminals, it affects padding,
-and decisions about whether to scroll part of the screen or redraw it
-instead.  It also affects the behavior of incremental search.
-
-  On graphical displays, @code{baud-rate} is only used to determine
-how frequently to look for pending input during display updating.  A
+speed of the terminal.  Setting this variable does not change the
+speed of actual data transmission, but the value is used for
+calculations.  On text-only terminals, it affects padding, and
+decisions about whether to scroll part of the screen or redraw it
+instead.  It also affects the behavior of incremental search.  On
+graphical displays, @code{baud-rate} is only used to determine how
+frequently to look for pending input during display updating.  A
 higher value of @code{baud-rate} means that check for pending input
 will be done less frequently.
 
address@hidden mouse pointer
 @cindex hourglass pointer display
address@hidden display-hourglass
 @vindex hourglass-delay
-  On graphical displays, Emacs can optionally display the mouse pointer
-in a special shape to say that Emacs is busy.  To turn this feature on
-or off, customize the group @code{cursor}.  You can also control the
-amount of time Emacs must remain busy before the busy indicator is
-displayed, by setting the variable @code{hourglass-delay}.
+  On graphical displays, Emacs displays the mouse pointer as an
+hourglass if Emacs is busy.  To disable this feature, set the variable
address@hidden to @code{nil}.  The variable
address@hidden determines the number of seconds of ``busy
+time'' before the hourglass is shown; the default is 1.
+
address@hidden make-pointer-invisible
+  If the mouse pointer lies inside an Emacs frame, Emacs makes it
+invisible each time you type a character to insert text, to prevent it
+from obscuring the text.  (To be precise, the hiding occurs when you
+type a ``self-inserting'' character.  @xref{Inserting Text}.)  Moving
+the mouse pointer makes it visible again.  To disable this feature,
+set the variable @code{make-pointer-invisible} to @code{nil}.
+
address@hidden underline-minimum-offset
address@hidden x-underline-at-descent-line
+  On graphical displays, the variable @code{underline-minimum-offset}
+determines the minimum distance between the baseline and underline, in
+pixels, for underlined text.  By default, the value is 1; increasing
+it may improve the legibility of underlined text for certain fonts.
+(However, Emacs will never draw the underline below the current line
+area.)  The variable @code{x-underline-at-descent-line} determines how
+to draw underlined text.  The default is @code{nil}, which means to
+draw it at the baseline level of the font; if you change it to
address@hidden, Emacs draws the underline at the same height as the font's
+descent line.
 
 @vindex overline-margin
-  On graphical displays, the variable @code{overline-margin} specifies
-the vertical position of an overline above the text, including the
-height of the overline itself, in pixels.  The default value is 2.
-
address@hidden x-underline-at-descent-line
-  On graphical displays, Emacs normally draws an underline at the
-baseline level of the font.  If @code{x-underline-at-descent-line} is
address@hidden, Emacs draws the underline at the same height as the
-font's descent line.
+  The variable @code{overline-margin} specifies the vertical position
+of an overline above the text, including the height of the overline
+itself, in pixels; the default is 2.
 
 @findex tty-suppress-bold-inverse-default-colors
   On some text-only terminals, bold face and inverse video together

=== modified file 'doc/emacs/frames.texi'
--- a/doc/emacs/frames.texi     2010-02-21 13:35:25 +0000
+++ b/doc/emacs/frames.texi     2010-03-02 22:56:36 +0000
@@ -50,7 +50,7 @@
 * Tool Bars::           Enabling and disabling the tool bar.
 * Dialog Boxes::        Controlling use of dialog boxes.
 * Tooltips::            Displaying information at the current mouse position.
-* Mouse Avoidance::     Moving the mouse pointer out of the way.
+* Mouse Avoidance::     Preventing the mouse pointer from obscuring text.
 * Non-Window Terminals::  Multiple frames on terminals that show only one.
 * Text-Only Mouse::     Using the mouse in text-only terminals.
 @end menu
@@ -1072,12 +1072,20 @@
 @cindex avoiding mouse in the way of your typing
 @cindex mouse avoidance
 
+  On graphical terminals, the mouse pointer may obscure the text in
+the Emacs frame.  Emacs provides two methods to avoid this problem.
+
address@hidden make-pointer-invisible
+  Firstly, Emacs hides the mouse pointer each time you type a
+self-inserting character, if the pointer lies inside an Emacs frame;
+moving the mouse pointer makes it visible again.  To disable this
+feature, set the variable @code{make-pointer-invisible} to @code{nil}.
+
 @vindex mouse-avoidance-mode
-Mouse Avoidance mode keeps the mouse pointer away from point, to avoid
-obscuring text you want to edit.  Whenever it moves the mouse, it also
-raises the frame.  To use Mouse Avoidance mode, customize the variable
address@hidden  You can set this to various values to
-move the mouse in several ways:
+  Secondly, you can use Mouse Avoidance mode, a minor mode, to keep
+the mouse pointer away from point.  To use Mouse Avoidance mode,
+customize the variable @code{mouse-avoidance-mode}.  You can set this
+to various values to move the mouse in several ways:
 
 @table @code
 @item banish
@@ -1098,7 +1106,8 @@
 
 @findex mouse-avoidance-mode
 You can also use the command @kbd{M-x mouse-avoidance-mode} to enable
-the mode.
+the mode.  Whenever Mouse Avoidance mode moves the mouse, it also
+raises the frame.
 
 @node Non-Window Terminals
 @section Non-Window Terminals