ncurses 6.1 - patch 20191130
[ncurses.git] / doc / html / man / curs_extend.3x.html
1 <!-- 
2   ****************************************************************************
3   * Copyright (c) 1999-2016,2018 Free Software Foundation, Inc.              *
4   *                                                                          *
5   * Permission is hereby granted, free of charge, to any person obtaining a  *
6   * copy of this software and associated documentation files (the            *
7   * "Software"), to deal in the Software without restriction, including      *
8   * without limitation the rights to use, copy, modify, merge, publish,      *
9   * distribute, distribute with modifications, sublicense, and/or sell       *
10   * copies of the Software, and to permit persons to whom the Software is    *
11   * furnished to do so, subject to the following conditions:                 *
12   *                                                                          *
13   * The above copyright notice and this permission notice shall be included  *
14   * in all copies or substantial portions of the Software.                   *
15   *                                                                          *
16   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
17   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
18   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
19   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
20   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
21   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
22   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
23   *                                                                          *
24   * Except as contained in this notice, the name(s) of the above copyright   *
25   * holders shall not be used in advertising or otherwise to promote the     *
26   * sale, use or other dealings in this Software without prior written       *
27   * authorization.                                                           *
28   ****************************************************************************
29   * Author: Thomas E. Dickey 1999-on
30   * @Id: curs_extend.3x,v 1.22 2018/07/28 21:34:06 tom Exp @
31 -->
32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
33 <HTML>
34 <HEAD>
35 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
36 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
37 <TITLE>curs_extend 3x</TITLE>
38 <link rel="author" href="mailto:bug-ncurses@gnu.org">
39 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
40 </HEAD>
41 <BODY>
42 <H1 class="no-header">curs_extend 3x</H1>
43 <PRE>
44 <STRONG><A HREF="curs_extend.3x.html">curs_extend(3x)</A></STRONG>                                                <STRONG><A HREF="curs_extend.3x.html">curs_extend(3x)</A></STRONG>
45
46
47
48
49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
50        <STRONG>curses_version</STRONG>, <STRONG>use_extended_names</STRONG> - miscellaneous curses extensions
51
52
53 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
54        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
55
56        <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>curses_version(void);</STRONG>
57        <STRONG>int</STRONG> <STRONG>use_extended_names(bool</STRONG> <STRONG>enable);</STRONG>
58
59
60 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
61        These  functions  are extensions to the curses library which do not fit
62        easily into other categories.
63
64
65 </PRE><H3><a name="h3-curses_version">curses_version</a></H3><PRE>
66        Use <STRONG>curses_version</STRONG> to get the version number, including patch level  of
67        the library, e.g., <STRONG>5.0.19991023</STRONG>
68
69
70 </PRE><H3><a name="h3-use_extended_names">use_extended_names</a></H3><PRE>
71        The  <STRONG>use_extended_names</STRONG>  function controls whether the calling applica-
72        tion is able to use user-defined or nonstandard names which may be com-
73        piled  into the terminfo description, i.e., via the terminfo or termcap
74        interfaces.  Normally these names are  available  for  use,  since  the
75        essential  decision  is  made  by using the <STRONG>-x</STRONG> option of <STRONG>tic</STRONG> to compile
76        extended terminal definitions.  However you can disable this feature to
77        ensure compatibility with other implementations of curses.
78
79
80 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
81        <STRONG>curses_version</STRONG>  returns a pointer to static memory; you should not free
82        this in your application.
83
84        <STRONG>use_extended_names</STRONG> returns the previous state,  allowing  you  to  save
85        this and restore it.
86
87
88 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
89        These  routines  are  specific  to ncurses.  They were not supported on
90        Version 7, BSD or System V implementations.  It is recommended that any
91        code depending on them be conditioned using NCURSES_VERSION.
92
93
94 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
95        <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>,
96        <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>,
97        <STRONG><A HREF="resizeterm.3x.html">resizeterm(3x)</A></STRONG>, <STRONG><A HREF="wresize.3x.html">wresize(3x)</A></STRONG>.
98
99
100 </PRE><H2><a name="h2-AUTHOR">AUTHOR</a></H2><PRE>
101        Thomas Dickey.
102
103
104
105                                                                <STRONG><A HREF="curs_extend.3x.html">curs_extend(3x)</A></STRONG>
106 </PRE>
107 <div class="nav">
108 <ul>
109 <li><a href="#h2-NAME">NAME</a></li>
110 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
111 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
112 <ul>
113 <li><a href="#h3-curses_version">curses_version</a></li>
114 <li><a href="#h3-use_extended_names">use_extended_names</a></li>
115 </ul>
116 </li>
117 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
118 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
119 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
120 <li><a href="#h2-AUTHOR">AUTHOR</a></li>
121 </ul>
122 </div>
123 </BODY>
124 </HTML>