X-Git-Url: http://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_util.3x.html;h=6d04cda35e549150dce18402e218498ce0b465c6;hb=122d3739b3c11c83decc625d53f26fff6e825710;hp=956e477461f0dff36b50d96c2eec48ff478c9b6f;hpb=7e062bb2764a87d98073a90ee65a234a2679f9c1;p=ncurses.git diff --git a/doc/html/man/curs_util.3x.html b/doc/html/man/curs_util.3x.html index 956e4774..6d04cda3 100644 --- a/doc/html/man/curs_util.3x.html +++ b/doc/html/man/curs_util.3x.html @@ -28,19 +28,19 @@ * sale, use or other dealings in this Software without prior written * * authorization. * **************************************************************************** - * @Id: curs_util.3x,v 1.85 2023/09/30 21:38:11 tom Exp @ + * @Id: curs_util.3x,v 1.88 2023/10/14 22:26:23 tom Exp @ --> -curs_util 3x 2023-09-30 ncurses 6.4 Library calls +curs_util 3x 2023-10-14 ncurses 6.4 Library calls -

curs_util 3x 2023-09-30 ncurses 6.4 Library calls

+

curs_util 3x 2023-10-14 ncurses 6.4 Library calls

 curs_util(3x)                    Library calls                   curs_util(3x)
 
@@ -228,19 +228,28 @@

delay_output

        The delay_output routine inserts an ms  millisecond  pause  in  output.
-       This  routine should not be used extensively because padding characters
-       are used  rather  than  a  CPU  pause.   If  no  padding  character  is
-       specified, this uses napms to perform the delay.
+       Employ  this  function  judiciously  when terminal output uses padding,
+       because ncurses  transmits  null  characters  (consuming  CPU  and  I/O
+       resources)  instead  of  sleeping  and  requesting  resumption from the
+       operating system.  Padding is used unless:
+
+       o   the terminal description has npc (no_pad_char) capability, or
+
+       o   the environment variable NCURSES_NO_PADDING is set.
+
+       If padding is not in use, ncurses uses napms to perform the delay.   If
+       the  value  of ms exceeds 30,000 (thirty seconds), it is capped at that
+       value.

flushinp

-       The  flushinp  routine throws away any typeahead that has been typed by
+       The flushinp routine throws away any typeahead that has been  typed  by
        the user and has not yet been read by the program.

RETURN VALUE

-       Except for flushinp, routines that return an integer  return  ERR  upon
-       failure  and OK (SVr4 specifies only "an integer value other than ERR")
+       Except  for  flushinp,  routines that return an integer return ERR upon
+       failure and OK (SVr4 specifies only "an integer value other than  ERR")
        upon successful completion.
 
        Routines that return pointers return NULL on error.
@@ -251,18 +260,31 @@
                returns an error if the terminal was not initialized.
 
           putwin
-               returns an error if  the  associated  fwrite  calls  return  an
+               returns  an  error  if  the  associated  fwrite calls return an
                error.

PORTABILITY

filter

-       The  SVr4  documentation  describes  the  action  of filter only in the
-       vaguest terms.  The description here is adapted  from  the  XSI  Curses
+       The SVr4 documentation describes the  action  of  filter  only  in  the
+       vaguest  terms.   The  description  here is adapted from the XSI Curses
        standard (which erroneously fails to describe the disabling of cuu).
 
 
+

delay_output padding

+       The limitation to 30 seconds and the use of  napms  differ  from  other
+       implementations.
+
+       o   SVr4 curses does not delay if no padding character is available.
+
+       o   NetBSD  curses  uses  napms when no padding character is available,
+           but does not take  timing  into  account  when  using  the  padding
+           character.
+
+       Neither limits the delay.
+
+

keyname

        The  keyname  function  may  return  the  names  of user-defined string
        capabilities which are defined in the terminfo entry via the -x  option
@@ -369,7 +391,7 @@
 
 
 
-ncurses 6.4                       2023-09-30                     curs_util(3x)
+ncurses 6.4                       2023-10-14                     curs_util(3x)