]> ncurses.scripts.mit.edu Git - ncurses.git/blobdiff - doc/html/man/curs_terminfo.3x.html
ncurses 5.6
[ncurses.git] / doc / html / man / curs_terminfo.3x.html
index 8a53cbca02647006654e829d041d1a128a7e1542..f0424ea61bcef09afc2274013c0d41ed9d94b8b9 100644 (file)
+<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
+<!-- 
+  ****************************************************************************
+  * Copyright (c) 1999-2005,2006 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            *
+  * "Software"), to deal in the Software without restriction, including      *
+  * without limitation the rights to use, copy, modify, merge, publish,      *
+  * distribute, distribute with modifications, sublicense, and/or sell       *
+  * copies of the Software, and to permit persons to whom the Software is    *
+  * furnished to do so, subject to the following conditions:                 *
+  *                                                                          *
+  * The above copyright notice and this permission notice shall be included  *
+  * in all copies or substantial portions of the Software.                   *
+  *                                                                          *
+  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
+  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
+  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
+  * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
+  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
+  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
+  * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
+  *                                                                          *
+  * Except as contained in this notice, the name(s) of the above copyright   *
+  * holders shall not be used in advertising or otherwise to promote the     *
+  * sale, use or other dealings in this Software without prior written       *
+  * authorization.                                                           *
+  ****************************************************************************
+  * @Id: curs_terminfo.3x,v 1.24 2006/11/04 21:50:03 tom Exp @
+-->
 <HTML>
 <HTML>
+<HEAD>
+<TITLE>curs_terminfo 3x</TITLE>
+<link rev=made href="mailto:bug-ncurses@gnu.org">
+<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+</HEAD>
 <BODY>
 <BODY>
+<H1>curs_terminfo 3x</H1>
+<HR>
 <PRE>
 <!-- Manpage converted by man2html 3.0.1 -->
 <PRE>
 <!-- Manpage converted by man2html 3.0.1 -->
+<STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG>                                     <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG>
+
+
+
 
 </PRE>
 <H2>NAME</H2><PRE>
 
 </PRE>
 <H2>NAME</H2><PRE>
-       <B>setupterm</B>, <B>setterm</B>, <B>set_curterm</B>, <B>del_curterm</B>, <B>restartterm</B>,
-       <B>tparm</B>, <B>tputs</B>, <B>putp</B>, <B>vidputs</B>,  <B>vidattr</B>,  <B>mvcur</B>,  <B>tigetflag</B>,
-       <B>tigetnum</B>,   <B>tigetstr</B>   -  <B>curses</B>  interfaces  to  terminfo
-       database
+       <STRONG>del_curterm</STRONG>, <STRONG>mvcur</STRONG>, <STRONG>putp</STRONG>, <STRONG>restartterm</STRONG>, <STRONG>set_curterm</STRONG>,
+       <STRONG>setterm</STRONG>, <STRONG>setupterm</STRONG>, <STRONG>tigetflag</STRONG>, <STRONG>tigetnum</STRONG>, <STRONG>tigetstr</STRONG>, <STRONG>tparm</STRONG>,
+       <STRONG>tputs</STRONG>, <STRONG>vid_attr</STRONG>, <STRONG>vid_puts</STRONG>, <STRONG>vidattr</STRONG>, <STRONG>vidputs</STRONG> - <STRONG>curses</STRONG>
+       interfaces to terminfo database
 
 
 </PRE>
 <H2>SYNOPSIS</H2><PRE>
 
 
 </PRE>
 <H2>SYNOPSIS</H2><PRE>
-       <B>#include</B> <B>&lt;curses.h&gt;</B>
-       <B>#include</B> <B>&lt;term.h&gt;</B>
-
-       <B>int</B> <B>setupterm(const</B> <B>char</B> <B>*term,</B> <B>int</B> <B>fildes,</B> <B>int</B> <B>*errret);</B>
-       <B>int</B> <B>setterm(const</B> <B>char</B> <B>*term);</B>
-       <B>TERMINAL</B> <B>*set_curterm(TERMINAL</B> <B>*nterm);</B>
-       <B>int</B> <B>del_curterm(TERMINAL</B> <B>*oterm);</B>
-       <B>int</B>  <B>restartterm(const</B>  <B>char</B>  <B>*term,</B>   <B>int</B>   <B>fildes,</B>   <B>int</B>
-       <B>*errret);</B>
-       <B>char</B> <B>*tparm(const</B> <B>char</B> <B>*str,</B> <B>...);</B>
-       <B>int</B> <B>tputs(const</B> <B>char</B> <B>*str,</B> <B>int</B> <B>affcnt,</B> <B>int</B> <B>(*putc)(int));</B>
-       <B>int</B> <B>putp(const</B> <B>char</B> <B>*str);</B>
-       <B>int</B> <B>vidputs(chtype</B> <B>attrs,</B> <B>int</B> <B>(*putc)(char));</B>
-       <B>int</B> <B>vidattr(chtype</B> <B>attrs);</B>
-       <B>int</B> <B>mvcur(int</B> <B>oldrow,</B> <B>int</B> <B>oldcol,</B> <B>int</B> <B>newrow,</B> <B>int</B> <B>newcol);</B>
-       <B>int</B> <B>tigetflag(const</B> <B>char</B> <B>*capname);</B>
-       <B>int</B> <B>tigetnum(const</B> <B>char</B> <B>*capname);</B>
-       <B>char</B> <B>*tigetstr(const</B> <B>char</B> <B>*capname);</B>
+       <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
+       <STRONG>#include</STRONG> <STRONG>&lt;term.h&gt;</STRONG>
+
+       <STRONG>int</STRONG> <STRONG>setupterm(char</STRONG> <STRONG>*</STRONG><EM>term</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>fildes</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <STRONG>*</STRONG><EM>errret</EM><STRONG>);</STRONG>
+       <STRONG>int</STRONG> <STRONG>setterm(char</STRONG> <STRONG>*</STRONG><EM>term</EM><STRONG>);</STRONG>
+       <STRONG>TERMINAL</STRONG> <STRONG>*set_curterm(TERMINAL</STRONG> <STRONG>*</STRONG><EM>nterm</EM><STRONG>);</STRONG>
+       <STRONG>int</STRONG> <STRONG>del_curterm(TERMINAL</STRONG> <STRONG>*</STRONG><EM>oterm</EM><STRONG>);</STRONG>
+       <STRONG>int</STRONG> <STRONG>restartterm(const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>term</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>fildes</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <STRONG>*</STRONG><EM>errret</EM><STRONG>);</STRONG>
+       <STRONG>char</STRONG> <STRONG>*tparm(char</STRONG> <STRONG>*</STRONG><EM>str</EM><STRONG>,</STRONG> <STRONG>...);</STRONG>
+       <STRONG>int</STRONG> <STRONG>tputs(const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>str</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>affcnt</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <STRONG>(*</STRONG><EM>putc</EM><STRONG>)(int));</STRONG>
+       <STRONG>int</STRONG> <STRONG>putp(const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>str</EM><STRONG>);</STRONG>
+       <STRONG>int</STRONG> <STRONG>vidputs(chtype</STRONG> <EM>attrs</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <STRONG>(*</STRONG><EM>putc</EM><STRONG>)(int));</STRONG>
+       <STRONG>int</STRONG> <STRONG>vidattr(chtype</STRONG> <EM>attrs</EM><STRONG>);</STRONG>
+       <STRONG>int</STRONG> <STRONG>vid_puts(attr_t</STRONG> <EM>attrs</EM><STRONG>,</STRONG> <STRONG>short</STRONG> <EM>pair</EM><STRONG>,</STRONG> <STRONG>void</STRONG> <STRONG>*</STRONG><EM>opts</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <STRONG>(*</STRONG><EM>putc</EM><STRONG>)(char));</STRONG>
+       <STRONG>int</STRONG> <STRONG>vid_attr(attr_t</STRONG> <EM>attrs</EM><STRONG>,</STRONG> <STRONG>short</STRONG> <EM>pair</EM><STRONG>,</STRONG> <STRONG>void</STRONG> <STRONG>*</STRONG><EM>opts</EM><STRONG>);</STRONG>
+       <STRONG>int</STRONG> <STRONG>mvcur(int</STRONG> <EM>oldrow</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>oldcol</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>newrow</EM>, int <EM>newcol</EM><STRONG>);</STRONG>
+       <STRONG>int</STRONG> <STRONG>tigetflag(char</STRONG> <STRONG>*</STRONG><EM>capname</EM><STRONG>);</STRONG>
+       <STRONG>int</STRONG> <STRONG>tigetnum(char</STRONG> <STRONG>*</STRONG><EM>capname</EM><STRONG>);</STRONG>
+       <STRONG>char</STRONG> <STRONG>*tigetstr(char</STRONG> <STRONG>*</STRONG><EM>capname</EM><STRONG>);</STRONG>
 
 
 </PRE>
 <H2>DESCRIPTION</H2><PRE>
        These low-level routines must be called by  programs  that
 
 
 </PRE>
 <H2>DESCRIPTION</H2><PRE>
        These low-level routines must be called by  programs  that
-       have to deal directly with the <B>terminfo</B> database to handle
+       have to deal directly with the <STRONG>terminfo</STRONG> database to handle
        certain terminal capabilities, such as  programming  func-
        certain terminal capabilities, such as  programming  func-
-       tion  keys.   For all other functionality, <B>curses</B> routines
+       tion  keys.   For all other functionality, <STRONG>curses</STRONG> routines
        are more suitable and their use is recommended.
 
        are more suitable and their use is recommended.
 
-       Initially,  <B>setupterm</B>  should  be   called.    Note   that
-       <B>setupterm</B>  is automatically called by <B>initscr</B> and <B>newterm</B>.
+       Initially, <STRONG>setupterm</STRONG> should  be  called.   Note  that  <STRONG>se-</STRONG>
+       <STRONG>tupterm</STRONG>  is  automatically  called by <STRONG>initscr</STRONG> and <STRONG>newterm</STRONG>.
        This  defines  the  set  of  terminal-dependent  variables
        This  defines  the  set  of  terminal-dependent  variables
-       [listed in <B><A HREF="terminfo.5.html">terminfo(5)</A></B>].  The <B>terminfo</B> variables <B>lines</B> and
-       <B>columns</B>  are  initialized  by  <B>setupterm</B>  as  follows:  If
-       <B>use_env(FALSE)</B>  has  been  called,  values  for  <B>lines</B> and
-       <B>columns</B> specified in <B>terminfo</B> are used.  Otherwise, if the
-       environment  variables <B>LINES</B> and <B>COLUMNS</B> exist, their val-
+       [listed in <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>].  The <STRONG>terminfo</STRONG> variables <STRONG>lines</STRONG> and
+       <STRONG>columns</STRONG>  are  initialized  by  <STRONG>setupterm</STRONG>  as  follows:  If
+       <STRONG>use_env(FALSE)</STRONG>  has  been  called,  values  for  <STRONG>lines</STRONG> and
+       <STRONG>columns</STRONG> specified in <STRONG>terminfo</STRONG> are used.  Otherwise, if the
+       environment  variables <STRONG>LINES</STRONG> and <STRONG>COLUMNS</STRONG> exist, their val-
        ues 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
        ues 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 <B>lines</B> and <B>columns</B> specified in
-       the <B>terminfo</B> database are used.
+       not  exist,  the values for <STRONG>lines</STRONG> and <STRONG>columns</STRONG> specified in
+       the <STRONG>terminfo</STRONG> database are used.
 
 
-       The header files <B>curses.h</B> and <B>term.h</B>  should  be  included
+       The header files <STRONG>curses.h</STRONG> and <STRONG>term.h</STRONG>  should  be  included
        (in  this order) to get the definitions for these strings,
        numbers,  and  flags.   Parameterized  strings  should  be
        (in  this order) to get the definitions for these strings,
        numbers,  and  flags.   Parameterized  strings  should  be
-       passed  through  <B>tparm</B>  to instantiate them.  All <B>terminfo</B>
-       strings [including the output of <B>tparm</B>] should be  printed
-       with  <B>tputs</B> or <B>putp</B>.  Call the <B>reset_shell_mode</B> to restore
-       the  tty  modes  before  exiting  [see   <B><A HREF="curs_kernel.3x.html">curs_kernel(3x)</A></B>].
-       Programs   which   use  cursor  addressing  should  output
-       <B>enter_ca_mode</B> upon startup and should output  <B>exit_ca_mode</B>
+       passed  through  <STRONG>tparm</STRONG>  to instantiate them.  All <STRONG>terminfo</STRONG>
+       strings [including the output of <STRONG>tparm</STRONG>] should be  printed
+       with  <STRONG>tputs</STRONG> or <STRONG>putp</STRONG>.  Call the <STRONG>reset_shell_mode</STRONG> to restore
+       the tty modes before exiting [see <STRONG><A HREF="curs_kernel.3x.html">curs_kernel(3x)</A></STRONG>].   Pro-
+       grams  which  use  cursor  addressing  should  output  <STRONG>en-</STRONG>
+       <STRONG>ter_ca_mode</STRONG> upon startup and  should  output  <STRONG>exit_ca_mode</STRONG>
        before  exiting.   Programs  desiring shell escapes should
        call
 
        before  exiting.   Programs  desiring shell escapes should
        call
 
-       <B>reset_shell_mode</B> and output <B>exit_ca_mode</B> before the  shell
-       is   called  and  should  output  <B>enter_ca_mode</B>  and  call
-       <B>reset_prog_mode</B> after returning from the shell.
-
-       The <B>setupterm</B> routine reads in the <B>terminfo</B> database, ini-
-       tializing the <B>terminfo</B> structures, but does not set up the
-       output virtualization structures used by <B>curses</B>.  The ter-
-       minal  type is the character string <I>term</I>; if <I>term</I> is null,
-       the environment variable <B>TERM</B> is used.  All output  is  to
-       file  descriptor  <B>fildes</B>  which is initialized for output.
-       If <I>errret</I> is not null, then <B>setupterm</B> returns  <B>OK</B>  or  <B>ERR</B>
-       and  stores  a  status  value in the integer pointed to by
-       <I>errret</I>.  A return value of <B>OK</B> combined with status of <B>1</B> in
-       <I>errret</I> is normal.  If <B>ERR</B> is returned, examine <I>errret</I>:
-
-              <B>1</B>    means that the terminal is hardcopy, cannot be
+       <STRONG>reset_shell_mode</STRONG> and output <STRONG>exit_ca_mode</STRONG> before the  shell
+       is  called  and  should  output <STRONG>enter_ca_mode</STRONG> and call <STRONG>re-</STRONG>
+       <STRONG>set_prog_mode</STRONG> after returning from the shell.
+
+       The <STRONG>setupterm</STRONG> routine reads in the <STRONG>terminfo</STRONG> database, ini-
+       tializing the <STRONG>terminfo</STRONG> structures, but does not set up the
+       output virtualization structures used by <STRONG>curses</STRONG>.  The ter-
+       minal  type is the character string <EM>term</EM>; if <EM>term</EM> is null,
+       the environment variable <STRONG>TERM</STRONG> is used.  All output  is  to
+       file  descriptor  <STRONG>fildes</STRONG>  which is initialized for output.
+       If <EM>errret</EM> is not null, then <STRONG>setupterm</STRONG> returns  <STRONG>OK</STRONG>  or  <STRONG>ERR</STRONG>
+       and stores a status value in the integer pointed to by <EM>er-</EM>
+       <EM>rret</EM>.  A return value of <STRONG>OK</STRONG> combined with status of  <STRONG>1</STRONG>  in
+       <EM>errret</EM> is normal.  If <STRONG>ERR</STRONG> is returned, examine <EM>errret</EM>:
+
+              <STRONG>1</STRONG>    means that the terminal is hardcopy, cannot be
                    used for curses applications.
 
                    used for curses applications.
 
-              <B>0</B>    means that the terminal could not be found, or
+              <STRONG>0</STRONG>    means that the terminal could not be found, or
                    that  it  is a generic type, having too little
                    information for curses applications to run.
 
                    that  it  is a generic type, having too little
                    information for curses applications to run.
 
-              <B>-1</B>   means that the <B>terminfo</B> database could not  be
+              <STRONG>-1</STRONG>   means that the <STRONG>terminfo</STRONG> database could not  be
                    found.
 
                    found.
 
-       If  <I>errret</I> is null, <B>setupterm</B> prints an error message upon
+       If  <EM>errret</EM> is null, <STRONG>setupterm</STRONG> prints an error message upon
        finding an error and exits.  Thus, the simplest call is:
 
        finding an error and exits.  Thus, the simplest call is:
 
-             <B>setupterm((char</B> <B>*)0,</B> <B>1,</B> <B>(int</B> <B>*)0);</B>,
+             <STRONG>setupterm((char</STRONG> <STRONG>*)0,</STRONG> <STRONG>1,</STRONG> <STRONG>(int</STRONG> <STRONG>*)0);</STRONG>,
 
 
-       which uses all the defaults and sends the output  to  <B>std-</B>
-       <B>out</B>.
+       which uses all the defaults and sends the output  to  <STRONG>std-</STRONG>
+       <STRONG>out</STRONG>.
 
 
-       The  <B>setterm</B>  routine is being replaced by <B>setupterm</B>.  The
+       The  <STRONG>setterm</STRONG>  routine is being replaced by <STRONG>setupterm</STRONG>.  The
        call:
 
        call:
 
-             <B>setupterm(</B><I>term</I><B>,</B> <B>1,</B> <B>(int</B> <B>*)0)</B>
+             <STRONG>setupterm(</STRONG><EM>term</EM><STRONG>,</STRONG> <STRONG>1,</STRONG> <STRONG>(int</STRONG> <STRONG>*)0)</STRONG>
 
 
-       provides the same  functionality  as  <B>setterm(</B><I>term</I><B>)</B>.   The
-       <B>setterm</B>  routine  is  included here for BSD compatibility,
+       provides the same  functionality  as  <STRONG>setterm(</STRONG><EM>term</EM><STRONG>)</STRONG>.   The
+       <STRONG>setterm</STRONG>  routine  is  included here for BSD compatibility,
        and is not recommended for new programs.
 
        and is not recommended for new programs.
 
-       The <B>set_curterm</B> routine  sets  the  variable  <B>cur_term</B>  to
-       <I>nterm</I>, and makes all of the <B>terminfo</B> boolean, numeric, and
-       string variables use the values from  <I>nterm</I>.   It  returns
-       the old value of <B>cur_term</B>.
+       The <STRONG>set_curterm</STRONG> routine  sets  the  variable  <STRONG>cur_term</STRONG>  to
+       <EM>nterm</EM>, and makes all of the <STRONG>terminfo</STRONG> boolean, numeric, and
+       string variables use the values from  <EM>nterm</EM>.   It  returns
+       the old value of <STRONG>cur_term</STRONG>.
 
 
-       The  <B>del_curterm</B>  routine  frees  the  space pointed to by
-       <I>oterm</I> and makes it available for further use.  If <I>oterm</I> is
-       the  same  as  <B>cur_term</B>, references to any of the <B>terminfo</B>
-       boolean, numeric,  and  string  variables  thereafter  may
-       refer  to invalid memory locations until another <B>setupterm</B>
+       The  <STRONG>del_curterm</STRONG>  routine  frees  the  space pointed to by
+       <EM>oterm</EM> and makes it available for further use.  If <EM>oterm</EM> is
+       the  same  as  <STRONG>cur_term</STRONG>, references to any of the <STRONG>terminfo</STRONG>
+       boolean, numeric, and string variables thereafter may  re-
+       fer  to  invalid  memory locations until another <STRONG>setupterm</STRONG>
        has been called.
 
        has been called.
 
-       The  <B>restartterm</B>  routine  is  similar  to  <B>setupterm</B>  and
-       <B>initscr</B>,  except  that it is called after restoring memory
+       The  <STRONG>restartterm</STRONG>  routine  is  similar  to  <STRONG>setupterm</STRONG>  and
+       <STRONG>initscr</STRONG>,  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 mem-
        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 mem-
        different.  Accordingly, it saves various tty state  bits,
        does a setupterm, and then restores the bits.
 
        different.  Accordingly, it saves various tty state  bits,
        does a setupterm, and then restores the bits.
 
-       The <B>tparm</B> routine instantiates the string <I>str</I> with parame-
-       ters <I>pi</I>.  A pointer is returned to the result of <I>str</I>  with
+       The <STRONG>tparm</STRONG> routine instantiates the string <EM>str</EM> with parame-
+       ters <EM>pi</EM>.  A pointer is returned to the result of <EM>str</EM>  with
        the parameters applied.
 
        the parameters applied.
 
-       The  <B>tputs</B>  routine  applies  padding  information  to the
-       string <I>str</I> and outputs it.  The <I>str</I>  must  be  a  terminfo
-       string  variable  or the return value from <B>tparm</B>, <B>tgetstr</B>,
-       or <B>tgoto</B>.  <I>affcnt</I> is the number of lines affected, or 1 if
-       not  applicable.   <I>putc</I> is a <B>putchar</B>-like routine to which
+       The  <STRONG>tputs</STRONG>  routine  applies  padding  information  to the
+       string <EM>str</EM> and outputs it.  The <EM>str</EM>  must  be  a  terminfo
+       string  variable  or the return value from <STRONG>tparm</STRONG>, <STRONG>tgetstr</STRONG>,
+       or <STRONG>tgoto</STRONG>.  <EM>affcnt</EM> is the number of lines affected, or 1 if
+       not  applicable.   <EM>putc</EM> is a <STRONG>putchar</STRONG>-like routine to which
        the characters are passed, one at a time.
 
        the characters are passed, one at a time.
 
-       The <B>putp</B> routine calls <B>tputs(</B><I>str</I><B>,</B> <B>1,</B> <B>putchar)</B>.  Note  that
-       the  output  of  <B>putp</B>  always  goes  to <B>stdout</B>, not to the
-       <I>fildes</I> specified in <B>setupterm</B>.
-
-       The <B>vidputs</B> routine displays the string on the terminal in
-       the  video  attribute mode <I>attrs</I>, which is any combination
-       of the attributes listed in  <B><A HREF="ncurses.3x.html">curses(3x)</A></B>.   The  characters
-       are passed to the <B>putchar</B>-like routine <I>putc</I>.
-
-       The  <B>vidattr</B>  routine  is like the <B>vidputs</B> routine, except
-       that it outputs through <B>putchar</B>.
-
-       The <B>mvcur</B> routine provides low-level  cursor  motion.   It
-       takes   effect   immediately  (rather  than  at  the  next
-       refresh).
-
-       The <B>tigetflag</B>, <B>tigetnum</B> and <B>tigetstr</B> routines  return  the
-       value of the capability corresponding to the <B>terminfo</B> <I>cap-</I>
-       <I>name</I> passed to them, such as <B>xenl</B>.
-
-       The <B>tigetflag</B> routine returns the value <B>-1</B> if  <I>capname</I>  is
-       not a boolean capability, or <B>0</B> if it is canceled or absent
+       The <STRONG>putp</STRONG> routine calls <STRONG>tputs(</STRONG><EM>str</EM><STRONG>,</STRONG> <STRONG>1,</STRONG> <STRONG>putchar)</STRONG>.  Note  that
+       the  output  of  <STRONG>putp</STRONG>  always  goes  to <STRONG>stdout</STRONG>, not to the
+       <EM>fildes</EM> specified in <STRONG>setupterm</STRONG>.
+
+       The <STRONG>vidputs</STRONG> routine displays the string on the terminal in
+       the  video  attribute mode <EM>attrs</EM>, which is any combination
+       of the attributes listed in  <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>.   The  characters
+       are passed to the <STRONG>putchar</STRONG>-like routine <EM>putc</EM>.
+
+       The  <STRONG>vidattr</STRONG>  routine  is like the <STRONG>vidputs</STRONG> routine, except
+       that it outputs through <STRONG>putchar</STRONG>.
+
+       The <STRONG>vid_attr</STRONG> and <STRONG>vid_puts</STRONG> 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 <STRONG>vid_attr</STRONG> and <STRONG>vid_puts</STRONG> routines
+       are  designed  to use the attribute constants with the <EM>WA</EM><STRONG>_</STRONG>
+       prefix.  The opts argument is  reserved  for  future  use.
+       Currently,  applications  must  provide a null pointer for
+       that argument.
+
+       The <STRONG>mvcur</STRONG> routine provides low-level  cursor  motion.   It
+       takes  effect  immediately  (rather  than  at the next re-
+       fresh).
+
+       The <STRONG>tigetflag</STRONG>, <STRONG>tigetnum</STRONG> and <STRONG>tigetstr</STRONG> routines  return  the
+       value of the capability corresponding to the <STRONG>terminfo</STRONG> <EM>cap-</EM>
+       <EM>name</EM> passed to them, such as <STRONG>xenl</STRONG>.
+
+       The <STRONG>tigetflag</STRONG> routine returns the value <STRONG>-1</STRONG> if  <EM>capname</EM>  is
+       not a boolean capability, or <STRONG>0</STRONG> if it is canceled or absent
        from the terminal description.
 
        from the terminal description.
 
-       The <B>tigetnum</B> routine returns the value <B>-2</B>  if  <I>capname</I>  is
-       not  a  numeric  capability,  or  <B>-1</B>  if it is canceled or
-       absent from the terminal description.
+       The <STRONG>tigetnum</STRONG> routine returns the value <STRONG>-2</STRONG>  if  <EM>capname</EM>  is
+       not  a  numeric capability, or <STRONG>-1</STRONG> if it is canceled or ab-
+       sent from the terminal description.
 
 
-       The <B>tigetstr</B> routine  returns  the  value  <B>(char</B>  <B>*)-1</B>  if
-       <I>capname</I> is not a string capability, or <B>0</B> if it is canceled
-       or absent from the terminal description.
+       The <STRONG>tigetstr</STRONG> routine returns the value <STRONG>(char</STRONG> <STRONG>*)-1</STRONG> if  <EM>cap-</EM>
+       <EM>name</EM> is not a string capability, or <STRONG>0</STRONG> if it is canceled or
+       absent from the terminal description.
 
 
-       The <I>capname</I> for each capability is given in the table col-
-       umn  entitled  <I>capname</I> code in the capabilities section of
-       <B><A HREF="terminfo.5.html">terminfo(5)</A></B>.
+       The <EM>capname</EM> for each capability is given in the table col-
+       umn  entitled  <EM>capname</EM> code in the capabilities section of
+       <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>.
 
 
-       <B>char</B> <B>*boolnames</B>, <B>*boolcodes</B>, <B>*boolfnames</B>
+              <STRONG>char</STRONG> <STRONG>*boolnames[]</STRONG>, <STRONG>*boolcodes[]</STRONG>, <STRONG>*boolfnames[]</STRONG>
 
 
-       <B>char</B> <B>*numnames</B>, <B>*numcodes</B>, <B>*numfnames</B>
+              <STRONG>char</STRONG> <STRONG>*numnames[]</STRONG>, <STRONG>*numcodes[]</STRONG>, <STRONG>*numfnames[]</STRONG>
 
 
-       <B>char</B> <B>*strnames</B>, <B>*strcodes</B>, <B>*strfnames</B>
+              <STRONG>char</STRONG> <STRONG>*strnames[]</STRONG>, <STRONG>*strcodes[]</STRONG>, <STRONG>*strfnames[]</STRONG>
 
 
-       These null-terminated arrays  contain  the  <I>capnames</I>,  the
-       <B>termcap</B>  codes, and the full C names, for each of the <B>ter-</B>
-       <B>minfo</B> variables.
+       These null-terminated arrays  contain  the  <EM>capnames</EM>,  the
+       <STRONG>termcap</STRONG>  codes, and the full C names, for each of the <STRONG>ter-</STRONG>
+       <STRONG>minfo</STRONG> variables.
 
 
 </PRE>
 <H2>RETURN VALUE</H2><PRE>
 
 
 </PRE>
 <H2>RETURN VALUE</H2><PRE>
-       Routines that return an integer return  <B>ERR</B>  upon  failure
-       and  <B>OK</B>  (SVr4 only specifies "an integer value other than
-       <B>ERR</B>") upon successful completion, unless  otherwise  noted
+       Routines that return an integer return  <STRONG>ERR</STRONG>  upon  failure
+       and  <STRONG>OK</STRONG>  (SVr4 only specifies "an integer value other than
+       <STRONG>ERR</STRONG>") upon successful completion, unless  otherwise  noted
        in the preceding routine descriptions.
 
        in the preceding routine descriptions.
 
-       Routines that return pointers always return <B>NULL</B> on error.
+       Routines that return pointers always return <STRONG>NULL</STRONG> on error.
+
+       X/Open defines no error conditions.  In  this  implementa-
+       tion
+
+              <STRONG>del_curterm</STRONG>
+                   returns  an error if its terminal parameter is
+                   null.
+
+              <STRONG>restartterm</STRONG>
+                   returns an error if the associated call to <STRONG>se-</STRONG>
+                   <STRONG>tupterm</STRONG> returns an error.
+
+              <STRONG>setupterm</STRONG>
+                   returns  an error if it cannot allocate enough
+                   memory, or create the initial windows (stdscr,
+                   curscr,  newscr).   Other error conditions are
+                   documented above.
 
 
 </PRE>
 <H2>NOTES</H2><PRE>
 
 
 </PRE>
 <H2>NOTES</H2><PRE>
-       The <B>setupterm</B> routine should be used in place of  <B>setterm</B>.
+       The <STRONG>setupterm</STRONG> routine should be used in place of  <STRONG>setterm</STRONG>.
        It  may be useful when you want to test for terminal capa-
        bilities without committing to the allocation  of  storage
        It  may be useful when you want to test for terminal capa-
        bilities without committing to the allocation  of  storage
-       involved in <B>initscr</B>.
+       involved in <STRONG>initscr</STRONG>.
 
 
-       Note that <B>vidattr</B> and <B>vidputs</B> may be macros.
+       Note that <STRONG>vidattr</STRONG> and <STRONG>vidputs</STRONG> may be macros.
 
 
 </PRE>
 <H2>PORTABILITY</H2><PRE>
 
 
 </PRE>
 <H2>PORTABILITY</H2><PRE>
-       The  function  <B>setterm</B>  is not described in the XSI Curses
+       The  function  <STRONG>setterm</STRONG>  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.
 
        standard and must be considered non-portable.   All  other
        functions are as described in the XSI curses standard.
 
-       In  System V Release 4, <B>set_curterm</B> has an <B>int</B> return type
-       and returns <B>OK</B> or <B>ERR</B>.  We have chosen  to  implement  the
+       In  System V Release 4, <STRONG>set_curterm</STRONG> has an <STRONG>int</STRONG> return type
+       and returns <STRONG>OK</STRONG> or <STRONG>ERR</STRONG>.  We have chosen  to  implement  the
        XSI Curses semantics.
 
        XSI Curses semantics.
 
-       In System V Release 4, the third argument of <B>tputs</B> has the
-       type <B>int</B> <B>(*putc)(char)</B>.
+       In System V Release 4, the third argument of <STRONG>tputs</STRONG> has the
+       type <STRONG>int</STRONG> <STRONG>(*putc)(char)</STRONG>.
+
+       The XSI Curses standard prototypes <STRONG>tparm</STRONG> with a fixed num-
+       ber  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.
+
+       XSI notes that after calling <STRONG>mvcur</STRONG>, the curses  state  may
+       not  match the actual terminal state, and that an applica-
+       tion should touch and refresh the window  before  resuming
+       normal  curses calls.  Both ncurses and System V Release 4
+       curses implement <STRONG>mvcur</STRONG> using the SCREEN data allocated  in
+       either  <STRONG>initscr</STRONG> or <STRONG>newterm</STRONG>.  So though it is documented as
+       a terminfo function, <STRONG>mvcur</STRONG> is  really  a  curses  function
+       which is not well specified.
 
 
-       The XSI Curses standard prototypes <B>tparm</B> with a fixed num-
-       ber of parameters, rather than a variable argument list.
+       XSI  states that the old location must be given.  This im-
+       plementation allows the caller to use -1's for the old or-
+       dinates.  In that case, the old location is unknown.
 
 
-       XSI  notes  that after calling <B>mvcur</B>, the curses state may
-       not match the actual terminal state, and that an  applica-
-       tion  should  touch and refresh the window before resuming
-       normal curses calls.  Both ncurses and System V Release  4
-       curses  implement <B>mvcur</B> using the SCREEN data allocated in
-       either <B>initscr</B> or <B>newterm</B>.  So though it is documented  as
-       a  terminfo  function,  <B>mvcur</B>  is really a curses function
-       which is not well specified.
+       Extended  terminal  capability  names, e.g., as defined by
+       <STRONG>tic</STRONG> <STRONG>-x</STRONG>, are not stored in the  arrays  described  in  this
+       section.
 
 
 </PRE>
 <H2>SEE ALSO</H2><PRE>
 
 
 </PRE>
 <H2>SEE ALSO</H2><PRE>
-       <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></B>, <B><A HREF="curs_kernel.3x.html">curs_kernel(3x)</A></B>,  <B>curs_term-</B>
-       <B><A HREF="cap.3x.html">cap(3x)</A></B>, <B><A HREF="putc.3S.html">putc(3S)</A></B>, <B><A HREF="terminfo.5.html">terminfo(5)</A></B>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+       <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>,  <STRONG><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></STRONG>, <STRONG><A HREF="curs_kernel.3x.html">curs_kernel(3x)</A></STRONG>, <STRONG>curs_term-</STRONG>
+       <STRONG><A HREF="curs_termcap.3x.html">cap(3x)</A></STRONG>, <STRONG><A HREF="putc.3S.html">putc(3S)</A></STRONG>, <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>
 
 
 
 
 
 
+                                                      <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG>
 </PRE>
 <HR>
 <ADDRESS>
 </PRE>
 <HR>
 <ADDRESS>