X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_util.3x.html;h=9b6c3655f6125dd17530d069201226d6fdbf02ad;hp=a923c7654fc9ccbdbd50cb710f5ea6aa17e4418a;hb=HEAD;hpb=5e7c0d571f78d9a76ea55fb5bb3a145d0e164264 diff --git a/doc/html/man/curs_util.3x.html b/doc/html/man/curs_util.3x.html index a923c765..8e641fe9 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.98 2024/03/16 15:50:09 tom Exp @ + * @Id: curs_util.3x,v 1.104 2024/05/25 20:10:58 tom Exp @ --> -curs_util 3x 2024-03-16 ncurses 6.4 Library calls +curs_util 3x 2024-05-25 ncurses 6.5 Library calls -

curs_util 3x 2024-03-16 ncurses 6.4 Library calls

+

curs_util 3x 2024-05-25 ncurses 6.5 Library calls

 curs_util(3x)                    Library calls                   curs_util(3x)
 
@@ -56,15 +56,15 @@

SYNOPSIS

        #include <curses.h>
 
-       const char *unctrl(chtype c);
-       wchar_t *wunctrl(cchar_t *c);
+       const char *unctrl(chtype ch);
+       wchar_t *wunctrl(cchar_t *wch);
 
        const char *keyname(int c);
-       const char *key_name(wchar_t w);
+       const char *key_name(wchar_t wc);
 
        void filter(void);
 
-       void use_env(bool f);
+       void use_env(bool bf);
 
        int putwin(WINDOW *win, FILE *filep);
        WINDOW *getwin(FILE *filep);
@@ -74,14 +74,14 @@
 
        /* extensions */
        void nofilter(void);
-       void use_tioctl(bool f);
+       void use_tioctl(bool bf);

DESCRIPTION

unctrl

        The  unctrl  routine  returns  a  character string which is a printable
-       representation of the character c:
+       representation of the character ch:
 
        o   Printable characters are displayed  as  themselves,  e.g.,  a  one-
            character string containing the key.
@@ -99,7 +99,7 @@
            this follows the X/Open specification.
 
        The  corresponding  wunctrl  returns  a  printable  representation of a
-       complex character c.
+       complex character wch.
 
        In both unctrl and wunctrl the attributes and color associated with the
        character parameter are ignored.
@@ -192,85 +192,83 @@
 
               use_env   use_tioctl   Summary
               -----------------------------------------------------------------
-              TRUE      FALSE        This  is  the  default behavior.  ncurses
-                                     uses  operating   system   calls   unless
-                                     overridden    by    LINES    or   COLUMNS
+              TRUE      FALSE        ncurses   uses   operating  system  calls
+                                     unless overridden  by  LINES  or  COLUMNS
                                      environment variables; default.
-              TRUE      TRUE         ncurses updates LINES and  COLUMNS  based
+              TRUE      TRUE         ncurses  updates  LINES and COLUMNS based
                                      on operating system calls.
-              FALSE     TRUE         ncurses  ignores LINES and COLUMNS, using
+              FALSE     TRUE         ncurses ignores LINES and COLUMNS,  using
                                      operating system calls to obtain size.

putwin, getwin

-       The putwin routine writes all data associated with window (or pad)  win
-       into  the  file  to  which filep points.  This information can be later
+       The  putwin routine writes all data associated with window (or pad) win
+       into the file to which filep points.  This  information  can  be  later
        retrieved using the getwin function.
 
-       The getwin routine reads window related data  stored  in  the  file  by
-       putwin.   The  routine  then creates and initializes a new window using
-       that data.  It returns a pointer to the new window.  There  are  a  few
+       The  getwin  routine  reads  window  related data stored in the file by
+       putwin.  The routine then creates and initializes a  new  window  using
+       that  data.   It  returns a pointer to the new window.  There are a few
        caveats:
 
-       o   the  data  written  is  a  copy  of  the  WINDOW structure, and its
-           associated character cells.  The format differs between  the  wide-
-           character  (ncursesw)  and  non-wide  (ncurses) libraries.  You can
+       o   the data written is  a  copy  of  the  WINDOW  structure,  and  its
+           associated  character  cells.  The format differs between the wide-
+           character (ncursesw) and non-wide  (ncurses)  libraries.   You  can
            transfer data between the two, however.
 
-       o   the retrieved window is always created as a  top-level  window  (or
+       o   the  retrieved  window  is always created as a top-level window (or
            pad), rather than a subwindow.
 
-       o   the  window's character cells contain the color pair value, but not
-           the actual color numbers.  If cells in  the  retrieved  window  use
-           color  pairs  which  have not been created in the application using
+       o   the window's character cells contain the color pair value, but  not
+           the  actual  color  numbers.   If cells in the retrieved window use
+           color pairs which have not been created in  the  application  using
            init_pair, they will not be colored when the window is refreshed.

delay_output

-       The delay_output routine inserts an ms  millisecond  pause  in  output.
-       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
+       The  delay_output  routine  inserts  an ms millisecond pause in output.
+       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
+       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.
 
-       X/Open   Curses  does  not  specify  any  error  conditions.   In  this
+       X/Open  Curses  does  not  specify  any  error  conditions.   In   this
        implementation
 
           flushinp
-               returns an error if the terminal was not initialized.
+               returns ERR if the terminal was not initialized.
 
           putwin
-               returns an error if  the  associated  fwrite  calls  return  an
-               error.
+               returns ERR if the associated fwrite calls return ERR.

PORTABILITY

filter

        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).
+       vaguest terms.  The description here  is  adapted  from  X/Open  Curses
+       (which erroneously fails to describe the disabling of cuu).

delay_output padding

@@ -333,10 +331,10 @@

unctrl, wunctrl

-       The XSI Curses standard, Issue 4 describes these functions.  It  states
-       that unctrl and wunctrl will return a null pointer if unsuccessful, but
-       does not define any error conditions.  This implementation  checks  for
-       three cases:
+       X/Open Curses, Issue 4  describes  these  functions.   It  states  that
+       unctrl and wunctrl will return a null pointer if unsuccessful, but does
+       not define any error conditions.  This implementation checks for  three
+       cases:
 
        o   the  parameter  is  a  7-bit  US-ASCII code.  This is the case that
            X/Open Curses documented.
@@ -392,7 +390,7 @@
 
 
 
-ncurses 6.4                       2024-03-16                     curs_util(3x)
+ncurses 6.5                       2024-05-25                     curs_util(3x)