# HG changeset patch
# User Eli Zaretskii <eliz@gnu.org>
# Date 1107007497 0
# Node ID 4301dcdf04df17f9da92e1a207366bc2c83e7220
# Parent  bea71297b2279361cf4c2956ad08f4dc3d1284f7
(Misc Events): Describe the help-echo event.

diff -r bea71297b227 -r 4301dcdf04df lispref/commands.texi
--- a/lispref/commands.texi	Sat Jan 29 14:02:43 2005 +0000
+++ b/lispref/commands.texi	Sat Jan 29 14:04:57 2005 +0000
@@ -1547,6 +1547,21 @@
 This kind of event is generated, at present, only on some kinds of
 systems.
 
+@cindex @code{help-echo} event
+@item help-echo
+This kind of event is generated when a mouse pointer moves onto a
+portion of buffer text which has a @code{help-echo} text property.
+The generated event has this form:
+
+@example
+ (help-echo @var{frame} @var{help} @var{window} @var{object} @var{pos})
+@end example
+
+@noindent
+The precise meaning of the event parameters and the way these
+parameters are used to display the help-echo text are described in
+@ref{Text help-echo}.
+
 @cindex @code{usr1-signal} event
 @cindex @code{usr2-signal} event
 @item usr1-signal