mirror of
https://github.com/freebsd/freebsd-src
synced 2024-10-15 21:05:08 +00:00
109 lines
4.3 KiB
Plaintext
109 lines
4.3 KiB
Plaintext
.\"***************************************************************************
|
|
.\" Copyright 2018-2023,2024 Thomas E. Dickey *
|
|
.\" Copyright 1999-2010,2016 Free Software Foundation, Inc. *
|
|
.\" *
|
|
.\" 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. *
|
|
.\"***************************************************************************
|
|
.\"
|
|
.\" Author: Thomas E. Dickey 1999-on
|
|
.\"
|
|
.\" $Id: curs_extend.3x,v 1.46 2024/03/16 15:35:01 tom Exp $
|
|
.TH curs_extend 3X 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls"
|
|
.ie \n(.g \{\
|
|
.ds `` \(lq
|
|
.ds '' \(rq
|
|
.\}
|
|
.el \{\
|
|
.ie t .ds `` ``
|
|
.el .ds `` ""
|
|
.ie t .ds '' ''
|
|
.el .ds '' ""
|
|
.\}
|
|
.SH NAME
|
|
\fB\%curses_version\fP,
|
|
\fB\%use_extended_names\fP \-
|
|
miscellaneous \fIcurses\fR extensions
|
|
.SH SYNOPSIS
|
|
.nf
|
|
\fB#include <curses.h>
|
|
.PP
|
|
\fBconst char * curses_version(void);
|
|
\fBint use_extended_names(bool \fIenable\fP);
|
|
.fi
|
|
.SH DESCRIPTION
|
|
These functions are extensions to the curses library
|
|
which do not fit easily into other categories.
|
|
.SS curses_version
|
|
Use \fBcurses_version\fP
|
|
to get the version number, including patch level of the library,
|
|
prefixed by \*(``ncurses\*('', e.g.,
|
|
.RS
|
|
.sp
|
|
.B ncurses 5.0.19991023
|
|
.RE
|
|
.SS use_extended_names
|
|
The \fBuse_extended_names\fP
|
|
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.
|
|
Normally these names are available for use, since the essential decision
|
|
is made by using the \fB\-x\fP option of \fB@TIC@\fP to compile
|
|
extended terminal definitions.
|
|
However you can disable this feature
|
|
to ensure compatibility with other implementations of curses.
|
|
.SH RETURN VALUE
|
|
\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.
|
|
.SH EXTENSIONS
|
|
These functions are \fB\%ncurses\fP(3X) extensions,
|
|
and are not found in SVr4
|
|
.IR curses ,
|
|
4.4BSD
|
|
.IR curses ,
|
|
or any other previous curses implementation.
|
|
.SH PORTABILITY
|
|
Applications employing
|
|
.I \%ncurses
|
|
extensions should condition their use on the visibility of the
|
|
.B \%NCURSES_VERSION
|
|
preprocessor macro.
|
|
.SH AUTHORS
|
|
Thomas Dickey.
|
|
.SH SEE ALSO
|
|
\fB\%curs_getch\fP(3X),
|
|
\fB\%curs_mouse\fP(3X),
|
|
\fB\%curs_print\fP(3X),
|
|
\fB\%curs_util\fP(3X),
|
|
\fB\%default_colors\fP(3X),
|
|
\fB\%define_key\fP(3X),
|
|
\fB\%keybound\fP(3X),
|
|
\fB\%keyok\fP(3X),
|
|
\fB\%resizeterm\fP(3X),
|
|
\fB\%wresize\fP(3X)
|