X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_termcap.3x.html;h=e3ed3202229bbd41047451dc6245c374a20b4bac;hp=4e3ca5a772a3dd7adf879cf30cb633534cee8fe1;hb=81304798ee736c467839c779c9ca5dca48db7bea;hpb=a6eb34d7fec8170a8715f9e53ca2f96452dd30dd;ds=inline diff --git a/doc/html/man/curs_termcap.3x.html b/doc/html/man/curs_termcap.3x.html index 4e3ca5a7..e3ed3202 100644 --- a/doc/html/man/curs_termcap.3x.html +++ b/doc/html/man/curs_termcap.3x.html @@ -1,6 +1,6 @@ - @@ -70,7 +70,7 @@

DESCRIPTION

        These routines are included as a conversion aid for programs  that  use
-       the  termcap  library.   Their parameters are the same and the routines
+       the  termcap  library.  Their parameters are the same, but the routines
        are emulated using the terminfo database.  Thus, they can only be  used
        to  query  the  capabilities  of entries for which a terminfo entry has
        been compiled.
@@ -184,12 +184,23 @@
        style parser if the string does not appear to be terminfo).
 
        Because terminfo conventions for representing padding in  string  capa-
-       bilities  differ  from  termcap's,  tputs("50"); will put out a literal
-       "50" rather than busy-waiting for 50 milliseconds.  Cope with it.
+       bilities differ from termcap's, users can be surprised:
 
-       Note that termcap has nothing analogous to terminfo's sgr string.   One
-       consequence  of  this  is that termcap applications assume me (terminfo
-       sgr0) does not reset the alternate character set.  This  implementation
+       o   tputs("50") in a terminfo system will put out a literal "50" rather
+           than busy-waiting for 50 milliseconds.
+
+       o   However, if ncurses is configured to support termcap, it  may  also
+           have been configured to support the BSD-style padding.
+
+           In that case, tputs inspects strings passed to it, looking for dig-
+           its at the beginning of the string.
+
+           tputs("50") in a termcap system may wait for 50 milliseconds rather
+           than put out a literal "50"
+
+       Note  that termcap has nothing analogous to terminfo's sgr string.  One
+       consequence of this is that termcap applications  assume  me  (terminfo
+       sgr0)  does not reset the alternate character set.  This implementation
        checks for, and modifies the data shown to the termcap interface to ac-
        commodate termcap's limitation in this respect.
 
@@ -197,22 +208,22 @@
 

PORTABILITY

 
 

Standards

-       These functions are provided for supporting  legacy  applications,  and
+       These  functions  are  provided for supporting legacy applications, and
        should not be used in new programs:
 
        o   The XSI Curses standard, Issue 4 describes these functions.  Howev-
-           er, they are marked TO BE WITHDRAWN and may be  removed  in  future
+           er,  they  are  marked TO BE WITHDRAWN and may be removed in future
            versions.
 
        o   X/Open Curses, Issue 5 (December 2007) marked the termcap interface
            (along with vwprintw and vwscanw) as withdrawn.
 
-       Neither the XSI Curses standard nor the SVr4 man pages  documented  the
-       return  values  of tgetent correctly, though all three were in fact re-
-       turned ever since SVr1.  In particular, an omission in the  XSI  Curses
-       documentation  has  been misinterpreted to mean that tgetent returns OK
-       or ERR.  Because the purpose of these functions is to provide  compati-
-       bility  with the termcap library, that is a defect in XCurses, Issue 4,
+       Neither  the  XSI Curses standard nor the SVr4 man pages documented the
+       return values of tgetent correctly, though all three were in  fact  re-
+       turned  ever  since SVr1.  In particular, an omission in the XSI Curses
+       documentation has been misinterpreted to mean that tgetent  returns  OK
+       or  ERR.  Because the purpose of these functions is to provide compati-
+       bility with the termcap library, that is a defect in XCurses, Issue  4,
        Version 2 rather than in ncurses.
 
 
@@ -220,68 +231,68 @@
        External variables are provided for support of certain termcap applica-
        tions.  However, termcap applications' use of those variables is poorly
        documented, e.g., not distinguishing between input and output.  In par-
-       ticular,  some  applications  are reported to declare and/or modify os-
+       ticular, some applications are reported to declare  and/or  modify  os-
        peed.
 
-       The comment that only the first two characters of the id parameter  are
+       The  comment that only the first two characters of the id parameter are
        used escapes many application developers.  The original BSD 4.2 termcap
        library (and historical relics thereof) did not require a trailing null
-       NUL  on  the  parameter  name  passed to tgetstr, tgetnum and tgetflag.
-       Some applications assume that the termcap interface  does  not  require
+       NUL on the parameter name passed  to  tgetstr,  tgetnum  and  tgetflag.
+       Some  applications  assume  that the termcap interface does not require
        the trailing NUL for the parameter name.  Taking into account these is-
        sues:
 
-       o   As a special case,  tgetflag  matched  against  a  single-character
-           identifier  provided  that  was at the end of the terminal descrip-
+       o   As  a  special  case,  tgetflag  matched against a single-character
+           identifier provided that was at the end of  the  terminal  descrip-
            tion.  You should not rely upon this behavior in portable programs.
-           This  implementation disallows matches against single-character ca-
+           This implementation disallows matches against single-character  ca-
            pability names.
 
-       o   This implementation disallows  matches  by  the  termcap  interface
+       o   This  implementation  disallows  matches  by  the termcap interface
            against extended capability names which are longer than two charac-
            ters.
 
        The BSD termcap function tgetent returns the text of a termcap entry in
-       the  buffer  passed  as an argument.  This library (like other terminfo
+       the buffer passed as an argument.  This library  (like  other  terminfo
        implementations) does not store terminal descriptions as text.  It sets
        the buffer contents to a null-terminated string.
 
 
 

Other Compatibility

-       This  library includes a termcap.h header, for compatibility with other
-       implementations.  But the header is rarely used because the  other  im-
+       This library includes a termcap.h header, for compatibility with  other
+       implementations.   But  the header is rarely used because the other im-
        plementations are not strictly compatible.
 
        The original BSD termcap (through 4.3BSD) had no header file which gave
        function prototypes, because that was a feature of ANSI C.  BSD termcap
-       was  written  several  years before C was standardized.  However, there
+       was written several years before C was  standardized.   However,  there
        were two different termcap.h header files in the BSD sources:
 
-       o   One was used internally by the jove editor in 2BSD through  4.4BSD.
+       o   One  was used internally by the jove editor in 2BSD through 4.4BSD.
            It defined global symbols for the termcap variables which it used.
 
-       o   The  other  appeared in 4.4BSD Lite Release 2 (mid-1993) as part of
+       o   The other appeared in 4.4BSD Lite Release 2 (mid-1993) as  part  of
            libedit (also known as the editline library).  The CSRG source his-
-           tory  shows  that  this  was added in mid-1992.  The libedit header
-           file was used internally, as a convenience for compiling the  edit-
+           tory shows that this was added in  mid-1992.   The  libedit  header
+           file  was used internally, as a convenience for compiling the edit-
            line library.  It declared function prototypes, but no global vari-
            ables.
 
-       The header file from libedit was added to NetBSD's termcap  library  in
+       The  header  file from libedit was added to NetBSD's termcap library in
        mid-1994.
 
-       Meanwhile,  GNU  termcap  was under development, starting in 1990.  The
-       first release (termcap 1.0) in 1991 included a termcap.h  header.   The
-       second  release  (termcap 1.1) in September 1992 modified the header to
+       Meanwhile, GNU termcap was under development, starting  in  1990.   The
+       first  release  (termcap 1.0) in 1991 included a termcap.h header.  The
+       second release (termcap 1.1) in September 1992 modified the  header  to
        use const for the function prototypes in the header where one would ex-
-       pect  the parameters to be read-only.  This was a difference versus the
-       original BSD termcap.  The prototype for tputs also  differed,  but  in
+       pect the parameters to be read-only.  This was a difference versus  the
+       original  BSD  termcap.   The prototype for tputs also differed, but in
        that instance, it was libedit which differed from BSD termcap.
 
        A copy of GNU termcap 1.3 was bundled with bash in mid-1993, to support
        the readline library.
 
-       A termcap.h file was provided in ncurses 1.8.1 (November  1993).   That
+       A  termcap.h  file was provided in ncurses 1.8.1 (November 1993).  That
        reflected influence by emacs (rather than jove) and GNU termcap:
 
        o   it provided declarations for a few global symbols used by emacs
@@ -291,8 +302,8 @@
        o   a prototype for tparam (a GNU termcap feature) was provided.
 
        Later (in mid-1996) the tparam function was removed from ncurses.  As a
-       result, there are differences between any of the four  implementations,
-       which  must  be  taken into account by programs which can work with all
+       result,  there are differences between any of the four implementations,
+       which must be taken into account by programs which can  work  with  all
        termcap library interfaces.