2000-07-03 09:24:12 +00:00
|
|
|
.\"***************************************************************************
|
2020-02-19 16:58:06 +00:00
|
|
|
.\" Copyright 2018,2020 Thomas E. Dickey *
|
|
|
|
.\" Copyright 1999-2010,2016 Free Software Foundation, Inc. *
|
2000-07-03 09:24:12 +00:00
|
|
|
.\" *
|
|
|
|
.\" Permission is hereby granted, free of charge, to any person obtaining a *
|
|
|
|
.\" copy of this software and associated documentation files (the *
|
|
|
|
.\" "Software"), to deal in the Software without restriction, including *
|
|
|
|
.\" without limitation the rights to use, copy, modify, merge, publish, *
|
|
|
|
.\" distribute, distribute with modifications, sublicense, and/or sell *
|
|
|
|
.\" copies of the Software, and to permit persons to whom the Software is *
|
|
|
|
.\" furnished to do so, subject to the following conditions: *
|
|
|
|
.\" *
|
|
|
|
.\" The above copyright notice and this permission notice shall be included *
|
|
|
|
.\" in all copies or substantial portions of the Software. *
|
|
|
|
.\" *
|
|
|
|
.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
|
|
|
|
.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
|
|
|
|
.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
|
|
|
|
.\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
|
|
|
|
.\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
|
|
|
|
.\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
|
|
|
|
.\" THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
|
|
|
|
.\" *
|
|
|
|
.\" Except as contained in this notice, the name(s) of the above copyright *
|
|
|
|
.\" holders shall not be used in advertising or otherwise to promote the *
|
|
|
|
.\" sale, use or other dealings in this Software without prior written *
|
|
|
|
.\" authorization. *
|
|
|
|
.\"***************************************************************************
|
|
|
|
.\"
|
2007-01-20 07:32:02 +00:00
|
|
|
.\" Author: Thomas E. Dickey 1999-on
|
2000-07-03 09:24:12 +00:00
|
|
|
.\"
|
2020-02-19 16:58:06 +00:00
|
|
|
.\" $Id: curs_extend.3x,v 1.23 2020/02/02 23:34:34 tom Exp $
|
2000-10-11 07:31:01 +00:00
|
|
|
.TH curs_extend 3X ""
|
2000-07-03 09:24:12 +00:00
|
|
|
.SH NAME
|
|
|
|
\fBcurses_version\fP,
|
|
|
|
\fBuse_extended_names\fP \- miscellaneous curses extensions
|
2007-01-20 07:32:02 +00:00
|
|
|
.
|
2000-07-03 09:24:12 +00:00
|
|
|
.SH SYNOPSIS
|
|
|
|
\fB#include <curses.h>\fP
|
2007-01-20 07:32:02 +00:00
|
|
|
.sp
|
2000-07-03 09:24:12 +00:00
|
|
|
\fBconst char * curses_version(void);\fP
|
|
|
|
.br
|
|
|
|
\fBint use_extended_names(bool enable);\fP
|
|
|
|
.SH DESCRIPTION
|
|
|
|
These functions are extensions to the curses library
|
|
|
|
which do not fit easily into other categories.
|
2020-02-07 08:36:41 +00:00
|
|
|
.SS curses_version
|
2000-07-03 09:24:12 +00:00
|
|
|
.PP
|
2020-02-07 08:36:41 +00:00
|
|
|
Use \fBcurses_version\fP
|
2000-07-03 09:24:12 +00:00
|
|
|
to get the version number, including patch level of the library, e.g.,
|
|
|
|
.B 5.0.19991023
|
2020-02-07 08:36:41 +00:00
|
|
|
.SS use_extended_names
|
2000-07-03 09:24:12 +00:00
|
|
|
.PP
|
2020-02-07 08:36:41 +00:00
|
|
|
The \fBuse_extended_names\fP
|
2000-07-03 09:24:12 +00:00
|
|
|
function controls whether the calling application
|
|
|
|
is able to use user-defined or nonstandard names
|
|
|
|
which may be compiled into the terminfo
|
|
|
|
description, i.e., via the terminfo or termcap interfaces.
|
2007-01-20 07:32:02 +00:00
|
|
|
Normally these names are available for use, since the essential decision
|
2014-02-28 19:18:07 +00:00
|
|
|
is made by using the \fB\-x\fP option of \fB@TIC@\fP to compile
|
2000-07-03 09:24:12 +00:00
|
|
|
extended terminal definitions.
|
|
|
|
However you can disable this feature
|
2007-01-20 07:32:02 +00:00
|
|
|
to ensure compatibility with other implementations of curses.
|
2020-02-07 08:36:41 +00:00
|
|
|
.SH RETURN VALUE
|
|
|
|
.PP
|
|
|
|
\fBcurses_version\fP returns a pointer to static memory; you should not free
|
|
|
|
this in your application.
|
|
|
|
.PP
|
|
|
|
\fBuse_extended_names\fP returns the previous state, allowing you to
|
|
|
|
save this and restore it.
|
2000-07-03 09:24:12 +00:00
|
|
|
.SH PORTABILITY
|
2020-02-07 08:36:41 +00:00
|
|
|
These routines are specific to ncurses.
|
|
|
|
They were not supported on
|
|
|
|
Version 7, BSD or System V implementations.
|
|
|
|
It is recommended that
|
2000-07-03 09:24:12 +00:00
|
|
|
any code depending on them be conditioned using NCURSES_VERSION.
|
|
|
|
.SH SEE ALSO
|
|
|
|
\fBcurs_getch\fR(3X),
|
|
|
|
\fBcurs_mouse\fR(3X),
|
|
|
|
\fBcurs_print\fR(3X),
|
2007-12-30 11:08:14 +00:00
|
|
|
\fBcurs_util\fR(3X),
|
2000-10-11 07:31:01 +00:00
|
|
|
\fBdefault_colors\fR(3X),
|
2000-07-03 09:24:12 +00:00
|
|
|
\fBdefine_key\fR(3X),
|
|
|
|
\fBkeybound\fR(3X),
|
|
|
|
\fBkeyok\fR(3X),
|
|
|
|
\fBresizeterm\fR(3X),
|
|
|
|
\fBwresize\fR(3X).
|
|
|
|
.SH AUTHOR
|
|
|
|
Thomas Dickey.
|