X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_termcap.3x.html;h=36c4e7acdd9440ca030b81168ebfd76ba72eabe3;hp=178efe78afa6f423f6555304741ba6b37939839f;hb=a0b91dc27f0c411e343161b0a4b5459d15a43f85;hpb=e2d7d0028f4298dca2b0edaf2dc8ce30518d9218 diff --git a/doc/html/man/curs_termcap.3x.html b/doc/html/man/curs_termcap.3x.html index 178efe78..36c4e7ac 100644 --- a/doc/html/man/curs_termcap.3x.html +++ b/doc/html/man/curs_termcap.3x.html @@ -1,7 +1,6 @@ - +
+ +- curs_termcap(3x) curs_termcap(3x)-
+NAME
PC, UP, BC, ospeed, tgetent, tgetflag, tgetnum, tgetstr, tgoto, tputs - direct curses interface to the terminfo capability database-SYNOPSIS
+SYNOPSIS
#include <curses.h> #include <term.h> @@ -71,7 +71,7 @@-DESCRIPTION
+DESCRIPTION
These routines are included as a conversion aid for pro- grams that use the termcap library. Their parameters are the same and the routines are emulated using the terminfo @@ -79,7 +79,9 @@ bilities of entries for which a terminfo entry has been compiled. - INITIALIZATION + ++INITIALIZATION
The tgetent routine loads the entry for name. It returns: 1 on success, @@ -104,7 +106,9 @@ is marked with the generic capability, or if the terminal description has cursor-addressing. - CAPABILITY VALUES + ++CAPABILITY VALUES
The tgetflag routine gets the boolean entry for id, or ze- ro if it is not available. @@ -113,14 +117,30 @@ The tgetstr routine returns the string entry for id, or zero if it is not available. Use tputs to output the re- - turned string. The return value will also be copied to - the buffer pointed to by area, and the area value will be - updated to point past the null ending this value. + turned string. The area parameter is used as follows: + + o It is assumed to be the address of a pointer to a + buffer managed by the calling application. + + o However, ncurses checks to ensure that area is not + NULL, and also that the resulting buffer pointer is + not NULL. If either check fails, the area parame- + ter is ignored. + + o If the checks succeed, ncurses also copies the re- + turn value to the buffer pointed to by area, and + the area value will be updated to point past the + null ending this value. + + o The return value itself is an address in the termi- + nal description which is loaded into memory. Only the first two characters of the id parameter of tget- flag, tgetnum and tgetstr are compared in lookups. - FORMATTING CAPABILITIES + ++FORMATTING CAPABILITIES
The tgoto routine instantiates the parameters into the given capability. The output from this routine is to be passed to tputs. @@ -129,7 +149,9 @@ manual page. It can retrieve capabilities by either term- cap or terminfo name. - GLOBAL VARIABLES + ++GLOBAL VARIABLES
The variables PC, UP and BC are set by tgetent to the ter- minfo entry's data for pad_char, cursor_up and backspace_if_not_bs, respectively. UP is not used by @@ -140,7 +162,7 @@-RETURN VALUE
+RETURN VALUE
Except where explicitly noted, routines that return an in- teger return ERR upon failure and OK (SVr4 only specifies "an integer value other than ERR") upon successful comple- @@ -150,7 +172,7 @@-BUGS
+BUGS
If you call tgetstr to fetch ca or any other parameterized string, be aware that it will be returned in terminfo no- tation, not the older and not-quite-compatible termcap no- @@ -176,7 +198,7 @@-PORTABILITY
+PORTABILITY
The XSI Curses standard, Issue 4 describes these func- tions. However, they are marked TO BE WITHDRAWN and may be removed in future versions. @@ -218,8 +240,8 @@-SEE ALSO
- curses(3x), terminfo(5), term_variables(3x), putc(3). +SEE ALSO
+ curses(3x), terminfo(5), term_variables(3x), putc(3). http://invisible-island.net/ncurses/tctest.html @@ -227,10 +249,23 @@ curs_termcap(3x)-
- -Man(1) output converted with -man2html - +