summaryrefslogtreecommitdiff
path: root/lisp/tooltip.el
diff options
context:
space:
mode:
authorRichard M. Stallman <rms@gnu.org>2006-04-18 21:23:12 +0000
committerRichard M. Stallman <rms@gnu.org>2006-04-18 21:23:12 +0000
commit42cc79e684548e45d17038be38aded09b889b25a (patch)
tree4d6bb646d44547a3d02e5e0ad31a03d7555bc20a /lisp/tooltip.el
parent98639288c8eaff279787d862490fd136fc1ec284 (diff)
downloademacs-42cc79e684548e45d17038be38aded09b889b25a.tar.gz
(tooltip-mode, tooltip-use-echo-area): Doc fixes.
Diffstat (limited to 'lisp/tooltip.el')
-rw-r--r--lisp/tooltip.el16
1 files changed, 11 insertions, 5 deletions
diff --git a/lisp/tooltip.el b/lisp/tooltip.el
index 8dc811c09e6..cacd6f59670 100644
--- a/lisp/tooltip.el
+++ b/lisp/tooltip.el
@@ -47,11 +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 on mouse-over. When it is disabled,
-Emacs displays the help text in the echo area instead."
+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
@@ -142,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)