X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_util.3x.html;h=760298dc891aa64ecf8a7f0fd7a0a8234b99d999;hp=0fed7678fc28f6d363f73c3d0c3149d79dd20ae3;hb=55ccd2b959766810cf7db8d1c4462f338ce0afc8;hpb=46722468f47c2b77b3987729b4bcf2321cccfd01 diff --git a/doc/html/man/curs_util.3x.html b/doc/html/man/curs_util.3x.html index 0fed7678..760298dc 100644 --- a/doc/html/man/curs_util.3x.html +++ b/doc/html/man/curs_util.3x.html @@ -1,7 +1,7 @@ @@ -40,11 +40,15 @@ 
 
+curs_util(3x)                                             curs_util(3x)
+
+
+

NAME

        delay_output, filter, flushinp, getwin, key_name, keyname,
-       putwin, unctrl, use_env, wunctrl  -  miscellaneous  curses
+       putwin, unctrl, use_env, wunctrl - miscellaneous curses
        utility routines
 
 
@@ -53,7 +57,7 @@
        #include <curses.h>
 
        char *unctrl(chtype c);
-       char *wunctrl(wchar_t w);
+       char *wunctrl(cchar_t *c);
        char *keyname(int c);
        char *key_name(wchar_t w);
        void filter(void);
@@ -67,9 +71,9 @@

DESCRIPTION

        The  unctrl  routine returns a character string which is a
-       printable representation  of  the  character  c,  ignoring
-       attributes.   Control  characters  are displayed in the ^X
-       notation.  Printing characters are displayed as  is.   The
+       printable representation of the character c, ignoring  at-
+       tributes.   Control characters are displayed in the ^X no-
+       tation.  Printing characters are  displayed  as  is.   The
        corresponding  wunctrl  returns a printable representation
        of a wide-character.
 
@@ -94,9 +98,11 @@
        ment, the values of lines and  columns  specified  in  the
        terminfo  database will be used, even if environment vari-
        ables LINES and COLUMNS (used by default) are set,  or  if
-       curses  is  running  in  a  window  (in which case default
-       behavior would be to use the  window  size  if  LINES  and
-       COLUMNS are not set).
+       curses  is  running in a window (in which case default be-
+       havior would be to  use  the  window  size  if  LINES  and
+       COLUMNS  are not set).  Note that setting LINES or COLUMNS
+       overrides the corresponding size  which  may  be  obtained
+       from the operating system.
 
        The  putwin routine writes all data associated with window
        win into the file to which filep points.  This information
@@ -110,56 +116,67 @@
        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.
+       pause.   If  no  padding character is specified, this uses
+       napms to perform the delay.
 
-       The  flushinp  routine  throws away any typeahead that has
-       been typed by the user and has not yet been  read  by  the
+       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") upon successful completion.
-
-       flushinp always returns OK.
+       Except for flushinp, routines that return an  integer  re-
+       turn  ERR upon failure and OK (SVr4 specifies only "an in-
+       teger value other than ERR") upon successful completion.
 
        Routines that return pointers return NULL on error.
 
+       X/Open does not define any error conditions.  In this  im-
+       plementation
 
-
-

PORTABILITY

-       The XSI Curses standard, Issue  4  describes  these  func-
-       tions.   It  states  that unctrl and wunctrl will return a
-       null pointer if unsuccessful,  but  does  not  define  any
-       error conditions.
+              flushinp
+                   returns  an error if the terminal was not ini-
+                   tialized.
 
-       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).
+              putwin
+                   returns an  error  if  the  associated  fwrite
+                   calls return an error.
-

SEE ALSO

-       curses(3x), curs_initscr(3x), curs_scr_dump(3x).
-
-
-
-
-
-
-
-
+
PORTABILITY
+       The  XSI  Curses  standard,  Issue 4 describes these func-
+       tions.  It states that unctrl and wunctrl  will  return  a
+       null  pointer if unsuccessful, but does not define any er-
+       ror conditions.
 
+       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).
 
+       The  strings returned by unctrl in this implementation are
+       determined at compile time, showing C1 controls  from  the
+       upper-128  codes with a `~' prefix rather than `^'.  Other
+       implementations typically show both sets of control  char-
+       acters  with  `^',  and may strip the parameter to 7 bits.
+       This implementation uses 8 bits but does  not  modify  the
+       string to reflect locale.
 
+       The  keyname function may return the names of user-defined
+       string capabilities which are defined in the terminfo  en-
+       try via the -x option of tic.
 
 
+

+
SEE ALSO
+       curses(3x),       curs_initscr(3x),       curs_kernel(3x),
+       curs_scr_dump(3x).
 
 
 
+                                                          curs_util(3x)