ncurses 6.1 - patch 20181208

[ncurses.git] / man / curs_termcap.3x

diff --git a/man/curs_termcap.3x b/man/curs_termcap.3x
index 7696ee9ad3f85c8e727af34f14b754c2efa83ac5..34d02f2e9e3d8316617f9f80c885d6bc61aad06f 100644 (file)
--- a/man/curs_termcap.3x
+++ b/man/curs_termcap.3x
@@ -26,7 +26,7 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
 .\" 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 $

 .TH curs_termcap 3X ""
 .de bP
 .ie n  .IP \(bu 4
 .TH curs_termcap 3X ""
 .de bP
 .ie n  .IP \(bu 4


@@ -61,13 +61,13 @@
 .br
 \fBextern @NCURSES_OSPEED@ ospeed;\fR
 .sp
 .br
 \fBextern @NCURSES_OSPEED@ ospeed;\fR
 .sp

-\fBint tgetent(char *bp, const char *name);\fR
+\fBint tgetent(const char *bp, const char *name);\fR

 .br
 .br

-\fBint tgetflag(char *id);\fR
+\fBint tgetflag(const char *id);\fR

 .br
 .br

-\fBint tgetnum(char *id);\fR
+\fBint tgetnum(const char *id);\fR

 .br
 .br

-\fBchar *tgetstr(char *id, char **area);\fR
+\fBchar *tgetstr(const char *id, char **area);\fR

 .br
 \fBchar *tgoto(const char *cap, int col, int row);\fR
 .br
 .br
 \fBchar *tgoto(const char *cap, int col, int row);\fR
 .br


@@ -75,8 +75,10 @@
 .br
 .SH DESCRIPTION
 These routines are included as a conversion aid for programs that use
 .br
 .SH DESCRIPTION
 These routines are included as a conversion aid for programs that use

-the \fItermcap\fR library.  Their parameters are the same and the
-routines are emulated using the \fIterminfo\fR database.  Thus, they
+the \fItermcap\fR library.
+Their parameters are the same and the
+routines are emulated using the \fIterminfo\fR database.
+Thus, they

 can only be used to query the capabilities of entries for which a
 terminfo entry has been compiled.
 .SS INITIALIZATION
 can only be used to query the capabilities of entries for which a
 terminfo entry has been compiled.
 .SS INITIALIZATION


@@ -167,9 +169,13 @@ In that case, the first parameter is merely a placeholder.
 .bP
 Normally the ncurses library is compiled with terminfo support.
 In that case, \fBtgoto\fP uses \fBtparm\fP(3X) (a more capable formatter).
 .bP
 Normally the ncurses library is compiled with terminfo support.
 In that case, \fBtgoto\fP uses \fBtparm\fP(3X) (a more capable formatter).

+.IP
+However, \fBtparm\fP is not a \fItermcap\fP feature,
+and portable \fItermcap\fP applications should not rely upon its availability.

 .PP
 The \fBtputs\fR routine is described on the \fBcurs_terminfo\fR(3X) manual
 .PP
 The \fBtputs\fR routine is described on the \fBcurs_terminfo\fR(3X) manual

-page.  It can retrieve capabilities by either termcap or terminfo name.
+page.
+It can retrieve capabilities by either termcap or terminfo name.

 .SS GLOBAL VARIABLES
 .PP
 The variables
 .SS GLOBAL VARIABLES
 .PP
 The variables


@@ -197,7 +203,8 @@ Routines that return pointers return \fBNULL\fR on error.
 .SH BUGS
 If you call \fBtgetstr\fR to fetch \fBca\fR or any other parameterized string,
 be aware that it will be returned in terminfo notation, not the older and
 .SH BUGS
 If you call \fBtgetstr\fR to fetch \fBca\fR 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
+not-quite-compatible termcap notation.
+This will not cause problems if all

 you do with it is call \fBtgoto\fR or \fBtparm\fR, which both expand
 terminfo-style strings as terminfo.
 (The \fBtgoto\fR function, if configured to support termcap, will check
 you do with it is call \fBtgoto\fR or \fBtparm\fR, which both expand
 terminfo-style strings as terminfo.
 (The \fBtgoto\fR function, if configured to support termcap, will check


@@ -207,7 +214,8 @@ appear to be terminfo).
 .PP
 Because terminfo conventions for representing padding in string capabilities
 differ from termcap's, \fBtputs("50");\fR will put out a literal "50" rather
 .PP
 Because terminfo conventions for representing padding in string capabilities
 differ from termcap's, \fBtputs("50");\fR will put out a literal "50" rather

-than busy-waiting for 50 milliseconds.  Cope with it.
+than busy-waiting for 50 milliseconds.
+Cope with it.

 .PP
 Note that termcap has nothing analogous to terminfo's \fBsgr\fR string.
 One consequence of this is that termcap applications assume \fRme\fR
 .PP
 Note that termcap has nothing analogous to terminfo's \fBsgr\fR string.
 One consequence of this is that termcap applications assume \fRme\fR


@@ -215,8 +223,15 @@ One consequence of this is that termcap applications assume \fRme\fR
 This implementation checks for, and modifies the data shown to the
 termcap interface to accommodate termcap's limitation in this respect.
 .SH PORTABILITY
 This implementation checks for, and modifies the data shown to the
 termcap interface to accommodate termcap's limitation in this respect.
 .SH PORTABILITY

-The XSI Curses standard, Issue 4 describes these functions.  However, they
+These functions are provided for supporting legacy applications,
+and should not be used in new programs:
+.bP
+The XSI Curses standard, Issue 4 describes these functions.
+However, they

 are marked TO BE WITHDRAWN and may be removed in future versions.
 are marked TO BE WITHDRAWN and may be removed in future versions.

+.bP
+X/Open Curses, Issue 5 (December 2007) marked the termcap interface
+(along with \fBvwprintw\fP and \fBvwscanw\fP) as withdrawn.

 .PP
 Neither the XSI Curses standard nor the SVr4 man pages documented the return
 values of \fBtgetent\fR correctly, though all three were in fact returned ever
 .PP
 Neither the XSI Curses standard nor the SVr4 man pages documented the return
 values of \fBtgetent\fR correctly, though all three were in fact returned ever