[PATCH 09/17] Document ceiling on time delays.

[G. Branden Robinson]

...introduced in 20230917.

* man/curs_kernel.3x:
* man/curs_terminfo.3x:
* man/curs_util.3x: Do it.
---
 man/curs_kernel.3x   |  3 +++
 man/curs_terminfo.3x | 14 ++++++++++----
 man/curs_util.3x     |  3 +++
 3 files changed, 16 insertions(+), 4 deletions(-)

diff --git a/man/curs_kernel.3x b/man/curs_kernel.3x
index b563a176..67cfdbc9 100644
--- a/man/curs_kernel.3x
+++ b/man/curs_kernel.3x
@@ -167,6 +167,9 @@ .SS curs_set
 otherwise, \fBERR\fP is returned.
 .SS napms
 The \fBnapms\fP routine is used to sleep for \fIms\fP milliseconds.
+If the value of \fIms\fP exceeds 30,000
+(thirty seconds),
+it is capped at that value.
 .SH RETURN VALUE
 Except for \fBcurs_set\fP, these routines always return \fBOK\fP.
 .PP
diff --git a/man/curs_terminfo.3x b/man/curs_terminfo.3x
index 0ef5a495..b363c78a 100644
--- a/man/curs_terminfo.3x
+++ b/man/curs_terminfo.3x
@@ -314,10 +314,16 @@ .SS Formatting Output
 to inspect a formatting capability to see what the curses library would assume.
 .\" ***************************************************************************
 .SS Output Functions
-The \fBtputs\fP routine applies padding information
-(i.e., by interpreting marker embedded in the terminfo capability
-such as \*(``$<5>\*('' as 5 milliseconds)
-to the string
+String capabilities can contain padding information,
+a time delay
+(accommodating performance limitations of hardware terminals)
+expressed as \fB$<\fP\fIn\fP\fB>\fP,
+where \fIn\fP is a nonnegative integral count of milliseconds.
+If \fIn\fP exceeds 30,000
+(thirty seconds),
+it is capped at that value.
+.PP
+The \fBtputs\fP routine applies padding information to the string
 \fIstr\fP and outputs it:
 .bP
 The \fIstr\fP parameter must be a terminfo string
diff --git a/man/curs_util.3x b/man/curs_util.3x
index dfa78951..bde76e9b 100644
--- a/man/curs_util.3x
+++ b/man/curs_util.3x
@@ -263,6 +263,9 @@ .SS delay_output
 padding characters are used rather than a CPU pause.
 If no padding character is specified,
 this uses \fBnapms\fP to perform the delay.
+If the value of \fIms\fP exceeds 30,000
+(thirty seconds),
+it is capped at that value.
 .SS flushinp
 The \fBflushinp\fP routine throws away any typeahead that has been typed by the
 user and has not yet been read by the program.
-- 
2.30.2

signature.asc
Description: PGP signature