ncurses 5.5
[ncurses.git] / man / curs_terminfo.3x
index bb5c8ca6cfa3fe746e6e0c2c7d1266017cbfcff1..14214d086f09bb06460cc28c07fdccb09288155f 100644 (file)
@@ -1,5 +1,5 @@
 .\"***************************************************************************
-.\" Copyright (c) 1999,2000 Free Software Foundation, Inc.                   *
+.\" Copyright (c) 1999-2003,2005 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            *
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: curs_terminfo.3x,v 1.13 2000/07/01 20:07:34 tom Exp $
+.\" $Id: curs_terminfo.3x,v 1.20 2005/05/15 16:19:13 tom Exp $
 .TH curs_terminfo 3X ""
 .ds n 5
+.na
+.hy 0
 .SH NAME
-\fBsetupterm\fR,
-\fBsetterm\fR,
-\fBset_curterm\fR,
 \fBdel_curterm\fR,
+\fBmvcur\fR,
+\fBputp\fR,
 \fBrestartterm\fR,
+\fBset_curterm\fR,
+\fBsetterm\fR,
+\fBsetupterm\fR,
+\fBtigetflag\fR,
+\fBtigetnum\fR,
+\fBtigetstr\fR,
 \fBtparm\fR,
 \fBtputs\fR,
-\fBputp\fR,
-\fBvidputs\fR,
+\fBvid_attr\fR,
+\fBvid_puts\fR,
 \fBvidattr\fR,
-\fBmvcur\fR,
-\fBtigetflag\fR,
-\fBtigetnum\fR,
-\fBtigetstr\fR - \fBcurses\fR interfaces to terminfo database
+\fBvidputs\fR - \fBcurses\fR interfaces to terminfo database
+.ad
+.hy
 .SH SYNOPSIS
+.nf
 \fB#include <curses.h>\fR
 .br
 \fB#include <term.h>\fR
-
-\fBint setupterm(const char *term, int fildes, int *errret);\fR
+.PP
+\fBint setupterm(char *\fR\fIterm\fR\fB, int \fR\fIfildes\fR\fB, int *\fR\fIerrret\fR\fB);\fR
+.br
+\fBint setterm(char *\fR\fIterm\fR\fB);\fR
 .br
-\fBint setterm(const char *term);\fR
+\fBTERMINAL *set_curterm(TERMINAL *\fR\fInterm\fR\fB);\fR
 .br
-\fBTERMINAL *set_curterm(TERMINAL *nterm);\fR
+\fBint del_curterm(TERMINAL *\fR\fIoterm\fR\fB);\fR
 .br
-\fBint del_curterm(TERMINAL *oterm);\fR
+\fBint restartterm(const char *\fR\fIterm\fR\fB, int \fR\fIfildes\fR\fB, int *\fR\fIerrret\fR\fB);\fR
 .br
-\fBint restartterm(const char *term, int fildes, int *errret);\fR
+\fBchar *tparm(char *\fR\fIstr\fR\fB, ...);\fR
 .br
-\fBchar *tparm(const char *str, ...);\fR
+\fBint tputs(const char *\fR\fIstr\fR\fB, int \fR\fIaffcnt\fR\fB, int (*\fR\fIputc\fR\fB)(int));\fR
 .br
-\fBint tputs(const char *str, int affcnt, int (*putc)(int));\fR
+\fBint putp(const char *\fR\fIstr\fR\fB);\fR
 .br
-\fBint putp(const char *str);\fR
+\fBint vidputs(chtype \fR\fIattrs\fR\fB, int (*\fR\fIputc\fR\fB)(int));\fR
 .br
-\fBint vidputs(chtype attrs, int (*putc)(char));\fR
+\fBint vidattr(chtype \fR\fIattrs\fR\fB);\fR
 .br
-\fBint vidattr(chtype attrs);\fR
+\fBint vid_puts(attr_t \fR\fIattrs\fR\fB, short \fR\fIpair\fR\fB, void *\fR\fIopts\fR\fB, int (*\fR\fIputc\fR\fB)(char));\fR
 .br
-\fBint mvcur(int oldrow, int oldcol, int newrow, int newcol);\fR
+\fBint vid_attr(attr_t \fR\fIattrs\fR\fB, short \fR\fIpair\fR\fB, void *\fR\fIopts\fR\fB);\fR
 .br
-\fBint tigetflag(const char *capname);\fR
+\fBint mvcur(int \fR\fIoldrow\fR\fB, int \fR\fIoldcol\fR\fB, int \fR\fInewrow\fR, int \fR\fInewcol\fR\fB);\fR
 .br
-\fBint tigetnum(const char *capname);\fR
+\fBint tigetflag(char *\fR\fIcapname\fR\fB);\fR
 .br
-\fBchar *tigetstr(const char *capname);\fR
+\fBint tigetnum(char *\fR\fIcapname\fR\fB);\fR
 .br
+\fBchar *tigetstr(char *\fR\fIcapname\fR\fB);\fR
+.br
+.fi
 .SH DESCRIPTION
 These low-level routines must be called by programs that have to deal
 directly with the \fBterminfo\fR database to handle certain terminal
 capabilities, such as programming function keys.  For all other
 functionality, \fBcurses\fR routines are more suitable and their use is
 recommended.
-
+.PP
 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
@@ -97,21 +109,21 @@ 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.
-
+.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.
-Parameterized strings should be passed through \fBtparm\fR to instantiate them.  
+Parameterized strings should be passed through \fBtparm\fR to instantiate them. 
 All \fBterminfo\fR strings [including the output of \fBtparm\fR] should be printed
 with \fBtputs\fR or \fBputp\fR.  Call the \fBreset_shell_mode\fR to restore the
 tty modes before exiting [see \fBcurs_kernel\fR(3X)].  Programs which use
 cursor addressing should output \fBenter_ca_mode\fR upon startup and should
 output \fBexit_ca_mode\fR before exiting.  Programs desiring shell escapes
 should call
-
+.PP
 \fBreset_shell_mode\fR and output \fBexit_ca_mode\fR before the shell
 is called and should output \fBenter_ca_mode\fR and call
 \fBreset_prog_mode\fR after returning from the shell.
-
+.PP
 The \fBsetupterm\fR routine reads in the \fBterminfo\fR database,
 initializing the \fBterminfo\fR structures, but does not set up the
 output virtualization structures used by \fBcurses\fR.  The terminal
@@ -146,7 +158,7 @@ and exits.  Thus, the simplest call is:
       \fBsetupterm((char *)0, 1, (int *)0);\fR,
 
 which uses all the defaults and sends the output to \fBstdout\fR.
-
+.PP
 The \fBsetterm\fR routine is being replaced by \fBsetupterm\fR.  The call:
 
       \fBsetupterm(\fR\fIterm\fR\fB, 1, (int *)0)\fR
@@ -154,67 +166,78 @@ The \fBsetterm\fR routine is being replaced by \fBsetupterm\fR.  The call:
 provides the same functionality as \fBsetterm(\fR\fIterm\fR\fB)\fR.
 The \fBsetterm\fR routine is included here for BSD compatibility, and
 is not recommended for new programs.
-
+.PP
 The \fBset_curterm\fR routine sets the variable \fBcur_term\fR to
 \fInterm\fR, and makes all of the \fBterminfo\fR boolean, numeric, and
 string variables use the values from \fInterm\fR.  It returns the old value
 of \fBcur_term\fR.
-
+.PP
 The \fBdel_curterm\fR routine frees the space pointed to by
 \fIoterm\fR and makes it available for further use.  If \fIoterm\fR is
 the same as \fBcur_term\fR, references to any of the \fBterminfo\fR
 boolean, numeric, and string variables thereafter may refer to invalid
 memory locations until another \fBsetupterm\fR has been called.
-
+.PP
 The \fBrestartterm\fR routine is similar to \fBsetupterm\fR and \fBinitscr\fR,
 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,
 it saves various tty state bits, does a setupterm, 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
 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
 \fBtgoto\fR.  \fIaffcnt\fR is the number of lines affected, or 1 if
 not applicable.  \fIputc\fR is a \fBputchar\fR-like routine to which
 the characters are passed, one at a time.
-
+.PP
 The \fBputp\fR routine calls \fBtputs(\fR\fIstr\fR\fB, 1, putchar)\fR.
 Note that the output of \fBputp\fR always goes to \fBstdout\fR, not to
 the \fIfildes\fR specified in \fBsetupterm\fR.
-
+.PP
 The \fBvidputs\fR routine displays the string on the terminal in the
 video attribute mode \fIattrs\fR, which is any combination of the
 attributes listed in \fBcurses\fR(3X).  The characters are passed to
 the \fBputchar\fR-like routine \fIputc\fR.
-
+.PP
 The \fBvidattr\fR routine is like the \fBvidputs\fR routine, except
 that it outputs through \fBputchar\fR.
-
+.PP
+The \fBvid_attr\fR and \fBvid_puts\fR routines correspond to vidattr and vidputs,
+respectively.
+They use a set of arguments for representing the video attributes plus color,
+i.e.,
+one of type attr_t for the attributes and one of short for
+the color_pair number.
+The \fBvid_attr\fR and \fBvid_puts\fR routines
+are designed to use the attribute constants with the \fIWA_\fR prefix.
+The opts argument is reserved for future use.
+Currently, applications must provide a null pointer for that argument.
+.PP
 The \fBmvcur\fR routine provides low-level cursor motion.  It takes
 effect immediately (rather than at the next refresh).
-
+.PP
 The \fBtigetflag\fR, \fBtigetnum\fR and \fBtigetstr\fR routines return
 the value of the capability corresponding to the \fBterminfo\fR
 \fIcapname\fR passed to them, such as \fBxenl\fR.
-
+.PP
 The \fBtigetflag\fR routine returns the value \fB-1\fR if
 \fIcapname\fR is not a boolean capability,
 or \fB0\fR if it is canceled or absent from the terminal description.
-
+.PP
 The \fBtigetnum\fR routine returns the value \fB-2\fR if
 \fIcapname\fR is not a numeric capability,
 or \fB-1\fR if it is canceled or absent from the terminal description.
-
+.PP
 The \fBtigetstr\fR routine returns the value \fB(char *)-1\fR
 if \fIcapname\fR is not a string capability,
 or \fB0\fR if it is canceled or absent from the terminal description.
-
+.PP
 The \fIcapname\fR for each capability is given in the table column entitled
 \fIcapname\fR code in the capabilities section of \fBterminfo\fR(\*n).
 
@@ -231,34 +254,56 @@ These null-terminated arrays contain the \fIcapnames\fR, the
 Routines that return an integer return \fBERR\fR upon failure and \fBOK\fR
 (SVr4 only specifies "an integer value other than \fBERR\fR") upon successful
 completion, unless otherwise noted in the preceding routine descriptions.
-
+.PP
 Routines that return pointers always return \fBNULL\fR on error.
+.PP
+X/Open defines no error conditions.
+In this implementation
+.RS
+.TP 5
+\fBdel_curterm\fP
+returns an error
+if its terminal parameter is null.
+.TP 5
+\fBrestartterm\fP
+returns an error
+if the associated call to \fBsetupterm\fP returns an error.
+.TP 5
+\fBsetupterm\fP
+returns an error
+if it cannot allocate enough memory, or
+create the initial windows (stdscr, curscr, newscr).
+Other error conditions are documented above.
+.RE
 .SH NOTES
 The \fBsetupterm\fR routine should be used in place of \fBsetterm\fR.
 It may be useful when you want to test for terminal capabilities without
 committing to the allocation of storage involved in \fBinitscr\fR.
-
+.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.
-
+.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
 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,
 rather than a variable argument list.
-
+This implementation uses a variable argument list.
+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
 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
-the SCREEN data allocated in either \fBinitscr\fR or \fBnewterm\fR. 
+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.
 .SH SEE ALSO