X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_termcap.3x.html;h=55b21c16b396885a6014a2f056da309c10a36aab;hp=42436ac6e9fb0af61055884369f54fc6d3d8dfd7;hb=d66080c21038ad4feb2e41a0c4e517d5b4a03ab2;hpb=1501ae2a13db0ffd2db8404c24aa5010a88ea91b
diff --git a/doc/html/man/curs_termcap.3x.html b/doc/html/man/curs_termcap.3x.html
index 42436ac6..55b21c16 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.37 2018/01/23 10:14:38 tom Exp @
-->
@@ -149,80 +149,83 @@
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.
- 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.
- 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.
- 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.
- The XSI Curses standard, Issue 4 describes these functions. However,
+ The XSI Curses standard, Issue 4 describes these functions. However,
they are marked TO BE WITHDRAWN and may be removed in future versions.
- 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.
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.