<!--
+ * t
****************************************************************************
- * Copyright 2018-2020,2021 Thomas E. Dickey *
+ * Copyright 2018-2022,2023 Thomas E. Dickey *
* Copyright 1998-2016,2017 Free Software Foundation, Inc. *
* *
* Permission is hereby granted, free of charge, to any person obtaining a *
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: curs_terminfo.3x,v 1.75 2021/06/17 21:11:08 tom Exp @
+ * @Id: curs_terminfo.3x,v 1.122 2023/12/03 00:10:20 tom Exp @
+ * ***************************************************************************
+ * ***************************************************************************
+ * ***************************************************************************
+ * ***************************************************************************
* ***************************************************************************
* ***************************************************************************
* ***************************************************************************
<HEAD>
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
<meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
-<TITLE>curs_terminfo 3X</TITLE>
+<TITLE>curs_terminfo 3x 2023-12-02 ncurses 6.4 Library calls</TITLE>
<link rel="author" href="mailto:bug-ncurses@gnu.org">
-<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+
</HEAD>
<BODY>
-<H1 class="no-header">curs_terminfo 3X</H1>
+<H1 class="no-header">curs_terminfo 3x 2023-12-02 ncurses 6.4 Library calls</H1>
<PRE>
-<B><A HREF="curs_terminfo.3X.html">curs_terminfo(3X)</A></B> <B><A HREF="curs_terminfo.3X.html">curs_terminfo(3X)</A></B>
+<STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG> Library calls <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG>
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
- <B>del_curterm</B>, <B>mvcur</B>, <B>putp</B>, <B>restartterm</B>, <B>set_curterm</B>, <B>setupterm</B>,
- <B>tigetflag</B>, <B>tigetnum</B>, <B>tigetstr</B>, <B>tiparm</B>, <B>tparm</B>, <B>tputs</B>, <B>vid_attr</B>,
- <B>vid_puts</B>, <B>vidattr</B>, <B>vidputs</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>setupterm</STRONG>,
+ <STRONG>tigetflag</STRONG>, <STRONG>tigetnum</STRONG>, <STRONG>tigetstr</STRONG>, <STRONG>tiparm</STRONG>, <STRONG>tiparm_s</STRONG>, <STRONG>tiscan_s</STRONG>, <STRONG>tparm</STRONG>,
+ <STRONG>tputs</STRONG>, <STRONG>vid_attr</STRONG>, <STRONG>vid_puts</STRONG>, <STRONG>vidattr</STRONG>, <STRONG>vidputs</STRONG> - <EM>curses</EM> interfaces to
+ <EM>terminfo</EM> database
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
- <B>#include</B> <B><curses.h></B>
- <B>#include</B> <B><term.h></B>
+ <STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
+ <STRONG>#include</STRONG> <STRONG><term.h></STRONG>
- <B>TERMINAL</B> <B>*cur_term;</B>
+ <STRONG>TERMINAL</STRONG> <STRONG>*cur_term;</STRONG>
- <B>const</B> <B>char</B> <B>*</B> <B>const</B> <B>boolnames[];</B>
- <B>const</B> <B>char</B> <B>*</B> <B>const</B> <B>boolcodes[];</B>
- <B>const</B> <B>char</B> <B>*</B> <B>const</B> <B>boolfnames[];</B>
- <B>const</B> <B>char</B> <B>*</B> <B>const</B> <B>numnames[];</B>
- <B>const</B> <B>char</B> <B>*</B> <B>const</B> <B>numcodes[];</B>
- <B>const</B> <B>char</B> <B>*</B> <B>const</B> <B>numfnames[];</B>
- <B>const</B> <B>char</B> <B>*</B> <B>const</B> <B>strnames[];</B>
- <B>const</B> <B>char</B> <B>*</B> <B>const</B> <B>strcodes[];</B>
- <B>const</B> <B>char</B> <B>*</B> <B>const</B> <B>strfnames[];</B>
+ <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>const</STRONG> <STRONG>boolnames[];</STRONG>
+ <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>const</STRONG> <STRONG>boolcodes[];</STRONG>
+ <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>const</STRONG> <STRONG>boolfnames[];</STRONG>
+ <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>const</STRONG> <STRONG>numnames[];</STRONG>
+ <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>const</STRONG> <STRONG>numcodes[];</STRONG>
+ <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>const</STRONG> <STRONG>numfnames[];</STRONG>
+ <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>const</STRONG> <STRONG>strnames[];</STRONG>
+ <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>const</STRONG> <STRONG>strcodes[];</STRONG>
+ <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>const</STRONG> <STRONG>strfnames[];</STRONG>
- <B>int</B> <B>setupterm(const</B> <B>char</B> <B>*</B><I>term</I><B>,</B> <B>int</B> <I>filedes</I><B>,</B> <B>int</B> <B>*</B><I>errret</I><B>);</B>
- <B>TERMINAL</B> <B>*set_curterm(TERMINAL</B> <B>*</B><I>nterm</I><B>);</B>
- <B>int</B> <B>del_curterm(TERMINAL</B> <B>*</B><I>oterm</I><B>);</B>
- <B>int</B> <B>restartterm(const</B> <B>char</B> <B>*</B><I>term</I><B>,</B> <B>int</B> <I>filedes</I><B>,</B> <B>int</B> <B>*</B><I>errret</I><B>);</B>
+ <STRONG>int</STRONG> <STRONG>setupterm(const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>term</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>filedes</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <STRONG>*</STRONG><EM>errret</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>filedes</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <STRONG>*</STRONG><EM>errret</EM><STRONG>);</STRONG>
- <B>char</B> <B>*tparm(const</B> <B>char</B> <B>*</B><I>str</I><B>,</B> <B>...);</B>
- <B>int</B> <B>tputs(const</B> <B>char</B> <B>*</B><I>str</I><B>,</B> <B>int</B> <I>affcnt</I><B>,</B> <B>int</B> <B>(*</B><I>putc</I><B>)(int));</B>
- <B>int</B> <B>putp(const</B> <B>char</B> <B>*</B><I>str</I><B>);</B>
+ <STRONG>char</STRONG> <STRONG>*tparm(const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>str</EM><STRONG>,</STRONG> <STRONG>...);</STRONG>
+ <EM>or</EM>
+ <STRONG>char</STRONG> <STRONG>*tparm(const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>str</EM><STRONG>,</STRONG> <STRONG>long</STRONG> <EM>p1</EM> <EM>...</EM> <STRONG>long</STRONG> <EM>p9</EM><STRONG>);</STRONG>
- <B>int</B> <B>vidputs(chtype</B> <I>attrs</I><B>,</B> <B>int</B> <B>(*</B><I>putc</I><B>)(int));</B>
- <B>int</B> <B>vidattr(chtype</B> <I>attrs</I><B>);</B>
- <B>int</B> <B>vid_puts(attr_t</B> <I>attrs</I><B>,</B> <B>short</B> <I>pair</I><B>,</B> <B>void</B> <B>*</B><I>opts</I><B>,</B> <B>int</B> <B>(*</B><I>putc</I><B>)(int));</B>
- <B>int</B> <B>vid_attr(attr_t</B> <I>attrs</I><B>,</B> <B>short</B> <I>pair</I><B>,</B> <B>void</B> <B>*</B><I>opts</I><B>);</B>
+ <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>
- <B>int</B> <B>mvcur(int</B> <I>oldrow</I><B>,</B> <B>int</B> <I>oldcol</I><B>,</B> <B>int</B> <I>newrow</I>, int <I>newcol</I><B>);</B>
+ <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>)(int));</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>
- <B>int</B> <B>tigetflag(const</B> <B>char</B> <B>*</B><I>capname</I><B>);</B>
- <B>int</B> <B>tigetnum(const</B> <B>char</B> <B>*</B><I>capname</I><B>);</B>
- <B>char</B> <B>*tigetstr(const</B> <B>char</B> <B>*</B><I>capname</I><B>);</B>
+ <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><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>newcol</EM><STRONG>);</STRONG>
- <B>char</B> <B>*tiparm(const</B> <B>char</B> <B>*</B><I>str</I><B>,</B> <B>...);</B>
+ <STRONG>int</STRONG> <STRONG>tigetflag(const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>capname</EM><STRONG>);</STRONG>
+ <STRONG>int</STRONG> <STRONG>tigetnum(const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>capname</EM><STRONG>);</STRONG>
+ <STRONG>char</STRONG> <STRONG>*tigetstr(const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>capname</EM><STRONG>);</STRONG>
+
+ <STRONG>char</STRONG> <STRONG>*tiparm(const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>str</EM><STRONG>,</STRONG> <STRONG>...);</STRONG>
+
+ <EM>/*</EM> <EM>extensions</EM> <EM>*/</EM>
+ <STRONG>char</STRONG> <STRONG>*tiparm_s(int</STRONG> <EM>expected</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>mask</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>str</EM><STRONG>,</STRONG> <STRONG>...);</STRONG>
+ <STRONG>int</STRONG> <STRONG>tiscan_s(int</STRONG> <STRONG>*</STRONG><EM>expected</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <STRONG>*</STRONG><EM>mask</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>str</EM><STRONG>);</STRONG>
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
- These low-level routines must be called by programs that have to deal
- directly with the <B>terminfo</B> database to handle certain terminal capabil-
- ities, such as programming function keys. For all other functionality,
- <B>curses</B> routines are more suitable and their use is recommended.
+ These low-level routines must be called by programs that have to deal
+ directly with the <EM>terminfo</EM> database to handle certain terminal
+ capabilities, such as programming function keys. For all other
+ functionality, <EM>curses</EM> routines are more suitable and their use is
+ recommended.
None of these functions use (or are aware of) multibyte character
strings such as UTF-8:
- <B>o</B> capability names use the POSIX portable character set
+ <STRONG>o</STRONG> capability names use the POSIX portable character set
- <B>o</B> capability string values have no associated encoding; they are
+ <STRONG>o</STRONG> capability string values have no associated encoding; they are
strings of 8-bit characters.
</PRE><H3><a name="h3-Initialization">Initialization</a></H3><PRE>
- Initially, <B>setupterm</B> should be called. The high-level curses functions
- <B>initscr</B> and <B>newterm</B> call <B>setupterm</B> to initialize the low-level set of
- terminal-dependent variables [listed in <B><A HREF="terminfo.5.html">terminfo(5)</A></B>].
+ Initially, <STRONG>setupterm</STRONG> should be called. The high-level curses functions
+ <STRONG>initscr</STRONG> and <STRONG>newterm</STRONG> call <STRONG>setupterm</STRONG> to initialize the low-level set of
+ terminal-dependent variables [listed in <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>].
Applications can use the terminal capabilities either directly (via
- header definitions), or by special functions. The header files <B>curs-</B>
- <B>es.h</B> and <B>term.h</B> should be included (in this order) to get the defini-
- tions for these strings, numbers, and flags.
+ header definitions), or by special functions. 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.
- The <B>terminfo</B> variables <B>lines</B> and <B>columns</B> are initialized by <B>setupterm</B>
+ The <STRONG>terminfo</STRONG> variables <STRONG>lines</STRONG> and <STRONG>columns</STRONG> are initialized by <STRONG>setupterm</STRONG>
as follows:
- <B>o</B> 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.
+ <STRONG>o</STRONG> 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.
- <B>o</B> Otherwise, if the environment variables <B>LINES</B> and <B>COLUMNS</B> exist,
+ <STRONG>o</STRONG> Otherwise, if the environment variables <EM>LINES</EM> and <EM>COLUMNS</EM> 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 <B>lines</B> and <B>columns</B> specified in the <B>terminfo</B> database are
+ values for <STRONG>lines</STRONG> and <STRONG>columns</STRONG> specified in the <STRONG>terminfo</STRONG> database are
used.
- 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 <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>].
+ Parameterized strings should be 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 <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>].
Programs which use cursor addressing should
- <B>o</B> output <B>enter_ca_mode</B> upon startup and
+ <STRONG>o</STRONG> output <STRONG>enter_ca_mode</STRONG> upon startup and
- <B>o</B> output <B>exit_ca_mode</B> before exiting.
+ <STRONG>o</STRONG> output <STRONG>exit_ca_mode</STRONG> before exiting.
Programs which execute shell subprocesses should
- <B>o</B> call <B>reset_shell_mode</B> and output <B>exit_ca_mode</B> before the shell is
+ <STRONG>o</STRONG> call <STRONG>reset_shell_mode</STRONG> and output <STRONG>exit_ca_mode</STRONG> before the shell is
called and
- <B>o</B> output <B>enter_ca_mode</B> and call <B>reset_prog_mode</B> after returning from
+ <STRONG>o</STRONG> output <STRONG>enter_ca_mode</STRONG> and call <STRONG>reset_prog_mode</STRONG> after returning from
the shell.
- The <B>setupterm</B> routine reads in the <B>terminfo</B> database, initializing the
- <B>terminfo</B> structures, but does not set up the output virtualization
- structures used by <B>curses</B>. These are its parameters:
+ The <STRONG>setupterm</STRONG> routine reads in the <STRONG>terminfo</STRONG> database, initializing the
+ <STRONG>terminfo</STRONG> structures, but does not set up the output virtualization
+ structures used by <STRONG>curses</STRONG>. These are its parameters:
- <I>term</I> is the terminal type, a character string. If <I>term</I> is null, the
- environment variable <B>TERM</B> is used.
+ <EM>term</EM> is the terminal type, a character string. If <EM>term</EM> is null, the
+ environment variable <EM>TERM</EM> is used.
- <I>filedes</I>
- is the file descriptor used for all output.
+ <EM>filedes</EM>
+ is the file descriptor used for getting and setting terminal
+ I/O modes.
- <I>errret</I>
- points to an optional location where an error status can be re-
- turned to the caller. 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 sta-
- tus of <B>1</B> in <I>errret</I> is normal.
+ Higher-level applications use <STRONG><A HREF="curs_initscr.3x.html">newterm(3x)</A></STRONG> for initializing the
+ terminal, passing an output <EM>stream</EM> rather than a <EM>descriptor</EM>.
+ In curses, the two are the same because <STRONG>newterm</STRONG> calls
+ <STRONG>setupterm</STRONG>, passing the file descriptor derived from its output
+ stream parameter.
- If <B>ERR</B> is returned, examine <I>errret</I>:
+ <EM>errret</EM>
+ points to an optional location where an error status can be
+ returned to the caller. 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>errret</EM>. A return value of <STRONG>OK</STRONG> combined with
+ status of <STRONG>1</STRONG> in <EM>errret</EM> is normal.
- <B>1</B> means that the terminal is hardcopy, cannot be used for
- curses applications.
+ If <STRONG>ERR</STRONG> is returned, examine <EM>errret</EM>:
- <B>setupterm</B> determines if the entry is a hardcopy type by
- checking the <B>hc</B> (<B>hardcopy</B>) capability.
+ <STRONG>1</STRONG> means that the terminal is hardcopy, cannot be used for
+ <EM>curses</EM> applications.
- <B>0</B> means that the terminal could not be found, or that it is
- a generic type, having too little information for curses
+ <STRONG>setupterm</STRONG> determines if the entry is a hardcopy type by
+ checking the <STRONG>hc</STRONG> (<STRONG>hardcopy</STRONG>) capability.
+
+ <STRONG>0</STRONG> means that the terminal could not be found, or that it is
+ a generic type, having too little information for <EM>curses</EM>
applications to run.
- <B>setupterm</B> determines if the entry is a generic type by
- checking the <B>gn</B> (<B>generic</B>) capability.
+ <STRONG>setupterm</STRONG> determines if the entry is a generic type by
+ checking the <STRONG>gn</STRONG> (<STRONG>generic_type</STRONG>) capability.
- <B>-1</B> means that the <B>terminfo</B> database could not be found.
+ <STRONG>-1</STRONG> means that the <EM>terminfo</EM> database could not be found.
- If <I>errret</I> is null, <B>setupterm</B> prints an error message upon find-
- ing an error and exits. Thus, the simplest call is:
+ If <EM>errret</EM> is null, <STRONG>setupterm</STRONG> prints an error message upon
+ 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>stdout</B>.
+ which uses all the defaults and sends the output to <STRONG>stdout</STRONG>.
</PRE><H3><a name="h3-The-Terminal-State">The Terminal State</a></H3><PRE>
- The <B>setupterm</B> routine stores its information about the terminal in a
- <B>TERMINAL</B> structure pointed to by the global variable <B>cur_term</B>. If it
- detects an error, or decides that the terminal is unsuitable (hardcopy
- or generic), it discards this information, making it not available to
+ The <STRONG>setupterm</STRONG> routine stores its information about the terminal in a
+ <STRONG>TERMINAL</STRONG> structure pointed to by the global variable <STRONG>cur_term</STRONG>. If it
+ detects an error, or decides that the terminal is unsuitable (hardcopy
+ or generic), it discards this information, making it not available to
applications.
- If <B>setupterm</B> is called repeatedly for the same terminal type, it will
- reuse the information. It maintains only one copy of a given termi-
- nal's capabilities in memory. If it is called for different terminal
- types, <B>setupterm</B> allocates new storage for each set of terminal capa-
- bilities.
+ If <STRONG>setupterm</STRONG> is called repeatedly for the same terminal type, it will
+ reuse the information. It maintains only one copy of a given
+ terminal's capabilities in memory. If it is called for different
+ terminal types, <STRONG>setupterm</STRONG> allocates new storage for each set of
+ terminal capabilities.
- The <B>set_curterm</B> routine sets <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 <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>, refer-
- ences to any of the <B>terminfo</B> boolean, numeric, and string variables
- thereafter may refer to invalid memory locations until another <B>se-</B>
- <B>tupterm</B> has been called.
+ 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 refer to invalid memory locations until
+ another <STRONG>setupterm</STRONG> 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 to a previous state (for exam-
- ple, when reloading a game saved as a core image dump). <B>restartterm</B>
- 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, <B>restartterm</B> saves various tty state bits,
- calls <B>setupterm</B>, and then restores the bits.
+ 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).
+ <STRONG>restartterm</STRONG> 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, <STRONG>restartterm</STRONG> saves various tty
+ state bits, calls <STRONG>setupterm</STRONG>, and then restores the bits.
</PRE><H3><a name="h3-Formatting-Output">Formatting Output</a></H3><PRE>
- The <B>tparm</B> routine instantiates the string <I>str</I> with parameters <I>pi</I>. A
- pointer is returned to the result of <I>str</I> with the parameters applied.
- Application developers should keep in mind these quirks of the inter-
- face:
+ The <STRONG>tparm</STRONG> routine instantiates the string <EM>str</EM> with parameters <EM>pi</EM>. A
+ pointer is returned to the result of <EM>str</EM> with the parameters applied.
+ Application developers should keep in mind these quirks of the
+ interface:
- <B>o</B> Although <B>tparm</B>'s actual parameters may be integers or strings, the
- prototype expects <B>long</B> (integer) values.
+ <STRONG>o</STRONG> Although <STRONG>tparm</STRONG>'s actual parameters may be integers or strings, the
+ prototype expects <STRONG>long</STRONG> (integer) values.
- <B>o</B> Aside from the <B>set_attributes</B> (<B>sgr</B>) capability, most terminal capa-
- bilities require no more than one or two parameters.
+ <STRONG>o</STRONG> Aside from the <STRONG>set_attributes</STRONG> (<STRONG>sgr</STRONG>) capability, most terminal
+ capabilities require no more than one or two parameters.
- <B>o</B> Padding information is ignored by <B>tparm</B>; it is interpreted by
- <B>tputs</B>.
+ <STRONG>o</STRONG> Padding information is ignored by <STRONG>tparm</STRONG>; it is interpreted by
+ <STRONG>tputs</STRONG>.
- <B>o</B> The capability string is null-terminated. Use "\200" where an
+ <STRONG>o</STRONG> The capability string is null-terminated. Use "\200" where an
ASCII NUL is needed in the output.
- <B>tiparm</B> is a newer form of <B>tparm</B> which uses <I><stdarg.h></I> rather than a
+ <STRONG>tiparm</STRONG> is a newer form of <STRONG>tparm</STRONG> which uses <EM><stdarg.h></EM> rather than a
fixed-parameter list. Its numeric parameters are integers (int) rather
than longs.
+ Both <STRONG>tparm</STRONG> and <STRONG>tiparm</STRONG> assume that the application passes parameters
+ consistent with the terminal description. Two extensions are provided
+ as alternatives to deal with untrusted data:
+
+ <STRONG>o</STRONG> <STRONG>tiparm_s</STRONG> is an extension which is a safer formatting function than
+ <STRONG>tparm</STRONG> or <STRONG>tiparm</STRONG>, because it allows the developer to tell the curses
+ library how many parameters to expect in the parameter list, and
+ which may be string parameters.
+
+ The <EM>mask</EM> parameter has one bit set for each of the parameters (up
+ to 9) which will be passed as char* rather than numbers.
+
+ <STRONG>o</STRONG> The extension <STRONG>tiscan_s</STRONG> allows the application to inspect a
+ formatting capability to see what the curses library would assume.
+
</PRE><H3><a name="h3-Output-Functions">Output Functions</a></H3><PRE>
- The <B>tputs</B> routine applies padding information (i.e., by interpreting
- marker embedded in the terminfo capability such as "$<5>" as 5 mil-
- liseconds) to the string <I>str</I> and outputs it:
+ String capabilities can contain padding information, a time delay
+ (accommodating performance limitations of hardware terminals) expressed
+ as <STRONG>$<</STRONG><EM>n</EM><STRONG>></STRONG>, where <EM>n</EM> is a nonnegative integral count of milliseconds. If <EM>n</EM>
+ exceeds 30,000 (thirty seconds), it is capped at that value.
- <B>o</B> The <I>str</I> parameter must be a terminfo string variable or the return
- value from <B>tparm</B>, <B>tiparm</B>, <B>tgetstr</B>, or <B>tgoto</B>.
+ The <STRONG>tputs</STRONG> routine interprets time-delay information in the string <EM>str</EM>
+ and outputs it, executing the delays:
- The <B>tgetstr</B> and <B>tgoto</B> functions are part of the <I>termcap</I> interface,
- which happens to share this function name with the <I>terminfo</I> inter-
- face.
+ <STRONG>o</STRONG> The <EM>str</EM> parameter must be a terminfo string variable or the return
+ value from <STRONG>tparm</STRONG>, <STRONG>tiparm</STRONG>, <STRONG>tgetstr</STRONG>, or <STRONG>tgoto</STRONG>.
- <B>o</B> <I>affcnt</I> is the number of lines affected, or 1 if not applicable.
+ The <STRONG>tgetstr</STRONG> and <STRONG>tgoto</STRONG> functions are part of the <EM>termcap</EM> interface,
+ which happens to share this function name with the <EM>terminfo</EM>
+ interface.
- <B>o</B> <I>putc</I> is a <B>putchar</B>-like routine to which the characters are passed,
+ <STRONG>o</STRONG> <EM>affcnt</EM> is the number of lines affected, or 1 if not applicable.
+
+ <STRONG>o</STRONG> <EM>putc</EM> is a <STRONG>putchar</STRONG>-like routine to which 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>. The output of <B>putp</B> al-
- ways goes to <B>stdout</B>, rather than the <I>filedes</I> specified in <B>setupterm</B>.
+ If <STRONG>tputs</STRONG> processes a time-delay, it uses the <STRONG><A HREF="curs_util.3x.html">delay_output(3x)</A></STRONG>
+ function, routing any resulting padding characters through this
+ function.
+
+ The <STRONG>putp</STRONG> routine calls <STRONG>tputs(</STRONG><EM>str</EM><STRONG>,</STRONG> <STRONG>1,</STRONG> <STRONG>putchar)</STRONG>. The output of <STRONG>putp</STRONG>
+ always goes to <STRONG>stdout</STRONG>, rather than the <EM>filedes</EM> specified in <STRONG>setupterm</STRONG>.
- 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="curses.3X.html">curses(3X)</A></B>. The characters are passed to the <B>putchar</B>-like routine
- <I>putc</I>.
+ 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 <B>vidattr</B> routine is like the <B>vidputs</B> routine, except that it outputs
- through <B>putchar</B>.
+ The <STRONG>vidattr</STRONG> routine is like the <STRONG>vidputs</STRONG> routine, except that it outputs
+ through <STRONG>putchar</STRONG>.
- The <B>vid_attr</B> and <B>vid_puts</B> routines correspond to vidattr and vidputs,
+ 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.,
- <B>o</B> <I>attrs</I> of type <B>attr_t</B> for the attributes and
+ <STRONG>o</STRONG> <EM>attrs</EM> of type <STRONG>attr_t</STRONG> for the attributes and
- <B>o</B> <I>pair</I> of type <B>short</B> for the color-pair number.
+ <STRONG>o</STRONG> <EM>pair</EM> of type <STRONG>short</STRONG> for the color-pair number.
- The <B>vid_attr</B> and <B>vid_puts</B> routines are designed to use the attribute
- constants with the <I>WA</I><B>_</B> prefix.
+ The <STRONG>vid_attr</STRONG> and <STRONG>vid_puts</STRONG> routines are designed to use the attribute
+ constants with the <STRONG>WA_</STRONG> prefix.
- X/Open Curses reserves the <I>opts</I> argument for future use, saying that
- applications must provide a null pointer for that argument. As an ex-
- tension, this implementation allows <I>opts</I> to be used as a pointer to
- <B>int</B>, which overrides the <I>pair</I> (<B>short</B>) argument.
+ X/Open Curses reserves the <EM>opts</EM> argument for future use, saying that
+ applications must provide a null pointer for that argument. As an
+ extension, this implementation allows <EM>opts</EM> to be used as a pointer to
+ <STRONG>int</STRONG>, which overrides the <EM>pair</EM> (<STRONG>short</STRONG>) argument.
- The <B>mvcur</B> routine provides low-level cursor motion. It takes effect
- immediately (rather than at the next refresh).
+ The <STRONG>mvcur</STRONG> routine provides low-level cursor motion. It takes effect
+ immediately (rather than at the next refresh). Unlike the other low-
+ level output functions, which either write to the standard output or
+ pass an output function parameter, <STRONG>mvcur</STRONG> uses an output file descriptor
+ derived from the output stream parameter of <STRONG><A HREF="curs_initscr.3x.html">newterm(3x)</A></STRONG>.
- While <B>putp</B> and <B>mvcur</B> are low-level functions which do not use the high-
- level curses state, they are declared in <B><curses.h></B> because SystemV did
- this (see <B>HISTORY</B>).
+ While <STRONG>putp</STRONG> and <STRONG>mvcur</STRONG> are low-level functions which do not use the high-
+ level curses state, they are declared in <STRONG><curses.h></STRONG> because System V
+ did this (see <EM>HISTORY</EM>).
</PRE><H3><a name="h3-Terminal-Capability-Functions">Terminal Capability Functions</a></H3><PRE>
- 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>capname</I> passed to them, such
- as <B>xenl</B>. The <I>capname</I> for each capability is given in the table column
- entitled <I>capname</I> code in the capabilities section of <B><A HREF="terminfo.5.html">terminfo(5)</A></B>.
+ 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>capname</EM> passed to them, such
+ as <STRONG>xenl</STRONG>. The <EM>capname</EM> for each capability is given in the table column
+ entitled <EM>capname</EM> code in the capabilities section of <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>.
These routines return special values to denote errors.
- The <B>tigetflag</B> routine returns
+ The <STRONG>tigetflag</STRONG> routine returns
- <B>-1</B> if <I>capname</I> is not a boolean capability, or
+ <STRONG>-1</STRONG> if <EM>capname</EM> is not a boolean capability, or
- <B>0</B> if it is canceled or absent from the terminal description.
+ <STRONG>0</STRONG> if it is canceled or absent from the terminal description.
- The <B>tigetnum</B> routine returns
+ The <STRONG>tigetnum</STRONG> routine returns
- <B>-2</B> if <I>capname</I> is not a numeric capability, or
+ <STRONG>-2</STRONG> if <EM>capname</EM> is not a numeric capability, or
- <B>-1</B> if it is canceled or absent from the terminal description.
+ <STRONG>-1</STRONG> if it is canceled or absent from the terminal description.
- The <B>tigetstr</B> routine returns
+ The <STRONG>tigetstr</STRONG> routine returns
- <B>(char</B> <B>*)-1</B>
- if <I>capname</I> is not a string capability, or
+ <STRONG>(char</STRONG> <STRONG>*)-1</STRONG>
+ if <EM>capname</EM> is not a string capability, or
- <B>0</B> if it is canceled or absent from the terminal description.
+ <STRONG>0</STRONG> if it is canceled or absent from the terminal description.
</PRE><H3><a name="h3-Terminal-Capability-Names">Terminal Capability Names</a></H3><PRE>
These null-terminated arrays contain
- <B>o</B> the short terminfo names ("codes"),
+ <STRONG>o</STRONG> the short <EM>terminfo</EM> names ("codes"),
+
+ <STRONG>o</STRONG> the <EM>termcap</EM> names ("names"), and
+
+ <STRONG>o</STRONG> the long <EM>terminfo</EM> names ("fnames")
+
+ for each of the predefined <EM>terminfo</EM> variables:
+
+ <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*boolnames[]</STRONG>, <STRONG>*boolcodes[]</STRONG>, <STRONG>*boolfnames[]</STRONG>
+ <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*numnames[]</STRONG>, <STRONG>*numcodes[]</STRONG>, <STRONG>*numfnames[]</STRONG>
+ <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*strnames[]</STRONG>, <STRONG>*strcodes[]</STRONG>, <STRONG>*strfnames[]</STRONG>
- <B>o</B> the <B>termcap</B> names ("names"), and
- <B>o</B> the long terminfo names ("fnames")
+</PRE><H3><a name="h3-Releasing-Memory">Releasing Memory</a></H3><PRE>
+ Each successful call to <STRONG>setupterm</STRONG> allocates memory to hold the terminal
+ description. As a side-effect, it sets <STRONG>cur_term</STRONG> to point to this
+ memory. If an application calls
- for each of the predefined <B>terminfo</B> variables:
+ <STRONG>del_curterm(cur_term);</STRONG>
- <B>const</B> <B>char</B> <B>*boolnames[]</B>, <B>*boolcodes[]</B>, <B>*boolfnames[]</B>
- <B>const</B> <B>char</B> <B>*numnames[]</B>, <B>*numcodes[]</B>, <B>*numfnames[]</B>
- <B>const</B> <B>char</B> <B>*strnames[]</B>, <B>*strcodes[]</B>, <B>*strfnames[]</B>
+ the memory will be freed.
+
+ The formatting functions <STRONG>tparm</STRONG> and <STRONG>tiparm</STRONG> extend the storage allocated
+ by <STRONG>setupterm</STRONG>:
+
+ <STRONG>o</STRONG> the "static" terminfo variables [a-z]. Before ncurses 6.3, those
+ were shared by all screens. With ncurses 6.3, those are allocated
+ per screen. See <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG> for details.
+
+ <STRONG>o</STRONG> to improve performance, ncurses 6.3 caches the result of analyzing
+ terminfo strings for their parameter types. That is stored as a
+ binary tree referenced from the <STRONG>TERMINAL</STRONG> structure.
+
+ The higher-level <STRONG>initscr</STRONG> and <STRONG>newterm</STRONG> functions use <STRONG>setupterm</STRONG>. Normally
+ they do not free this memory, but it is possible to do that using the
+ <STRONG><A HREF="curs_initscr.3x.html">delscreen(3x)</A></STRONG> function.
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></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 com-
- pletion, unless otherwise noted in the preceding routine descriptions.
+ 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.
- 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 implementation
- <B>del_curterm</B>
+ <STRONG>del_curterm</STRONG>
returns an error if its terminal parameter is null.
- <B>putp</B> calls <B>tputs</B>, returning the same error-codes.
+ <STRONG>putp</STRONG> calls <STRONG>tputs</STRONG>, returning the same error-codes.
- <B>restartterm</B>
- returns an error if the associated call to <B>setupterm</B> returns an
+ <STRONG>restartterm</STRONG>
+ returns an error if the associated call to <STRONG>setupterm</STRONG> returns an
error.
- <B>setupterm</B>
+ <STRONG>setupterm</STRONG>
returns an error if it cannot allocate enough memory, or create
- the initial windows (stdscr, curscr, newscr). Other error con-
- ditions are documented above.
+ the initial windows (stdscr, curscr, newscr). Other error
+ conditions are documented above.
- <B>tputs</B>
- returns an error if the string parameter is null. It does not
- detect I/O errors: X/Open states that <B>tputs</B> ignores the return
- value of the output function <I>putc</I>.
+ <STRONG>tparm</STRONG>
+ returns a null if the capability would require unexpected
+ parameters, e.g., too many, too few, or incorrect types
+ (strings where integers are expected, or vice versa).
+ <STRONG>tputs</STRONG>
+ returns an error if the string parameter is null. It does not
+ detect I/O errors: X/Open states that <STRONG>tputs</STRONG> ignores the return
+ value of the output function <EM>putc</EM>.
-</PRE><H3><a name="h3-Compatibility-macros">Compatibility macros</a></H3><PRE>
- This implementation provides a few macros for compatibility with sys-
- tems before SVr4 (see <B>HISTORY</B>). Those include <B>crmode</B>, <B>fixterm</B>,
- <B>gettmode</B>, <B>nocrmode</B>, <B>resetterm</B>, <B>saveterm</B>, and <B>setterm</B>.
- In SVr4, those are found in <B><curses.h></B>, but except for <B>setterm</B>, are
- likewise macros. The one function, <B>setterm</B>, is mentioned in the manual
- page. The manual page notes that the <B>setterm</B> routine was replaced by
- <B>setupterm</B>, stating that the call:
+</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
+ X/Open notes that <STRONG>vidattr</STRONG> and <STRONG>vidputs</STRONG> may be macros.
- <B>setupterm(</B><I>term</I><B>,</B> <B>1,</B> <B>(int</B> <B>*)0)</B>
-
- provides the same functionality as <B>setterm(</B><I>term</I><B>)</B>, and is not recommend-
- ed for new programs. This implementation provides each of those sym-
- bols as macros for BSD compatibility,
-
-
-</PRE><H2><a name="h2-HISTORY">HISTORY</a></H2><PRE>
- SVr2 introduced the terminfo feature. Its programming manual mentioned
- these low-level functions:
-
- <B>Function</B> <B>Description</B>
- ------------------------------------------------------------
- fixterm restore tty to "in curses" state
- gettmode establish current tty modes
- mvcur low level cursor motion
- putp utility function that uses <B>tputs</B> to send char-
- acters via <B>putchar</B>.
- resetterm set tty modes to "out of curses" state
- resetty reset tty flags to stored value
- saveterm save current modes as "in curses" state
- savetty store current tty flags
- setterm establish terminal with given type
- setupterm establish terminal with given type
- tparm instantiate a string expression with parameters
- tputs apply padding information to a string
- vidattr like <B>vidputs</B>, but outputs through <B>putchar</B>
- vidputs output a string to put terminal in a specified
- video attribute mode
-
- The programming manual also mentioned functions provided for termcap
- compatibility (commenting that they "may go away at a later date"):
-
- <B>Function</B> <B>Description</B>
- ------------------------------------------------
- tgetent look up termcap entry for given <I>name</I>
- tgetflag get boolean entry for given <I>id</I>
- tgetnum get numeric entry for given <I>id</I>
- tgetstr get string entry for given <I>id</I>
- tgoto apply parameters to given capability
- tputs apply padding to capability, calling
- a function to put characters
-
- Early terminfo programs obtained capability values from the <B>TERMINAL</B>
- structure initialized by <B>setupterm</B>.
-
- SVr3 extended terminfo by adding functions to retrieve capability val-
- ues (like the termcap interface), and reusing tgoto and tputs:
-
- <B>Function</B> <B>Description</B>
- -------------------------------------------
- tigetflag get boolean entry for given <I>id</I>
- tigetnum get numeric entry for given <I>id</I>
- tigetstr get string entry for given <I>id</I>
-
- SVr3 also replaced several of the SVr2 terminfo functions which had no
- counterpart in the termcap interface, documenting them as obsolete:
-
- <B>Function</B> <B>Replaced</B> <B>by</B>
- -----------------------------
- crmode cbreak
- fixterm reset_prog_mode
- gettmode N/A
- nocrmode nocbreak
- resetterm reset_shell_mode
- saveterm def_prog_mode
- setterm setupterm
- SVr3 kept the <B>mvcur</B>, <B>vidattr</B> and <B>vidputs</B> functions, along with <B>putp</B>,
- <B>tparm</B> and <B>tputs</B>. The latter were needed to support padding, and han-
- dling functions such as <B>vidattr</B> (which used more than the two parame-
- ters supported by <B>tgoto</B>).
+</PRE><H2><a name="h2-EXTENSIONS">EXTENSIONS</a></H2><PRE>
+ The functions marked as extensions were designed for <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG>, and
+ are not found in SVr4 curses, 4.4BSD curses, or any other previous
+ version of curses.
- SVr3 introduced the functions for switching between terminal descrip-
- tions, e.g., <B>set_curterm</B>. The various global variables such as <B>bool-</B>
- <B>names</B> were mentioned in the programming manual at this point.
- SVr4 added the <B>vid_attr</B> and <B>vid_puts</B> functions.
+</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
+ The function <STRONG>setterm</STRONG> is not described by X/Open and must be considered
+ non-portable. All other functions are as described by X/Open.
- There are other low-level functions declared in the curses header files
- on Unix systems, but none were documented. The functions marked "obso-
- lete" remained in use by the Unix <B>vi</B> editor.
+</PRE><H3><a name="h3-Compatibility-macros">Compatibility macros</a></H3><PRE>
+ This implementation provides a few macros for compatibility with
+ systems before SVr4 (see <EM>HISTORY</EM>). Those include <STRONG>crmode</STRONG>, <STRONG>fixterm</STRONG>,
+ <STRONG>gettmode</STRONG>, <STRONG>nocrmode</STRONG>, <STRONG>resetterm</STRONG>, <STRONG>saveterm</STRONG>, and <STRONG>setterm</STRONG>.
-</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
+ In SVr4, those are found in <STRONG><curses.h></STRONG>, but except for <STRONG>setterm</STRONG>, are
+ likewise macros. The one function, <STRONG>setterm</STRONG>, is mentioned in the manual
+ page. The manual page notes that the <STRONG>setterm</STRONG> routine was replaced by
+ <STRONG>setupterm</STRONG>, stating that the call
-</PRE><H3><a name="h3-Legacy-functions">Legacy functions</a></H3><PRE>
- X/Open notes that <B>vidattr</B> and <B>vidputs</B> may be macros.
+ <STRONG>setupterm(</STRONG><EM>term</EM><STRONG>,</STRONG> <STRONG>1,</STRONG> <STRONG>(int</STRONG> <STRONG>*)0)</STRONG>
- The function <B>setterm</B> is not described by X/Open and must be considered
- non-portable. All other functions are as described by X/Open.
+ provides the same functionality as <STRONG>setterm(</STRONG><EM>term</EM><STRONG>)</STRONG>, and is not
+ recommended for new programs. This implementation provides each of
+ those symbols as macros for BSD compatibility.
</PRE><H3><a name="h3-Legacy-data">Legacy data</a></H3><PRE>
- <B>setupterm</B> copies the terminal name to the array <B>ttytype</B>. This is not
+ <STRONG>setupterm</STRONG> copies the terminal name to the array <STRONG>ttytype</STRONG>. This is not
part of X/Open Curses, but is assumed by some applications.
Other implementions may not declare the capability name arrays. Some
provide them without declaring them. X/Open does not specify them.
- Extended terminal capability names, e.g., as defined by <B>tic</B> <B>-x</B>, are not
+ Extended terminal capability names, e.g., as defined by <STRONG>tic</STRONG> <STRONG>-x</STRONG>, are not
stored in the arrays described here.
</PRE><H3><a name="h3-Output-buffering">Output buffering</a></H3><PRE>
- Older versions of <B>ncurses</B> assumed that the file descriptor passed to
- <B>setupterm</B> from <B>initscr</B> or <B>newterm</B> uses buffered I/O, and would write to
- the corresponding stream. In addition to the limitation that the ter-
- minal was left in block-buffered mode on exit (like System V curses),
- it was problematic because <B>ncurses</B> did not allow a reliable way to
- cleanup on receiving SIGTSTP.
+ Older versions of <STRONG>ncurses</STRONG> assumed that the file descriptor passed to
+ <STRONG>setupterm</STRONG> from <STRONG>initscr</STRONG> or <STRONG>newterm</STRONG> uses buffered I/O, and would write to
+ the corresponding stream. In addition to the limitation that the
+ terminal was left in block-buffered mode on exit (like System V
+ curses), it was problematic because <STRONG>ncurses</STRONG> did not allow a reliable
+ way to cleanup on receiving SIGTSTP.
The current version (ncurses6) uses output buffers managed directly by
- <B>ncurses</B>. Some of the low-level functions described in this manual page
- write to the standard output. They are not signal-safe. The high-lev-
- el functions in <B>ncurses</B> use alternate versions of these functions using
- the more reliable buffering scheme.
+ <STRONG>ncurses</STRONG>. Some of the low-level functions described in this manual page
+ write to the standard output. They are not signal-safe. The high-
+ level functions in <STRONG>ncurses</STRONG> use alternate versions of these functions
+ using the more reliable buffering scheme.
</PRE><H3><a name="h3-Function-prototypes">Function prototypes</a></H3><PRE>
- The X/Open Curses prototypes are based on the SVr4 curses header decla-
- rations, which were defined at the same time the C language was first
- standardized in the late 1980s.
+ The X/Open Curses prototypes are based on the SVr4 curses header
+ declarations, which were defined at the same time the C language was
+ first standardized in the late 1980s.
- <B>o</B> X/Open Curses uses <B>const</B> less effectively than a later design
+ <STRONG>o</STRONG> X/Open Curses uses <STRONG>const</STRONG> less effectively than a later design
might, in some cases applying it needlessly to values are already
constant, and in most cases overlooking parameters which normally
- would use <B>const</B>. Using constant parameters for functions which do
- not use <B>const</B> may prevent the program from compiling. On the other
- hand, <I>writable</I> <I>strings</I> are an obsolescent feature.
+ would use <STRONG>const</STRONG>. Using constant parameters for functions which do
+ not use <STRONG>const</STRONG> may prevent the program from compiling. On the other
+ hand, <EM>writable</EM> <EM>strings</EM> are an obsolescent feature.
As an extension, this implementation can be configured to change
- the function prototypes to use the <B>const</B> keyword. The ncurses ABI
+ the function prototypes to use the <STRONG>const</STRONG> keyword. The <EM>ncurses</EM> ABI
6 enables this feature by default.
- <B>o</B> X/Open Curses prototypes <B>tparm</B> with a fixed number of parameters,
+ <STRONG>o</STRONG> X/Open Curses prototypes <STRONG>tparm</STRONG> with a fixed number of parameters,
rather than a variable argument list.
- This implementation uses a variable argument list, but can be con-
- figured to use the fixed-parameter list. Portable applications
+ 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.
In response to review comments by Thomas E. Dickey, X/Open Curses
- Issue 7 proposed the <B>tiparm</B> function in mid-2009.
+ Issue 7 proposed the <STRONG>tiparm</STRONG> function in mid-2009.
+
+ While <STRONG>tiparm</STRONG> is always provided in ncurses, the older form is only
+ available as a build-time configuration option. If not specially
+ configured, <STRONG>tparm</STRONG> is the same as <STRONG>tiparm</STRONG>.
+
+ Both forms of <STRONG>tparm</STRONG> have drawbacks:
+
+ <STRONG>o</STRONG> Most of the calls to <STRONG>tparm</STRONG> use only one or two parameters. Passing
+ nine on each call is awkward.
+
+ Using <STRONG>long</STRONG> for the numeric parameter type is a workaround to make
+ the parameter use the same amount of stack as a pointer. That
+ approach dates back to the mid-1980s, before C was standardized.
+ Since then, there is a standard (and pointers are not required to
+ fit in a long).
+
+ <STRONG>o</STRONG> Providing the right number of parameters for a variadic function
+ such as <STRONG>tiparm</STRONG> can be a problem, in particular for string
+ parameters. However, only a few terminfo capabilities use string
+ parameters (e.g., the ones used for programmable function keys).
+
+ The ncurses library checks usage of these capabilities, and returns
+ an error if the capability mishandles string parameters. But it
+ cannot check if a calling program provides strings in the right
+ places for the <STRONG>tparm</STRONG> calls.
+
+ The <STRONG><A HREF="tput.1.html">tput(1)</A></STRONG> program checks its use of these capabilities with a
+ table, so that it calls <STRONG>tparm</STRONG> correctly.
</PRE><H3><a name="h3-Special-TERM-treatment">Special TERM treatment</a></H3><PRE>
If configured to use the terminal-driver, e.g., for the MinGW port,
- <B>o</B> <B>setupterm</B> interprets a missing/empty TERM variable as the special
+ <STRONG>o</STRONG> <STRONG>setupterm</STRONG> interprets a missing/empty <EM>TERM</EM> variable as the special
value "unknown".
- <B>o</B> <B>setupterm</B> allows explicit use of the the windows console driver by
- checking if $TERM is set to "#win32con" or an abbreviation of that
+ SVr4 curses uses the special value "dumb".
+
+ The difference between the two is that the former uses the <STRONG>gn</STRONG>
+ (<STRONG>generic_type</STRONG>) terminfo capability, while the latter does not. A
+ generic terminal is unsuitable for full-screen applications.
+
+ <STRONG>o</STRONG> <STRONG>setupterm</STRONG> allows explicit use of the the windows console driver by
+ checking if <STRONG>$TERM</STRONG> is set to "#win32con" or an abbreviation of that
string.
</PRE><H3><a name="h3-Other-portability-issues">Other portability issues</a></H3><PRE>
- 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 X/Open Curses semantics.
+ 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 X/Open 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>.
At least one implementation of X/Open Curses (Solaris) returns a value
- other than <B>OK</B>/<B>ERR</B> from <B>tputs</B>. That returns the length of the string,
+ other than <STRONG>OK</STRONG>/<STRONG>ERR</STRONG> from <STRONG>tputs</STRONG>. That returns the length of the string,
and does no error-checking.
- X/Open notes that after calling <B>mvcur</B>, the curses state may not match
- the actual terminal state, and that an application should touch and re-
- fresh the window before resuming normal curses calls. Both <B>ncurses</B> and
- System V Release 4 curses implement <B>mvcur</B> using the SCREEN data allo-
- cated 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.
+ X/Open notes that after calling <STRONG>mvcur</STRONG>, 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 <STRONG>ncurses</STRONG>
+ 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.
- X/Open states that the old location must be given for <B>mvcur</B>. This im-
- plementation allows the caller to use -1's for the old ordinates. In
+ X/Open states that the old location must be given for <STRONG>mvcur</STRONG>. This
+ implementation allows the caller to use -1's for the old ordinates. In
that case, the old location is unknown.
+</PRE><H2><a name="h2-HISTORY">HISTORY</a></H2><PRE>
+ SVr2 introduced the terminfo feature. Its programming manual mentioned
+ the following low-level functions.
+
+ <STRONG>Function</STRONG> <STRONG>Description</STRONG>
+ ------------------------------------------------------------------------
+ <STRONG>fixterm</STRONG> restore tty to "in curses" state
+ <STRONG>gettmode</STRONG> establish current tty modes
+ <STRONG>mvcur</STRONG> low level cursor motion
+
+ <STRONG>putp</STRONG> utility function that uses <STRONG>tputs</STRONG> to send characters via
+ <STRONG>putchar</STRONG>.
+ <STRONG>resetterm</STRONG> set tty modes to "out of curses" state
+ <STRONG>resetty</STRONG> reset tty flags to stored value
+ <STRONG>saveterm</STRONG> save current modes as "in curses" state
+ <STRONG>savetty</STRONG> store current tty flags
+ <STRONG>setterm</STRONG> establish terminal with given type
+ <STRONG>setupterm</STRONG> establish terminal with given type
+ <STRONG>tparm</STRONG> instantiate a string expression with parameters
+ <STRONG>tputs</STRONG> apply padding information to a string
+ <STRONG>vidattr</STRONG> like <STRONG>vidputs</STRONG>, but outputs through <STRONG>putchar</STRONG>
+ <STRONG>vidputs</STRONG> output a string to put terminal in a specified video
+ attribute mode
+
+ The programming manual also mentioned functions provided for <EM>termcap</EM>
+ compatibility (commenting that they "may go away at a later date").
+
+ <STRONG>Function</STRONG> <STRONG>Description</STRONG>
+ ------------------------------------------------------------------------
+ <STRONG>tgetent</STRONG> look up <EM>termcap</EM> entry for given <EM>name</EM>
+ <STRONG>tgetflag</STRONG> get boolean entry for given <EM>id</EM>
+ <STRONG>tgetnum</STRONG> get numeric entry for given <EM>id</EM>
+ <STRONG>tgetstr</STRONG> get string entry for given <EM>id</EM>
+ <STRONG>tgoto</STRONG> apply parameters to given capability
+ <STRONG>tputs</STRONG> apply padding to capability, calling a function to put
+ characters
+
+ Early terminfo programs obtained capability values from the <STRONG>TERMINAL</STRONG>
+ structure initialized by <STRONG>setupterm</STRONG>.
+
+ SVr3 extended terminfo by adding functions to retrieve capability
+ values (like the termcap interface), and reusing <STRONG>tgoto</STRONG> and <STRONG>tputs</STRONG>:
+
+ <STRONG>Function</STRONG> <STRONG>Description</STRONG>
+ ------------------------------------------------------------------------
+ <STRONG>tigetflag</STRONG> get boolean entry for given <EM>id</EM>
+ <STRONG>tigetnum</STRONG> get numeric entry for given <EM>id</EM>
+ <STRONG>tigetstr</STRONG> get string entry for given <EM>id</EM>
+
+ SVr3 also replaced several of the SVr2 <EM>terminfo</EM> functions which had no
+ counterpart in the <EM>termcap</EM> interface, documenting them as obsolete.
+
+ <STRONG>Function</STRONG> <STRONG>Replaced</STRONG> <STRONG>by</STRONG>
+ ------------------------------------------------------------------------
+ crmode cbreak
+ fixterm reset_prog_mode
+ gettmode <EM>n/a</EM>
+ nocrmode nocbreak
+ resetterm reset_shell_mode
+ saveterm def_prog_mode
+ setterm setupterm
+
+ SVr3 kept the <STRONG>mvcur</STRONG>, <STRONG>vidattr</STRONG> and <STRONG>vidputs</STRONG> functions, along with <STRONG>putp</STRONG>,
+ <STRONG>tparm</STRONG> and <STRONG>tputs</STRONG>. The latter were needed to support padding, and
+ handling functions such as <STRONG>vidattr</STRONG> (which used more than the two
+ parameters supported by <STRONG>tgoto</STRONG>).
+
+ SVr3 introduced the functions for switching between terminal
+ descriptions, e.g., <STRONG>set_curterm</STRONG>. Some of that was incremental
+ improvements to the SVr2 library:
+
+ <STRONG>o</STRONG> The <STRONG>TERMINAL</STRONG> type definition was introduced in SVr3.01, for the
+ <STRONG>term</STRONG> structure provided in SVr2.
+
+ <STRONG>o</STRONG> The various global variables such as <STRONG>boolnames</STRONG> were mentioned in
+ the programming manual at this point, though the variables were
+ provided in SVr2.
+
+ SVr4 added the <STRONG>vid_attr</STRONG> and <STRONG>vid_puts</STRONG> functions.
+
+ There are other low-level functions declared in the <EM>curses</EM> header files
+ on Unix systems, but none were documented. The functions marked
+ "obsolete" remained in use by the Unix <STRONG>vi(1)</STRONG> editor.
+
+
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
- <B><A HREF="curses.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><A HREF="curs_termcap.3X.html">curs_termcap(3X)</A></B>,
- <B><A HREF="curs_variables.3X.html">curs_variables(3X)</A></B>, <B><A HREF="term_variables.3X.html">term_variables(3X)</A></B>, <B>putc(3)</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><A HREF="curs_memleaks.3x.html">curs_memleaks(3x)</A></STRONG>,
+ <STRONG><A HREF="curs_termcap.3x.html">curs_termcap(3x)</A></STRONG>, <STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG>, <STRONG>putc(3)</STRONG>, <STRONG><A HREF="term_variables.3x.html">term_variables(3x)</A></STRONG>,
+ <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>
- <B><A HREF="curs_terminfo.3X.html">curs_terminfo(3X)</A></B>
+ncurses 6.4 2023-12-02 <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG>
</PRE>
<div class="nav">
<ul>
<li><a href="#h3-Output-Functions">Output Functions</a></li>
<li><a href="#h3-Terminal-Capability-Functions">Terminal Capability Functions</a></li>
<li><a href="#h3-Terminal-Capability-Names">Terminal Capability Names</a></li>
+<li><a href="#h3-Releasing-Memory">Releasing Memory</a></li>
</ul>
</li>
-<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a>
-<ul>
-<li><a href="#h3-Compatibility-macros">Compatibility macros</a></li>
-</ul>
-</li>
-<li><a href="#h2-HISTORY">HISTORY</a></li>
+<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
+<li><a href="#h2-NOTES">NOTES</a></li>
+<li><a href="#h2-EXTENSIONS">EXTENSIONS</a></li>
<li><a href="#h2-PORTABILITY">PORTABILITY</a>
<ul>
-<li><a href="#h3-Legacy-functions">Legacy functions</a></li>
+<li><a href="#h3-Compatibility-macros">Compatibility macros</a></li>
<li><a href="#h3-Legacy-data">Legacy data</a></li>
<li><a href="#h3-Output-buffering">Output buffering</a></li>
<li><a href="#h3-Function-prototypes">Function prototypes</a></li>
<li><a href="#h3-Other-portability-issues">Other portability issues</a></li>
</ul>
</li>
+<li><a href="#h2-HISTORY">HISTORY</a></li>
<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
</ul>
</div>
projects / ncurses.git / blobdiff