X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_terminfo.3x.html;h=a800bfbe450395b2f3f9aa6e6634656be5844ee4;hp=eb8b33e4929407bae967d6b56fc0df921b5e84ee;hb=159cd0555e0efc14be66c9c3a1548f58908b6a1d;hpb=d90067f9008bb8338a77c1ed519bc108c275ed04 diff --git a/doc/html/man/curs_terminfo.3x.html b/doc/html/man/curs_terminfo.3x.html index eb8b33e4..a800bfbe 100644 --- a/doc/html/man/curs_terminfo.3x.html +++ b/doc/html/man/curs_terminfo.3x.html @@ -28,7 +28,7 @@ * sale, use or other dealings in this Software without prior written * * authorization. * **************************************************************************** - * @Id: curs_terminfo.3x,v 1.123 2023/12/16 21:11:53 tom Exp @ + * @Id: curs_terminfo.3x,v 1.124 2023/12/23 17:34:39 tom Exp @ * *************************************************************************** * *************************************************************************** * *************************************************************************** @@ -37,6 +37,8 @@ * *************************************************************************** * *************************************************************************** * *************************************************************************** + * See X/Open Curses Issue 4, Version 2, pp. 227-234. + * See X/Open Curses Issue 7, pp. 311-318. * *************************************************************************** * *************************************************************************** * *************************************************************************** @@ -46,12 +48,12 @@ -curs_terminfo 3x 2023-12-16 ncurses 6.4 Library calls +curs_terminfo 3x 2023-12-23 ncurses 6.4 Library calls -

curs_terminfo 3x 2023-12-16 ncurses 6.4 Library calls

curs_terminfo 3x 2023-12-23 ncurses 6.4 Library calls

 curs_terminfo(3x)                Library calls               curs_terminfo(3x)
 
@@ -110,6 +112,9 @@
        char *tiparm_s(int expected, int mask, const char *str, ...);
        int tiscan_s(int *expected, int *mask, const char *str);
 
+       /* deprecated */
+       int setterm(const char *term);
+

DESCRIPTION

        These low-level routines must be called by programs that have  to  deal
@@ -220,7 +225,7 @@

The Terminal State

        The  setupterm  routine  stores its information about the terminal in a
-       TERMINAL structure pointed to by the global variable cur_term.   If  it
+       TERMINAL structure pointed to by the global variable cur_term.   If  it
        detects  an error, or decides that the terminal is unsuitable (hardcopy
        or generic), it discards this information, making it not  available  to
        applications.
@@ -306,7 +311,7 @@
 
        o   affcnt is the number of lines affected, or 1 if not applicable.
 
-       o   putc is a putchar-like routine to which the characters are  passed,
+       o   putc is a putchar-like function to which the characters are passed,
            one at a time.
 
            If  tputs  processes  a  time-delay,  it  uses the delay_output(3x)
@@ -318,11 +323,11 @@
 
        The vidputs routine displays the string on the terminal  in  the  video
        attribute mode attrs, which is any combination of the attributes listed
-       in curses(3x).  The characters are passed to the  putchar-like  routine
+       in curses(3x).  The characters are passed to the putchar-like  function
        putc.
 
        The vidattr routine is like the vidputs routine, except that it outputs
-       through putchar.
+       through putchar.
 
        The vid_attr and vid_puts routines correspond to vidattr  and  vidputs,
        respectively.   They  use a set of arguments for representing the video
@@ -413,7 +418,7 @@
 
        o   to improve performance, ncurses 6.3 caches the result of  analyzing
            terminfo  strings  for  their parameter types.  That is stored as a
-           binary tree referenced from the TERMINAL structure.
+           binary tree referenced from the TERMINAL structure.
 
        The higher-level initscr and newterm functions use setupterm.  Normally
        they  do  not free this memory, but it is possible to do that using the
@@ -456,35 +461,51 @@

NOTES

-       X/Open notes that vidattr and vidputs may be macros.
+       According to X/Open Curses, any of the enhanced curses functions may be
+       implemented  as  macros.   The  term  "enhanced" refers to features not
+       found in SVr4 curses.
+
+       ncurses uses macros
+
+       o   for functions which return values via their parameters,
+
+       o   to support obsolete features,
+
+       o   to reuse functions, e.g., those that move the cursor before another
+           operation, and
+
+       o   a few special cases.
+
+       The  vid_puts function in ncurses is a special case.  It was originally
+       implemented based on a draft of X/Open Curses, as a macro, before other
+       parts of the ncurses wide-character API were developed.

EXTENSIONS

-       The functions marked as extensions were designed for  ncurses(3x),  and
-       are  not  found  in  SVr4  curses, 4.4BSD curses, or any other previous
-       version of curses.
+       The  functions  marked as extensions were designed for ncurses(3x), and
+       are not found in SVr4 curses, 4.4BSD  curses,  or  any  other  previous
+       curses implementation.

PORTABILITY

-       The function setterm is not described by X/Open and must be  considered
-       non-portable.  All other functions are as described by X/Open.
+       setterm is not described by X/Open and must be considered non-portable.
+       All other functions are as described by X/Open.

Compatibility Macros

-       This  implementation  provides  a  few  macros  for  compatibility with
-       systems before SVr4 (see  HISTORY).   Those  include  crmode,  fixterm,
-       gettmode, nocrmode, resetterm, saveterm, and setterm.
+       This implementation  provides  a  few  macros  for  compatibility  with
+       systems  before  SVr4  (see  section  "HISTORY"  below).   They include
+       Bcrmode, Bfixterm, Bgettmode,  Bnocrmode,  Bresetterm,  Bsaveterm,  and
+       Bsetterm.
 
-       In  SVr4,  those  are  found in <curses.h>, but except for setterm, are
+       In  SVr4,  these  are  found  in  curses.h, but except for setterm, are
        likewise macros.  The one function, setterm, is mentioned in the manual
-       page.   The  manual page notes that the setterm routine was replaced by
-       setupterm, stating that the call
-
-              setupterm(term, 1, (int *)0)
-
-       provides  the  same  functionality  as  setterm(term),   and   is   not
-       recommended  for  new  programs.   This implementation provides each of
-       those symbols as macros for BSD compatibility.
+       page.  It further notes that setterm was replaced by setupterm, stating
+       that the call
+              setupterm(term, 1, (int *)0)
+       provides the same  functionality  as  setterm(term),  discouraging  the
+       latter  for  new programs.  ncurses implements each of these symbols as
+       macros for BSD curses compatibility.

Legacy Data

@@ -599,7 +620,7 @@
        X/Open  notes  that after calling mvcur, the curses state may not match
        the actual terminal state, and that an  application  should  touch  and
        refresh  the  window before resuming normal curses calls.  Both ncurses
-       and System V Release 4 curses implement mvcur  using  the  SCREEN  data
+       and System V Release 4 curses implement mvcur  using  the  SCREEN  data
        allocated  in either initscr or newterm.  So though it is documented as
        a terminfo function, mvcur is really a curses  function  which  is  not
        well specified.
@@ -618,9 +639,8 @@
        fixterm     restore tty to "in curses" state
        gettmode    establish current tty modes
        mvcur       low level cursor motion
-
        putp        utility function that uses tputs  to  send  characters  via
-                   putchar.
+                   putchar.
        resetterm   set tty modes to "out of curses" state
        resetty     reset tty flags to stored value
        saveterm    save current modes as "in curses" state
@@ -629,7 +649,7 @@
        setupterm   establish terminal with given type
        tparm       instantiate a string expression with parameters
        tputs       apply padding information to a string
-       vidattr     like vidputs, but outputs through putchar
+       vidattr     like vidputs, but outputs through putchar
        vidputs     output  a  string  to  put  terminal  in  a specified video
                    attribute mode
 
@@ -646,7 +666,7 @@
        tputs      apply  padding  to  capability,  calling  a  function to put
                   characters
 
-       Early terminfo programs obtained capability values  from  the  TERMINAL
+       Early terminfo programs obtained capability values  from  the  TERMINAL
        structure initialized by setupterm.
 
        SVr3  extended  terminfo  by  adding  functions  to retrieve capability
@@ -654,6 +674,7 @@
 
        Function    Description
        ------------------------------------------------------------------------
+
        tigetflag   get boolean entry for given id
        tigetnum    get numeric entry for given id
        tigetstr    get string entry for given id
@@ -680,7 +701,7 @@
        descriptions,   e.g.,   set_curterm.   Some  of  that  was  incremental
        improvements to the SVr2 library:
 
-       o   The TERMINAL type definition was introduced  in  SVr3.01,  for  the
+       o   The TERMINAL type definition was introduced  in  SVr3.01,  for  the
            term structure provided in SVr2.
 
        o   The  various  global  variables such as boolnames were mentioned in
@@ -701,7 +722,7 @@
 
 
 
-ncurses 6.4                       2023-12-16                 curs_terminfo(3x)
+ncurses 6.4                       2023-12-23                 curs_terminfo(3x)