ncurses 6.3 - patch 20211127
[ncurses.git] / doc / html / man / curs_extend.3x.html
1 <!--
2   ****************************************************************************
3   * Copyright 2018-2020,2021 Thomas E. Dickey                                *
4   * Copyright 1999-2010,2016 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   * Author: Thomas E. Dickey 1999-on
31   * @Id: curs_extend.3x,v 1.26 2021/03/13 13:43:05 tom Exp @
32 -->
33 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
34 <HTML>
35 <HEAD>
36 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
37 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
38 <TITLE>curs_extend 3x</TITLE>
39 <link rel="author" href="mailto:bug-ncurses@gnu.org">
40 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
41 </HEAD>
42 <BODY>
43 <H1 class="no-header">curs_extend 3x</H1>
44 <PRE>
45 <STRONG><A HREF="curs_extend.3x.html">curs_extend(3x)</A></STRONG>                                                <STRONG><A HREF="curs_extend.3x.html">curs_extend(3x)</A></STRONG>
46
47
48
49
50 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
51        <STRONG>curses_version</STRONG>, <STRONG>use_extended_names</STRONG> - miscellaneous curses extensions
52
53
54 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
55        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
56
57        <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>curses_version(void);</STRONG>
58        <STRONG>int</STRONG> <STRONG>use_extended_names(bool</STRONG> <EM>enable</EM><STRONG>);</STRONG>
59
60
61 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
62        These  functions  are extensions to the curses library which do not fit
63        easily into other categories.
64
65
66 </PRE><H3><a name="h3-curses_version">curses_version</a></H3><PRE>
67        Use <STRONG>curses_version</STRONG> to get the version number, including patch level  of
68        the library, prefixed by "ncurses", e.g.,
69
70               <STRONG>ncurses</STRONG> <STRONG>5.0.19991023</STRONG>
71
72
73 </PRE><H3><a name="h3-use_extended_names">use_extended_names</a></H3><PRE>
74        The   <STRONG>use_extended_names</STRONG>   function   controls   whether   the  calling
75        application is able to use user-defined or nonstandard names which  may
76        be  compiled  into  the terminfo description, i.e., via the terminfo or
77        termcap interfaces.  Normally these names are available for use,  since
78        the essential decision is made by using the <STRONG>-x</STRONG> option of <STRONG>tic</STRONG> to compile
79        extended terminal definitions.  However you can disable this feature to
80        ensure compatibility with other implementations of curses.
81
82
83 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
84        <STRONG>curses_version</STRONG>  returns a pointer to static memory; you should not free
85        this in your application.
86
87        <STRONG>use_extended_names</STRONG> returns the previous state,  allowing  you  to  save
88        this and restore it.
89
90
91 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
92        These  routines  are  specific  to ncurses.  They were not supported on
93        Version 7, BSD or System V implementations.  It is recommended that any
94        code depending on them be conditioned using NCURSES_VERSION.
95
96
97 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
98        <STRONG><A HREF="curs_getch.3x.html">curs_getch(3x)</A></STRONG>,    <STRONG><A HREF="curs_mouse.3x.html">curs_mouse(3x)</A></STRONG>,    <STRONG><A HREF="curs_print.3x.html">curs_print(3x)</A></STRONG>,    <STRONG><A HREF="curs_util.3x.html">curs_util(3x)</A></STRONG>,
99        <STRONG><A HREF="default_colors.3x.html">default_colors(3x)</A></STRONG>,    <STRONG><A HREF="define_key.3x.html">define_key(3x)</A></STRONG>,     <STRONG><A HREF="keybound.3x.html">keybound(3x)</A></STRONG>,     <STRONG><A HREF="keyok.3x.html">keyok(3x)</A></STRONG>,
100        <STRONG><A HREF="resizeterm.3x.html">resizeterm(3x)</A></STRONG>, <STRONG><A HREF="wresize.3x.html">wresize(3x)</A></STRONG>.
101
102
103 </PRE><H2><a name="h2-AUTHOR">AUTHOR</a></H2><PRE>
104        Thomas Dickey.
105
106
107
108                                                                <STRONG><A HREF="curs_extend.3x.html">curs_extend(3x)</A></STRONG>
109 </PRE>
110 <div class="nav">
111 <ul>
112 <li><a href="#h2-NAME">NAME</a></li>
113 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
114 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
115 <ul>
116 <li><a href="#h3-curses_version">curses_version</a></li>
117 <li><a href="#h3-use_extended_names">use_extended_names</a></li>
118 </ul>
119 </li>
120 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
121 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
122 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
123 <li><a href="#h2-AUTHOR">AUTHOR</a></li>
124 </ul>
125 </div>
126 </BODY>
127 </HTML>