[Emacs-diffs] Changes to emacs/lispref/commands.texi,v

[Chong Yidong]

CVSROOT:        /cvsroot/emacs
Module name:    emacs
Changes by:     Chong Yidong <cyd>      06/07/26 18:18:54

Index: commands.texi
===================================================================
RCS file: /cvsroot/emacs/emacs/lispref/commands.texi,v
retrieving revision 1.88
retrieving revision 1.89
diff -u -b -r1.88 -r1.89
--- commands.texi       18 Jul 2006 01:35:03 -0000      1.88
+++ commands.texi       26 Jul 2006 18:18:54 -0000      1.89
@@ -2199,7 +2199,7 @@
 
 None of the three functions below suppresses quitting.
 
address@hidden read-event &optional prompt inherit-input-method
address@hidden read-event &optional prompt inherit-input-method seconds
 This function reads and returns the next event of command input, waiting
 if necessary until an event is available.  Events can come directly from
 the user or from a keyboard macro.
@@ -2220,6 +2220,15 @@
 moves the cursor temporarily to the echo area, to the end of any message
 displayed there.  Otherwise @code{read-event} does not move the cursor.
 
+If @code{seconds} is address@hidden, it should be a number specifying
+the maximum time to wait for input, in seconds.  If no input arrives
+within that time, @code{read-event} stops waiting and returns
address@hidden  A floating-point value for @code{seconds} means to wait
+for a fractional number of seconds.  Some systems support only a whole
+number of seconds; on these systems, @code{seconds} is rounded down.
+If @code{seconds} is @code{nil}, @code{read-event} waits as long as
+necessary for input to arrive.
+
 If @code{read-event} gets an event that is defined as a help character,
 then in some cases @code{read-event} processes the event directly without
 returning.  @xref{Help Functions}.  Certain other events, called
@@ -2237,7 +2246,7 @@
 @end example
 @end defun
 
address@hidden read-char &optional prompt inherit-input-method
address@hidden read-char &optional prompt inherit-input-method seconds
 This function reads and returns a character of command input.  If the
 user generates an event which is not a character (i.e. a mouse click or
 function key event), @code{read-char} signals an error.  The arguments
@@ -2269,7 +2278,7 @@
 @end example
 @end defun
 
address@hidden read-char-exclusive &optional prompt inherit-input-method
address@hidden read-char-exclusive &optional prompt inherit-input-method seconds
 This function reads and returns a character of command input.  If the
 user generates an event which is not a character,
 @code{read-char-exclusive} ignores it and reads another event, until it