[PATCH 06/45] man/curs_inopts.3x: Recast description of `typeahead()`.

[G. Branden Robinson]

Tighten wording.  Promote mentions of ncurses functions not documented
in this man page to proper cross references.  Say and imply less about
how frequently the library decides when to check for pending input.
---
 man/curs_inopts.3x | 41 ++++++++++++++++++++++++-----------------
 1 file changed, 24 insertions(+), 17 deletions(-)

diff --git a/man/curs_inopts.3x b/man/curs_inopts.3x
index 7489855af..670637ec5 100644
--- a/man/curs_inopts.3x
+++ b/man/curs_inopts.3x
@@ -317,25 +317,32 @@ .SS "timeout, wtimeout"
 (where \fIdelay\fP is positive).
 .\"
 .SS typeahead
-.I curses
-checks its input file descriptor
-periodically while updating the screen.
-If input is found,
-and it is coming from a terminal,
-the current update is postponed until
-\fB\%refresh\fP(3X) or \fB\%doupdate\fP is called again.
-This allows faster response to commands typed in advance.
 Normally,
-the input
+a
+.I curses
+library checks the terminal for input while updating the screen.
+If any is found,
+the update is postponed until the next \fB\%wrefresh\fP(3X) or
+\fB\%doupdate\fP(3X) call,
+allowing faster response to user key strokes.
+The library tests the file descriptor corresponding to the
 .I FILE
-pointer passed to \fB\%newterm\fP,
-or \fBstdin\fP in the case that \fB\%initscr\fP was used,
-will be used to do this typeahead checking.
-The \fB\%typeahead\fP routine specifies that the file descriptor
-\fIfd\fP is to be used to check for typeahead instead.
-If \fIfd\fP is
-\-1,
-then no typeahead checking is done.
+stream pointer passed to \fB\%newterm\fP(3X)
+(or
+.I stdin
+if \fB\%initscr\fP(3X) was called),
+for pending input.
+.B \%typeahead
+instructs
+.I curses
+to test file descriptor
+.I fd
+instead.
+An
+.I fd
+of
+.B \-1
+disables the check.
 .\"
 .SH RETURN VALUE
 All routines that return an integer return \fBERR\fP upon failure and
-- 
2.30.2

signature.asc
Description: PGP signature