ncurses 6.2 - patch 20210213
[ncurses.git] / man / curs_extend.3x
1 .\"***************************************************************************
2 .\" Copyright 2018,2020 Thomas E. Dickey                                     *
3 .\" Copyright 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 .\"
30 .\" Author: Thomas E. Dickey 1999-on
31 .\"
32 .\" $Id: curs_extend.3x,v 1.24 2020/10/24 09:37:07 tom Exp $
33 .TH curs_extend 3X ""
34 .SH NAME
35 \fBcurses_version\fP,
36 \fBuse_extended_names\fP \- miscellaneous curses extensions
37 .
38 .SH SYNOPSIS
39 \fB#include <curses.h>\fP
40 .sp
41 \fBconst char * curses_version(void);\fP
42 .br
43 \fBint use_extended_names(bool \fP\fIenable\fP\fB);\fP
44 .SH DESCRIPTION
45 These functions are extensions to the curses library
46 which do not fit easily into other categories.
47 .SS curses_version
48 .PP
49 Use \fBcurses_version\fP
50 to get the version number, including patch level of the library, e.g.,
51 .B 5.0.19991023
52 .SS use_extended_names
53 .PP
54 The \fBuse_extended_names\fP
55 function controls whether the calling application
56 is able to use user-defined or nonstandard names
57 which may be compiled into the terminfo
58 description, i.e., via the terminfo or termcap interfaces.
59 Normally these names are available for use, since the essential decision
60 is made by using the \fB\-x\fP option of \fB@TIC@\fP to compile
61 extended terminal definitions.
62 However you can disable this feature
63 to ensure compatibility with other implementations of curses.
64 .SH RETURN VALUE
65 .PP
66 \fBcurses_version\fP returns a pointer to static memory; you should not free
67 this in your application.
68 .PP
69 \fBuse_extended_names\fP returns the previous state, allowing you to
70 save this and restore it.
71 .SH PORTABILITY
72 These routines are specific to ncurses.
73 They were not supported on
74 Version 7, BSD or System V implementations.
75 It is recommended that
76 any code depending on them be conditioned using NCURSES_VERSION.
77 .SH SEE ALSO
78 \fBcurs_getch\fR(3X),
79 \fBcurs_mouse\fR(3X),
80 \fBcurs_print\fR(3X),
81 \fBcurs_util\fR(3X),
82 \fBdefault_colors\fR(3X),
83 \fBdefine_key\fR(3X),
84 \fBkeybound\fR(3X),
85 \fBkeyok\fR(3X),
86 \fBresizeterm\fR(3X),
87 \fBwresize\fR(3X).
88 .SH AUTHOR
89 Thomas Dickey.