ncurses 5.7 - patch 20100109

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

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

-.\" Copyright (c) 1999-2006,2007 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.26 2007/02/24 16:37:50 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


@@ -99,16 +102,22 @@ recommended.
 Initially, \fBsetupterm\fR should be called.  Note that
 \fBsetupterm\fR is automatically called by \fBinitscr\fR and
 \fBnewterm\fR.  This defines the set of terminal-dependent variables
 Initially, \fBsetupterm\fR should be called.  Note that
 \fBsetupterm\fR is automatically called by \fBinitscr\fR and
 \fBnewterm\fR.  This defines the set of terminal-dependent variables

-[listed in \fBterminfo\fR(\*n)].  The \fBterminfo\fR variables
+[listed in \fBterminfo\fR(\*n)].
+The \fBterminfo\fR variables

 \fBlines\fR and \fBcolumns\fR are initialized by \fBsetupterm\fR as
 \fBlines\fR and \fBcolumns\fR are initialized by \fBsetupterm\fR as

-follows: If \fBuse_env(FALSE)\fR has been called, values for
+follows:
+.RS
+.PP
+If \fBuse_env(FALSE)\fR has been called, values for

 \fBlines\fR and \fBcolumns\fR specified in \fBterminfo\fR are used.
 \fBlines\fR and \fBcolumns\fR specified in \fBterminfo\fR are used.

+.PP

 Otherwise, if the environment variables \fBLINES\fR and \fBCOLUMNS\fR
 exist, their values are used.  If these environment variables do not
 exist and the program is running in a window, the current window size
 is used.  Otherwise, if the environment variables do not exist, the
 values for \fBlines\fR and \fBcolumns\fR specified in the
 \fBterminfo\fR database are used.
 Otherwise, if the environment variables \fBLINES\fR and \fBCOLUMNS\fR
 exist, their values are used.  If these environment variables do not
 exist and the program is running in a window, the current window size
 is used.  Otherwise, if the environment variables do not exist, the
 values for \fBlines\fR and \fBcolumns\fR specified in the
 \fBterminfo\fR database are used.

+.RE

 .PP
 The header files \fBcurses.h\fR and \fBterm.h\fR should be included (in this
 order) to get the definitions for these strings, numbers, and flags.
 .PP
 The header files \fBcurses.h\fR and \fBterm.h\fR should be included (in this
 order) to get the definitions for these strings, numbers, and flags.


@@ -183,12 +192,17 @@ except that it is called after restoring memory to a previous state (for
 example, when reloading a game saved as a core image dump).  It assumes that
 the windows and the input and output options are the same as when memory was
 saved, but the terminal type and baud rate may be different.  Accordingly,
 example, when reloading a game saved as a core image dump).  It assumes that
 the windows and the input and output options are the same as when memory was
 saved, but the terminal type and baud rate may be different.  Accordingly,

-it saves various tty state bits, does a setupterm, and then restores the bits.
+it saves various tty state bits, calls \fBsetupterm\fP,
+and then restores the bits.

 .PP
 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
 .PP
 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

+\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


@@ -267,6 +281,9 @@ In this implementation
 returns an error
 if its terminal parameter is null.
 .TP 5
 returns an error
 if its terminal parameter is null.
 .TP 5

+\fBputp\fP
+calls \fBtputs\fP, returning the same error-codes.
+.TP 5

 \fBrestartterm\fP
 returns an error
 if the associated call to \fBsetupterm\fP returns an error.
 \fBrestartterm\fP
 returns an error
 if the associated call to \fBsetupterm\fP returns an error.


@@ -276,6 +293,12 @@ returns an error
 if it cannot allocate enough memory, or
 create the initial windows (stdscr, curscr, newscr).
 Other error conditions are documented above.
 if it cannot allocate enough memory, or
 create the initial windows (stdscr, curscr, newscr).
 Other error conditions are documented above.

+.TP 5
+\fBtputs\fP
+returns an error if the string parameter is null.
+It does not detect I/O errors:
+X/Open states that \fBtputs\fP ignores the return value
+of the output function \fIputc\fP.

 .RE
 .SH NOTES
 The \fBsetupterm\fR routine should be used in place of \fBsetterm\fR.
 .RE
 .SH NOTES
 The \fBsetupterm\fR routine should be used in place of \fBsetterm\fR.


@@ -284,24 +307,34 @@ committing to the allocation of storage involved in \fBinitscr\fR.
 .PP
 Note that \fBvidattr\fR and \fBvidputs\fR may be macros.
 .SH PORTABILITY
 .PP
 Note that \fBvidattr\fR and \fBvidputs\fR may be macros.
 .SH PORTABILITY

-The function \fBsetterm\fR is not described in the XSI Curses standard and must
-be considered non-portable.  All other functions are as described in the XSI
-curses standard.
+The function \fBsetterm\fR is not described by X/Open and must
+be considered non-portable.  All other functions are as described by X/Open.
+.PP
+\fBsetupterm\fP copies the terminal name to the array \fBttytype\fP.
+This is not part of X/Open Curses, but is assumed by some applications.

 .PP
 In System V Release 4, \fBset_curterm\fR has an \fBint\fR return type and
 .PP
 In System V Release 4, \fBset_curterm\fR has an \fBint\fR return type and

-returns \fBOK\fR or \fBERR\fR.  We have chosen to implement the XSI Curses
+returns \fBOK\fR or \fBERR\fR.  We have chosen to implement the X/Open Curses

 semantics.
 .PP
 In System V Release 4, the third argument of \fBtputs\fR has the type
 \fBint (*putc)(char)\fR.
 .PP
 semantics.
 .PP
 In System V Release 4, the third argument of \fBtputs\fR has the type
 \fBint (*putc)(char)\fR.
 .PP

-The XSI Curses standard prototypes \fBtparm\fR with a fixed number of parameters,
+At least one implementation of X/Open Curses (Solaris) returns a value
+other than OK/ERR from \fBtputs\fP.
+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.
 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

-XSI notes that after calling \fBmvcur\fR, the curses state may not match the
+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.
 Both ncurses and System V Release 4 curses implement \fBmvcur\fR using
 actual terminal state, and that an application should touch and refresh
 the window before resuming normal curses calls.
 Both ncurses and System V Release 4 curses implement \fBmvcur\fR using


@@ -309,15 +342,19 @@ the SCREEN data allocated in either \fBinitscr\fR or \fBnewterm\fR.
 So though it is documented as a terminfo function,
 \fBmvcur\fR is really a curses function which is not well specified.
 .PP
 So though it is documented as a terminfo function,
 \fBmvcur\fR is really a curses function which is not well specified.
 .PP

-XSI states that the old location must be given.
+X/Open states that the old location must be given for \fBmvcur\fP.

 This implementation allows the caller to use -1's for the old ordinates.
 In that case, the old location is unknown.
 .PP
 Extended terminal capability names, e.g., as defined by \fBtic\ -x\fP,
 are not stored in the arrays described in this section.
 .SH SEE ALSO
 This implementation allows the caller to use -1's for the old ordinates.
 In that case, the old location is unknown.
 .PP
 Extended terminal capability names, e.g., as defined by \fBtic\ -x\fP,
 are not stored in the arrays described in this section.
 .SH SEE ALSO

-\fBcurses\fR(3X), \fBcurs_initscr\fR(3X), \fBcurs_kernel\fR(3X), \fBcurs_termcap\fR(3X),
-\fBputc\fR(3), \fBterminfo\fR(\*n)
+\fBcurses\fR(3X),
+\fBcurs_initscr\fR(3X),
+\fBcurs_kernel\fR(3X),
+\fBcurs_termcap\fR(3X),
+\fBputc\fR(3),
+\fBterminfo\fR(\*n)

 .\"#
 .\"# The following sets edit modes for GNU EMACS
 .\"# Local Variables:
 .\"#
 .\"# The following sets edit modes for GNU EMACS
 .\"# Local Variables: