(Abbrevs): A @node line without explicit Prev, Next, and Up links.

[gnu-emacs] / lisp / tooltip.el

diff --git a/lisp/tooltip.el b/lisp/tooltip.el
index e88bc6017ce24236ba8bc75805b4651998e9b050..cacd6f59670985953d2f3d9f653dba88727c2066 100644 (file)
--- a/lisp/tooltip.el
+++ b/lisp/tooltip.el
@@ -1,7 +1,7 @@
 ;;; tooltip.el --- show tooltip windows
 
 ;; Copyright (C) 1997, 1999, 2000, 2001, 2002, 2003, 2004,
-;;   2005 Free Software Foundation, Inc.
+;;   2005, 2006 Free Software Foundation, Inc.
 
 ;; Author: Gerd Moellmann <gerd@acm.org>
 ;; Keywords: help c mouse tools
@@ -47,8 +47,15 @@
 ;; would be accompanied by a full redisplay.
 
 (define-minor-mode tooltip-mode
-  "Toggle Tooltip display.
-With ARG, turn tooltip mode on if and only if ARG is positive."
+  "Toggle Tooltip mode.
+With ARG, turn Tooltip mode on if and only if ARG is positive.
+When this minor mode is enabled, Emacs displays help text
+in a pop-up window for buttons and menu items that you put the mouse on.
+\(However, if `tooltip-use-echo-area' is non-nil, this and
+all pop-up help appears in the echo area.)
+
+When Tooltip mode is disabled, Emacs displays one line of
+the help text in the echo area, and does not make a pop-up window."
   :global t
   :init-value (not (or noninteractive
                       emacs-basic-display
@@ -139,7 +146,9 @@ position to pop up the tooltip."
   :group 'basic-faces)
 
 (defcustom tooltip-use-echo-area nil
-  "Use the echo area instead of tooltip frames for help and GUD tooltips."
+  "Use the echo area instead of tooltip frames for help and GUD tooltips.
+To display multi-line help text in the echo area, set this to t
+and enable `tooltip-mode'."
   :type 'boolean
   :group 'tooltip)