X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_termcap.3x.html;h=cd5a0773e7825d6b5f9e198227d3f1bb1962b646;hp=42436ac6e9fb0af61055884369f54fc6d3d8dfd7;hb=17c5992a16be94247b83f2bbb9accdd9b7e7bb72;hpb=bca50d0d8592defee6c584fdedd25f4b1a31345b diff --git a/doc/html/man/curs_termcap.3x.html b/doc/html/man/curs_termcap.3x.html index 42436ac6..cd5a0773 100644 --- a/doc/html/man/curs_termcap.3x.html +++ b/doc/html/man/curs_termcap.3x.html @@ -26,7 +26,7 @@ * sale, use or other dealings in this Software without prior written * * authorization. * **************************************************************************** - * @Id: curs_termcap.3x,v 1.36 2018/01/01 15:13:16 tom Exp @ + * @Id: curs_termcap.3x,v 1.40 2018/07/28 21:14:06 tom Exp @ --> @@ -59,10 +59,10 @@ extern char * BC; extern short ospeed; - int tgetent(char *bp, const char *name); - int tgetflag(char *id); - int tgetnum(char *id); - char *tgetstr(char *id, char **area); + int tgetent(const char *bp, const char *name); + int tgetflag(const char *id); + int tgetnum(const char *id); + char *tgetstr(const char *id, char **area); char *tgoto(const char *cap, int col, int row); int tputs(const char *str, int affcnt, int (*putc)(int)); @@ -149,50 +149,60 @@ o Normally the ncurses library is compiled with terminfo support. In that case, tgoto uses tparm(3x) (a more capable formatter). - The tputs routine is described on the curs_terminfo(3x) manual page. + However, tparm is not a termcap feature, and portable termcap ap- + plications should not rely upon its availability. + + The tputs routine is described on the curs_terminfo(3x) manual page. It can retrieve capabilities by either termcap or terminfo name.

GLOBAL VARIABLES

-       The variables PC, UP and BC are set by tgetent to the terminfo  entry's
+       The  variables PC, UP and BC are set by tgetent to the terminfo entry's
        data for pad_char, cursor_up and backspace_if_not_bs, respectively.  UP
-       is not used by ncurses.  PC is used in the tdelay_output function.   BC
-       is  used in the tgoto emulation.  The variable ospeed is set by ncurses
+       is  not used by ncurses.  PC is used in the tdelay_output function.  BC
+       is used in the tgoto emulation.  The variable ospeed is set by  ncurses
        in a system-specific coding to reflect the terminal speed.
 
 
 

RETURN VALUE

-       Except where explicitly noted, routines that return an  integer  return
-       ERR  upon  failure  and OK (SVr4 only specifies "an integer value other
+       Except  where  explicitly noted, routines that return an integer return
+       ERR upon failure and OK (SVr4 only specifies "an  integer  value  other
        than ERR") upon successful completion.
 
        Routines that return pointers return NULL on error.
 
 
 

BUGS

-       If you call tgetstr to fetch ca or any other parameterized  string,  be
-       aware  that it will be returned in terminfo notation, not the older and
+       If  you  call tgetstr to fetch ca or any other parameterized string, be
+       aware that it will be returned in terminfo notation, not the older  and
        not-quite-compatible termcap notation.  This will not cause problems if
-       all  you do with it is call tgoto or tparm, which both expand terminfo-
-       style strings as terminfo.  (The tgoto function, if configured to  sup-
-       port  termcap,  will  check  if  the string is indeed terminfo-style by
-       looking for "%p" parameters or "$<..>" delays, and  invoke  a  termcap-
+       all you do with it is call tgoto or tparm, which both expand  terminfo-
+       style  strings as terminfo.  (The tgoto function, if configured to sup-
+       port termcap, will check if the  string  is  indeed  terminfo-style  by
+       looking  for  "%p"  parameters or "$<..>" delays, and invoke a termcap-
        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
+       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.
 
-       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
+       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.
 
 
 

PORTABILITY

-       The  XSI  Curses standard, Issue 4 describes these functions.  However,
-       they are marked TO BE WITHDRAWN and may be removed in future versions.
+       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
+           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-