ncurses 5.7 - patch 20100109

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

diff --git a/man/curs_terminfo.3x b/man/curs_terminfo.3x
index 4412a6a69c354b29f8faf30c8d6d612b340a0ab1..d9ddb03af862945f0e21afc79fb46c5aa2b9e84c 100644 (file)
--- a/man/curs_terminfo.3x
+++ b/man/curs_terminfo.3x
@@ -1,5 +1,5 @@
 .\"***************************************************************************
 .\"***************************************************************************

-.\" Copyright (c) 1999-2007,2008 Free Software Foundation, Inc.              *
+.\" Copyright (c) 1999-2008,2010 Free Software Foundation, Inc.              *

 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
 .\" copy of this software and associated documentation files (the            *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
 .\" copy of this software and associated documentation files (the            *


@@ -26,7 +26,7 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"

-.\" $Id: curs_terminfo.3x,v 1.30 2008/08/16 20:53:27 tom Exp $
+.\" $Id: curs_terminfo.3x,v 1.31 2010/01/09 19:43:39 tom Exp $

 .TH curs_terminfo 3X ""
 .ds n 5
 .na
 .TH curs_terminfo 3X ""
 .ds n 5
 .na


@@ -42,6 +42,7 @@
 \fBtigetflag\fR,
 \fBtigetnum\fR,
 \fBtigetstr\fR,
 \fBtigetflag\fR,
 \fBtigetnum\fR,
 \fBtigetstr\fR,

+\fBtiparm\fR,

 \fBtparm\fR,
 \fBtputs\fR,
 \fBvid_attr\fR,
 \fBtparm\fR,
 \fBtputs\fR,
 \fBvid_attr\fR,


@@ -88,6 +89,8 @@
 .br
 \fBchar *tigetstr(char *\fR\fIcapname\fR\fB);\fR
 .br
 .br
 \fBchar *tigetstr(char *\fR\fIcapname\fR\fB);\fR
 .br

+\fBchar *tiparm(const char *\fR\fIstr\fR\fB, ...);\fR
+.br

 .fi
 .SH DESCRIPTION
 These low-level routines must be called by programs that have to deal
 .fi
 .SH DESCRIPTION
 These low-level routines must be called by programs that have to deal


@@ -196,6 +199,10 @@ The \fBtparm\fR routine instantiates the string \fIstr\fR with
 parameters \fIpi\fR.  A pointer is returned to the result of \fIstr\fR
 with the parameters applied.
 .PP
 parameters \fIpi\fR.  A pointer is returned to the result of \fIstr\fR
 with the parameters applied.
 .PP

+\fBtiparm\fP is a newer form of \fBtparm\fP which uses \fI<stdarg.h>\fP
+rather than a fixed-parameter list.
+Its numeric parameters are integers (int) rather than longs.
+.PP

 The \fBtputs\fR routine applies padding information to the string
 \fIstr\fR and outputs it.  The \fIstr\fR must be a terminfo string
 variable or the return value from \fBtparm\fR, \fBtgetstr\fR, or
 The \fBtputs\fR routine applies padding information to the string
 \fIstr\fR and outputs it.  The \fIstr\fR must be a terminfo string
 variable or the return value from \fBtparm\fR, \fBtgetstr\fR, or


@@ -319,10 +326,14 @@ That returns the length of the string, and does no error-checking.
 .PP
 X/Open Curses prototypes \fBtparm\fR with a fixed number of parameters,
 rather than a variable argument list.
 .PP
 X/Open Curses prototypes \fBtparm\fR with a fixed number of parameters,
 rather than a variable argument list.

-This implementation uses a variable argument list.
+This implementation uses a variable argument list, but can be
+configured to use the fixed-parameter list.

 Portable applications should provide 9 parameters after the format;
 zeroes are fine for this purpose.
 .PP
 Portable applications should provide 9 parameters after the format;
 zeroes are fine for this purpose.
 .PP

+In response to comments by Thomas E. Dickey,
+X/Open Curses Issue 7 proposed the \fBtiparam\fP function in mid-2009.
+.PP

 X/Open notes that after calling \fBmvcur\fR, the curses state may not match the
 actual terminal state, and that an application should touch and refresh
 the window before resuming normal curses calls.
 X/Open notes that after calling \fBmvcur\fR, the curses state may not match the
 actual terminal state, and that an application should touch and refresh
 the window before resuming normal curses calls.