ncurses 6.0 - patch 20170128
[ncurses.git] / doc / html / man / curs_extend.3x.html
1 <!-- 
2   ****************************************************************************
3   * Copyright (c) 1999-2010,2016 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.21 2016/10/15 16:52:48 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 http://invisible-island.net/scripts/readme.html#others_scripts">
37 <TITLE>curs_extend 3x</TITLE>
38 <link rev=made 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
51        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> <STRONG>enable);</STRONG>
59
60
61 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
62        These functions are extensions to the curses library which
63        do not fit 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
68        patch level of the library, e.g., <STRONG>5.0.19991023</STRONG>
69
70
71 </PRE><H3><a name="h3-use_extended_names">use_extended_names</a></H3><PRE>
72        The <STRONG>use_extended_names</STRONG> function controls whether the call-
73        ing application is able to use user-defined or nonstandard
74        names which may be compiled into the terminfo description,
75        i.e.,  via  the  terminfo or termcap interfaces.  Normally
76        these names are available for  use,  since  the  essential
77        decision  is made by using the <STRONG>-x</STRONG> option of <STRONG>tic</STRONG> to compile
78        extended terminal definitions.  However  you  can  disable
79        this  feature to ensure compatibility with other implemen-
80        tations 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
85        should not free this in your application.
86
87        <STRONG>use_extended_names</STRONG>  returns  the  previous state, allowing
88        you to save 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
93        supported  on  Version 7, BSD or System V implementations.
94        It is recommended that any code depending on them be  con-
95        ditioned using NCURSES_VERSION.
96
97
98 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
99        <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>,
100        <STRONG><A HREF="curs_util.3x.html">curs_util(3x)</A></STRONG>,  <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>key-</STRONG>
101        <STRONG><A HREF="keybound.3x.html">bound(3x)</A></STRONG>, <STRONG><A HREF="keyok.3x.html">keyok(3x)</A></STRONG>, <STRONG><A HREF="resizeterm.3x.html">resizeterm(3x)</A></STRONG>, <STRONG><A HREF="wresize.3x.html">wresize(3x)</A></STRONG>.
102
103
104 </PRE><H2><a name="h2-AUTHOR">AUTHOR</a></H2><PRE>
105        Thomas Dickey.
106
107
108
109                                                         <STRONG><A HREF="curs_extend.3x.html">curs_extend(3x)</A></STRONG>
110 </PRE>
111 <div class="nav">
112 <ul>
113 <li><a href="#h2-NAME">NAME</a></li>
114 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
115 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
116 <ul>
117 <li><a href="#h3-curses_version">curses_version</a></li>
118 <li><a href="#h3-use_extended_names">use_extended_names</a></li>
119 </ul>
120 </li>
121 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
122 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
123 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
124 <li><a href="#h2-AUTHOR">AUTHOR</a></li>
125 </ul>
126 </div>
127 </BODY>
128 </HTML>