doc/html/man/curs_terminfo.3x.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
   2 <!--
   3   ****************************************************************************
   4   * Copyright (c) 1999-2011,2013 Free Software Foundation, Inc.              *
   5   *                                                                          *
   6   * Permission is hereby granted, free of charge, to any person obtaining a  *
   7   * copy of this software and associated documentation files (the            *
   8   * "Software"), to deal in the Software without restriction, including      *
   9   * without limitation the rights to use, copy, modify, merge, publish,      *
  10   * distribute, distribute with modifications, sublicense, and/or sell       *
  11   * copies of the Software, and to permit persons to whom the Software is    *
  12   * furnished to do so, subject to the following conditions:                 *
  13   *                                                                          *
  14   * The above copyright notice and this permission notice shall be included  *
  15   * in all copies or substantial portions of the Software.                   *
  16   *                                                                          *
  17   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
  18   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
  19   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
  20   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
  21   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
  22   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
  23   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
  24   *                                                                          *
  25   * Except as contained in this notice, the name(s) of the above copyright   *
  26   * holders shall not be used in advertising or otherwise to promote the     *
  27   * sale, use or other dealings in this Software without prior written       *
  28   * authorization.                                                           *
  29   ****************************************************************************
  30   * @Id: curs_terminfo.3x,v 1.43 2013/07/20 19:29:59 tom Exp @
  31   * ***************************************************************************
  32   * ***************************************************************************
  33   * ***************************************************************************
  34   * ***************************************************************************
  35   * ***************************************************************************
  36 -->
  37 <HTML>
  38 <HEAD>
  39 <TITLE>curs_terminfo 3x</TITLE>
  40 <link rev=made href="mailto:bug-ncurses@gnu.org">
  41 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  42 </HEAD>
  43 <BODY>
  44 <H1>curs_terminfo 3x</H1>
  45 <HR>
  46 <PRE>
  47 <!-- Manpage converted by man2html 3.0.1 -->
  48 <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG>                                     <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG>
  49
  50
  51
  52
  53 </PRE>
  54 <H2>NAME</H2><PRE>
  55        <STRONG>del_curterm</STRONG>, <STRONG>mvcur</STRONG>, <STRONG>putp</STRONG>, <STRONG>restartterm</STRONG>, <STRONG>set_curterm</STRONG>,
  56        <STRONG>setterm</STRONG>, <STRONG>setupterm</STRONG>, <STRONG>tigetflag</STRONG>, <STRONG>tigetnum</STRONG>, <STRONG>tigetstr</STRONG>, <STRONG>tiparm</STRONG>,
  57        <STRONG>tparm</STRONG>, <STRONG>tputs</STRONG>, <STRONG>vid_attr</STRONG>, <STRONG>vid_puts</STRONG>, <STRONG>vidattr</STRONG>, <STRONG>vidputs</STRONG> -
  58        <STRONG>curses</STRONG> interfaces to terminfo database
  59
  60
  61 </PRE>
  62 <H2>SYNOPSIS</H2><PRE>
  63        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
  64        <STRONG>#include</STRONG> <STRONG>&lt;term.h&gt;</STRONG>
  65
  66        <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>
  67        <STRONG>int</STRONG> <STRONG>setterm(char</STRONG> <STRONG>*</STRONG><EM>term</EM><STRONG>);</STRONG>
  68        <STRONG>TERMINAL</STRONG> <STRONG>*set_curterm(TERMINAL</STRONG> <STRONG>*</STRONG><EM>nterm</EM><STRONG>);</STRONG>
  69        <STRONG>int</STRONG> <STRONG>del_curterm(TERMINAL</STRONG> <STRONG>*</STRONG><EM>oterm</EM><STRONG>);</STRONG>
  70        <STRONG>int</STRONG> <STRONG>restartterm(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>
  71        <STRONG>char</STRONG> <STRONG>*tparm(char</STRONG> <STRONG>*</STRONG><EM>str</EM><STRONG>,</STRONG> <STRONG>...);</STRONG>
  72        <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>
  73        <STRONG>int</STRONG> <STRONG>putp(const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>str</EM><STRONG>);</STRONG>
  74        <STRONG>int</STRONG> <STRONG>vidputs(chtype</STRONG> <EM>attrs</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <STRONG>(*</STRONG><EM>putc</EM><STRONG>)(int));</STRONG>
  75        <STRONG>int</STRONG> <STRONG>vidattr(chtype</STRONG> <EM>attrs</EM><STRONG>);</STRONG>
  76        <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>)(int));</STRONG>
  77        <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>
  78        <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>
  79        <STRONG>int</STRONG> <STRONG>tigetflag(char</STRONG> <STRONG>*</STRONG><EM>capname</EM><STRONG>);</STRONG>
  80        <STRONG>int</STRONG> <STRONG>tigetnum(char</STRONG> <STRONG>*</STRONG><EM>capname</EM><STRONG>);</STRONG>
  81        <STRONG>char</STRONG> <STRONG>*tigetstr(char</STRONG> <STRONG>*</STRONG><EM>capname</EM><STRONG>);</STRONG>
  82        <STRONG>char</STRONG> <STRONG>*tiparm(const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>str</EM><STRONG>,</STRONG> <STRONG>...);</STRONG>
  83
  84
  85 </PRE>
  86 <H2>DESCRIPTION</H2><PRE>
  87        These low-level routines must be called by  programs  that
  88        have to deal directly with the <STRONG>terminfo</STRONG> database to handle
  89        certain terminal capabilities, such as  programming  func-
  90        tion  keys.   For all other functionality, <STRONG>curses</STRONG> routines
  91        are more suitable and their use is recommended.
  92
  93    <STRONG>Initialization</STRONG>
  94        Initially, <STRONG>setupterm</STRONG> should  be  called.   Note  that  <STRONG>se-</STRONG>
  95        <STRONG>tupterm</STRONG>  is  automatically  called by <STRONG>initscr</STRONG> and <STRONG>newterm</STRONG>.
  96        This  defines  the  set  of  terminal-dependent  variables
  97        [listed in <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>].
  98
  99        Each initialization routine provides applications with the
 100        terminal capabilities either directly (via header  defini-
 101        tions),  or  by special functions.  The header files <STRONG>curs-</STRONG>
 102        <STRONG>es.h</STRONG> and <STRONG>term.h</STRONG> should be included (in this order) to  get
 103        the definitions for these strings, numbers, and flags.
 104
 105        The  <STRONG>terminfo</STRONG>  variables <STRONG>lines</STRONG> and <STRONG>columns</STRONG> are initialized
 106        by <STRONG>setupterm</STRONG> as follows:
 107
 108        <STRONG>o</STRONG>   If <STRONG>use_env(FALSE)</STRONG> has been called,  values  for  <STRONG>lines</STRONG>
 109            and <STRONG>columns</STRONG> specified in <STRONG>terminfo</STRONG> are used.
 110
 111        <STRONG>o</STRONG>   Otherwise, if the environment variables <STRONG>LINES</STRONG> and <STRONG>COL-</STRONG>
 112            <STRONG>UMNS</STRONG> exist, their values are used.  If these  environ-
 113            ment variables do not exist and the program is running
 114            in a window, the current window size is used.   Other-
 115            wise,  if  the environment variables do not exist, the
 116            values for <STRONG>lines</STRONG> and <STRONG>columns</STRONG> specified in the <STRONG>terminfo</STRONG>
 117            database are used.
 118
 119        Parameterized  strings  should  be passed through <STRONG>tparm</STRONG> to
 120        instantiate them.  All  <STRONG>terminfo</STRONG>  strings  [including  the
 121        output  of  <STRONG>tparm</STRONG>]  should  be printed with <STRONG>tputs</STRONG> or <STRONG>putp</STRONG>.
 122        Call <STRONG>reset_shell_mode</STRONG> to restore the tty modes before  ex-
 123        iting [see <STRONG><A HREF="curs_kernel.3x.html">curs_kernel(3x)</A></STRONG>].
 124
 125        Programs which use cursor addressing should
 126
 127        <STRONG>o</STRONG>   output <STRONG>enter_ca_mode</STRONG> upon startup and
 128
 129        <STRONG>o</STRONG>   output <STRONG>exit_ca_mode</STRONG> before exiting.
 130
 131        Programs which execute shell subprocesses should
 132
 133        <STRONG>o</STRONG>   call  <STRONG>reset_shell_mode</STRONG>  and output <STRONG>exit_ca_mode</STRONG> before
 134            the shell is called and
 135
 136        <STRONG>o</STRONG>   output <STRONG>enter_ca_mode</STRONG> and  call  <STRONG>reset_prog_mode</STRONG>  after
 137            returning from the shell.
 138
 139        The <STRONG>setupterm</STRONG> routine reads in the <STRONG>terminfo</STRONG> database, ini-
 140        tializing the <STRONG>terminfo</STRONG> structures, but does not set up the
 141        output virtualization structures used by <STRONG>curses</STRONG>.  The ter-
 142        minal type is the character string <EM>term</EM>; if <EM>term</EM> is  null,
 143        the  environment  variable <STRONG>TERM</STRONG> is used.  All output is to
 144        file descriptor <STRONG>fildes</STRONG> which is  initialized  for  output.
 145        If  <EM>errret</EM>  is  not null, then <STRONG>setupterm</STRONG> returns <STRONG>OK</STRONG> or <STRONG>ERR</STRONG>
 146        and stores a status value in the integer pointed to by <EM>er-</EM>
 147        <EM>rret</EM>.   A  return value of <STRONG>OK</STRONG> combined with status of <STRONG>1</STRONG> in
 148        <EM>errret</EM> is normal.  If <STRONG>ERR</STRONG> is returned, examine <EM>errret</EM>:
 149
 150        <STRONG>1</STRONG>    means that the terminal is hardcopy, cannot  be  used
 151             for curses applications.
 152
 153             <STRONG>setupterm</STRONG>  determines if the entry is a hardcopy type
 154             by checking the <EM>hc</EM> (<EM>hardcopy</EM>) capability.
 155
 156        <STRONG>0</STRONG>    means that the terminal could not be found,  or  that
 157             it  is  a generic type, having too little information
 158             for curses applications to run.
 159
 160             <STRONG>setupterm</STRONG> determines if the entry is a  generic  type
 161             by checking the <EM>gn</EM> (<EM>generic</EM>) capability.
 162
 163        <STRONG>-1</STRONG>   means that the <STRONG>terminfo</STRONG> database could not be found.
 164
 165        If  <EM>errret</EM> is null, <STRONG>setupterm</STRONG> prints an error message upon
 166        finding an error and exits.  Thus, the simplest call is:
 167
 168              <STRONG>setupterm((char</STRONG> <STRONG>*)0,</STRONG> <STRONG>1,</STRONG> <STRONG>(int</STRONG> <STRONG>*)0);</STRONG>,
 169
 170        which uses all the defaults and sends the output  to  <STRONG>std-</STRONG>
 171        <STRONG>out</STRONG>.
 172
 173        The <STRONG>setterm</STRONG> routine was replaced by <STRONG>setupterm</STRONG>.  The call:
 174
 175              <STRONG>setupterm(</STRONG><EM>term</EM><STRONG>,</STRONG> <STRONG>1,</STRONG> <STRONG>(int</STRONG> <STRONG>*)0)</STRONG>
 176
 177        provides  the  same  functionality  as <STRONG>setterm(</STRONG><EM>term</EM><STRONG>)</STRONG>.  The
 178        <STRONG>setterm</STRONG> routine is provided for BSD compatibility, and  is
 179        not recommended for new programs.
 180
 181    <STRONG>The</STRONG> <STRONG>Terminal</STRONG> <STRONG>State</STRONG>
 182        The  <STRONG>setupterm</STRONG>  routine  stores  its information about the
 183        terminal in a <STRONG>TERMINAL</STRONG> structure pointed to by the  global
 184        variable  <STRONG>cur_term</STRONG>.   If  it  detects an error, or decides
 185        that the terminal is unsuitable (hardcopy or generic),  it
 186        discards  this information, making it not available to ap-
 187        plications.
 188
 189        If <STRONG>setupterm</STRONG> is called repeatedly for  the  same  terminal
 190        type,  it  will  reuse the information.  It maintains only
 191        one copy of a given terminal's capabilities in memory.  If
 192        it is called for different terminal types, <STRONG>setupterm</STRONG> allo-
 193        cates new storage for each set of terminal capabilities.
 194
 195        The <STRONG>set_curterm</STRONG> routine sets <STRONG>cur_term</STRONG> to <EM>nterm</EM>, and  makes
 196        all of the <STRONG>terminfo</STRONG> boolean, numeric, and string variables
 197        use the values from <EM>nterm</EM>.  It returns the  old  value  of
 198        <STRONG>cur_term</STRONG>.
 199
 200        The  <STRONG>del_curterm</STRONG>  routine  frees  the  space pointed to by
 201        <EM>oterm</EM> and makes it available for further use.  If <EM>oterm</EM> is
 202        the  same  as  <STRONG>cur_term</STRONG>, references to any of the <STRONG>terminfo</STRONG>
 203        boolean, numeric, and string variables thereafter may  re-
 204        fer  to  invalid  memory locations until another <STRONG>setupterm</STRONG>
 205        has been called.
 206
 207        The  <STRONG>restartterm</STRONG>  routine  is  similar  to  <STRONG>setupterm</STRONG>  and
 208        <STRONG>initscr</STRONG>,  except  that it is called after restoring memory
 209        to a previous state (for example, when  reloading  a  game
 210        saved as a core image dump).  <STRONG>restartterm</STRONG> assumes that the
 211        windows and the input and output options are the  same  as
 212        when memory was saved, but the terminal type and baud rate
 213        may be different.  Accordingly, <STRONG>restartterm</STRONG> saves  various
 214        tty  state  bits,  calls  <STRONG>setupterm</STRONG>, and then restores the
 215        bits.
 216
 217    <STRONG>Formatting</STRONG> <STRONG>Output</STRONG>
 218        The <STRONG>tparm</STRONG> routine instantiates the string <EM>str</EM> with parame-
 219        ters  <EM>pi</EM>.  A pointer is returned to the result of <EM>str</EM> with
 220        the parameters applied.
 221
 222        <STRONG>tiparm</STRONG> is a newer form  of  <STRONG>tparm</STRONG>  which  uses  <EM>&lt;stdarg.h&gt;</EM>
 223        rather  than  a fixed-parameter list.  Its numeric parame-
 224        ters are integers (int) rather than longs.
 225
 226    <STRONG>Output</STRONG> <STRONG>Functions</STRONG>
 227        The <STRONG>tputs</STRONG>  routine  applies  padding  information  to  the
 228        string  <EM>str</EM>  and  outputs  it.  The <EM>str</EM> must be a terminfo
 229        string variable or the return value from  <STRONG>tparm</STRONG>,  <STRONG>tgetstr</STRONG>,
 230        or <STRONG>tgoto</STRONG>.  <EM>affcnt</EM> is the number of lines affected, or 1 if
 231        not applicable.  <EM>putc</EM> is a <STRONG>putchar</STRONG>-like routine  to  which
 232        the characters are passed, one at a time.
 233
 234        The  <STRONG>putp</STRONG> routine calls <STRONG>tputs(</STRONG><EM>str</EM><STRONG>,</STRONG> <STRONG>1,</STRONG> <STRONG>putchar)</STRONG>.  Note that
 235        the output of <STRONG>putp</STRONG> always  goes  to  <STRONG>stdout</STRONG>,  not  to  the
 236        <EM>fildes</EM> specified in <STRONG>setupterm</STRONG>.
 237
 238        The <STRONG>vidputs</STRONG> routine displays the string on the terminal in
 239        the video attribute mode <EM>attrs</EM>, which is  any  combination
 240        of  the  attributes  listed in <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>.  The characters
 241        are passed to the <STRONG>putchar</STRONG>-like routine <EM>putc</EM>.
 242
 243        The <STRONG>vidattr</STRONG> routine is like the  <STRONG>vidputs</STRONG>  routine,  except
 244        that it outputs through <STRONG>putchar</STRONG>.
 245
 246        The  <STRONG>vid_attr</STRONG>  and <STRONG>vid_puts</STRONG> routines correspond to vidattr
 247        and vidputs, respectively.  They use a  set  of  arguments
 248        for  representing  the  video attributes plus color, i.e.,
 249        one of type attr_t for the attributes and one of short for
 250        the color_pair number.  The <STRONG>vid_attr</STRONG> and <STRONG>vid_puts</STRONG> routines
 251        are designed to use the attribute constants with  the  <EM>WA</EM><STRONG>_</STRONG>
 252        prefix.   The  opts  argument  is reserved for future use.
 253        Currently, applications must provide a  null  pointer  for
 254        that argument.
 255
 256        The  <STRONG>mvcur</STRONG>  routine  provides low-level cursor motion.  It
 257        takes effect immediately (rather  than  at  the  next  re-
 258        fresh).
 259
 260    <STRONG>Terminal</STRONG> <STRONG>Capability</STRONG> <STRONG>Functions</STRONG>
 261        The  <STRONG>tigetflag</STRONG>,  <STRONG>tigetnum</STRONG> and <STRONG>tigetstr</STRONG> routines return the
 262        value of the capability corresponding to the <STRONG>terminfo</STRONG> <EM>cap-</EM>
 263        <EM>name</EM>  passed  to them, such as <STRONG>xenl</STRONG>.  The <EM>capname</EM> for each
 264        capability is given in the table column  entitled  <EM>capname</EM>
 265        code in the capabilities section of <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>.
 266
 267        These routines return special values to denote errors.
 268
 269        The <STRONG>tigetflag</STRONG> routine returns
 270
 271        <STRONG>-1</STRONG>     if <EM>capname</EM> is not a boolean capability, or
 272
 273        <STRONG>0</STRONG>      if  it  is canceled or absent from the terminal de-
 274               scription.
 275
 276        The <STRONG>tigetnum</STRONG> routine returns
 277
 278        <STRONG>-2</STRONG>     if <EM>capname</EM> is not a numeric capability, or
 279
 280        <STRONG>-1</STRONG>     if it is canceled or absent from the  terminal  de-
 281               scription.
 282
 283        The <STRONG>tigetstr</STRONG> routine returns
 284
 285        <STRONG>(char</STRONG> <STRONG>*)-1</STRONG>
 286               if <EM>capname</EM> is not a string capability, or
 287
 288        <STRONG>0</STRONG>      if  it  is canceled or absent from the terminal de-
 289               scription.
 290
 291    <STRONG>Terminal</STRONG> <STRONG>Capability</STRONG> <STRONG>Names</STRONG>
 292        These null-terminated arrays contain  the  short  terminfo
 293        names  ("codes"), the <STRONG>termcap</STRONG> names, and the long terminfo
 294        names ("fnames") for each of the predefined <STRONG>terminfo</STRONG> vari-
 295        ables:
 296               <STRONG>char</STRONG> <STRONG>*boolnames[]</STRONG>, <STRONG>*boolcodes[]</STRONG>, <STRONG>*boolfnames[]</STRONG>
 297
 298               <STRONG>char</STRONG> <STRONG>*numnames[]</STRONG>, <STRONG>*numcodes[]</STRONG>, <STRONG>*numfnames[]</STRONG>
 299
 300               <STRONG>char</STRONG> <STRONG>*strnames[]</STRONG>, <STRONG>*strcodes[]</STRONG>, <STRONG>*strfnames[]</STRONG>
 301
 302
 303 </PRE>
 304 <H2>RETURN VALUE</H2><PRE>
 305        Routines  that  return  an integer return <STRONG>ERR</STRONG> upon failure
 306        and <STRONG>OK</STRONG> (SVr4 only specifies "an integer value  other  than
 307        <STRONG>ERR</STRONG>")  upon  successful completion, unless otherwise noted
 308        in the preceding routine descriptions.
 309
 310        Routines that return pointers always return <STRONG>NULL</STRONG> on error.
 311
 312        X/Open defines no error conditions.  In  this  implementa-
 313        tion
 314
 315             <STRONG>del_curterm</STRONG>
 316                  returns  an  error  if its terminal parameter is
 317                  null.
 318
 319             <STRONG>putp</STRONG> calls <STRONG>tputs</STRONG>, returning the same error-codes.
 320
 321             <STRONG>restartterm</STRONG>
 322                  returns an error if the associated call  to  <STRONG>se-</STRONG>
 323                  <STRONG>tupterm</STRONG> returns an error.
 324
 325             <STRONG>setupterm</STRONG>
 326                  returns  an  error  if it cannot allocate enough
 327                  memory, or create the initial  windows  (stdscr,
 328                  curscr,  newscr).   Other  error  conditions are
 329                  documented above.
 330
 331             <STRONG>tputs</STRONG>
 332                  returns an error  if  the  string  parameter  is
 333                  null.   It  does  not  detect I/O errors: X/Open
 334                  states that <STRONG>tputs</STRONG> ignores the  return  value  of
 335                  the output function <EM>putc</EM>.
 336
 337
 338 </PRE>
 339 <H2>PORTABILITY</H2><PRE>
 340        X/Open notes that <STRONG>vidattr</STRONG> and <STRONG>vidputs</STRONG> may be macros.
 341
 342        The  function  <STRONG>setterm</STRONG> is not described by X/Open and must
 343        be considered non-portable.  All other  functions  are  as
 344        described by X/Open.
 345
 346        <STRONG>setupterm</STRONG>  copies  the terminal name to the array <STRONG>ttytype</STRONG>.
 347        This is not part of X/Open Curses, but is assumed by  some
 348        applications.
 349
 350        If  configured  to  use the terminal-driver, e.g., for the
 351        MinGW port,
 352
 353        <STRONG>o</STRONG>   <STRONG>setupterm</STRONG> interprets a missing/empty TERM variable  as
 354            the special value "unknown".
 355
 356        <STRONG>o</STRONG>   <STRONG>setupterm</STRONG>  allows explicit use of the the windows con-
 357            sole driver by checking if $TERM is set to "#win32con"
 358            or an abbreviation of that string.
 359
 360        Older versions of <STRONG>ncurses</STRONG> assumed that the file descriptor
 361        passed to <STRONG>setupterm</STRONG> from <STRONG>initscr</STRONG> or <STRONG>newterm</STRONG> uses  buffered
 362        I/O,  and would write to the corresponding stream.  In ad-
 363        dition to the limitation that the  terminal  was  left  in
 364        block-buffered  mode on exit (like SystemV curses), it was
 365        problematic because <STRONG>ncurses</STRONG> did not allow a  reliable  way
 366        to cleanup on receiving SIGTSTP.  The current version uses
 367        output buffers managed directly by <STRONG>ncurses</STRONG>.  Some  of  the
 368        low-level functions described in this manual page write to
 369        the standard output.  They are not signal-safe.  The high-
 370        level functions in <STRONG>ncurses</STRONG> use alternate versions of these
 371        functions using the more reliable buffering scheme.
 372
 373        In System V Release 4, <STRONG>set_curterm</STRONG> has an <STRONG>int</STRONG> return  type
 374        and  returns  <STRONG>OK</STRONG>  or <STRONG>ERR</STRONG>.  We have chosen to implement the
 375        X/Open Curses semantics.
 376
 377        In System V Release 4, the third argument of <STRONG>tputs</STRONG> has the
 378        type <STRONG>int</STRONG> <STRONG>(*putc)(char)</STRONG>.
 379
 380        At least one implementation of X/Open Curses (Solaris) re-
 381        turns a value other than OK/ERR from <STRONG>tputs</STRONG>.  That  returns
 382        the length of the string, and does no error-checking.
 383
 384        X/Open  Curses prototypes <STRONG>tparm</STRONG> with a fixed number of pa-
 385        rameters, rather than a variable argument list.  This  im-
 386        plementation  uses  a  variable  argument list, but can be
 387        configured to use the fixed-parameter list.  Portable  ap-
 388        plications  should  provide 9 parameters after the format;
 389        zeroes are fine for this purpose.
 390
 391        In response to comments by Thomas E. Dickey, X/Open Curses
 392        Issue 7 proposed the <STRONG>tiparm</STRONG> function in mid-2009.
 393
 394        X/Open  notes  that  after calling <STRONG>mvcur</STRONG>, the curses state
 395        may not match the actual terminal state, and that  an  ap-
 396        plication  should  touch and refresh the window before re-
 397        suming normal curses calls.  Both <STRONG>ncurses</STRONG> and System V Re-
 398        lease 4 curses implement <STRONG>mvcur</STRONG> using the SCREEN data allo-
 399        cated in either <STRONG>initscr</STRONG> or <STRONG>newterm</STRONG>.  So though it is docu-
 400        mented  as  a  terminfo function, <STRONG>mvcur</STRONG> is really a curses
 401        function which is not well specified.
 402
 403        X/Open states that the old  location  must  be  given  for
 404        <STRONG>mvcur</STRONG>.   This implementation allows the caller to use -1's
 405        for the old ordinates.  In that case, the old location  is
 406        unknown.
 407
 408        Other  implementions  may  not declare the capability name
 409        arrays.  Some provide them without declaring them.  X/Open
 410        does not specify them.
 411
 412        Extended  terminal  capability  names, e.g., as defined by
 413        <STRONG>tic</STRONG> <STRONG>-x</STRONG>, are not stored in the arrays described here.
 414
 415
 416 </PRE>
 417 <H2>SEE ALSO</H2><PRE>
 418        <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>
 419        <STRONG><A HREF="curs_termcap.3x.html">cap(3x)</A></STRONG>,  <STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG>, <STRONG><A HREF="term_variables.3x.html">term_variables(3x)</A></STRONG>, <STRONG>putc(3)</STRONG>,
 420        <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>
 421
 422
 423
 424                                                       <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG>
 425 </PRE>
 426 <HR>
 427 <ADDRESS>
 428 Man(1) output converted with
 429 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
 430 </ADDRESS>
 431 </BODY>
 432 </HTML>