document ncruses extensions

1 files changed, 89 insertions, 0 deletions

diff --git a/lib/libcurses/curs_extend.3 b/lib/libcurses/curs_extend.3
new file mode 100644
index 00000000000..141b97ec2b3
--- /dev/null
+++ b/lib/libcurses/curs_extend.3
@@ -0,0 +1,89 @@
+.\" $OpenBSD: curs_extend.3,v 1.1 1999/12/28 19:17:43 millert Exp $
+.\"
+.\"***************************************************************************
+.\" Copyright (c) 1999 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 <dickey@clark.net> 1999
+.\"
+.\" $From: curs_extend.3x,v 1.2 1999/12/18 21:57:44 tom Exp $
+.TH use_default_colors 3 ""
+.SH NAME
+\fBcurs_extend\fR \- miscellaneous curses extensions
+..
+.SH SYNOPSIS
+\fB#include <curses.h>\fP
+
+\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.
+.PP
+Use
+.I curses_version()
+to get the version number, including patch level of the library, e.g.,
+.B 5.0.19991023
+.PP
+The
+.I use_extended_names()
+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 descision
+is made by using the \fB-x\fP option of \fItic\fP to compile
+extended terminal definitions.
+However you can disable this feature
+to ensure compatiblity with other implementations of curses
+..
+.SH PORTABILITY
+These routines are specific to ncurses.  They were not supported on
+Version 7, BSD or System V implementations.  It is recommended that
+any code depending on them be conditioned using NCURSES_VERSION.
+..
+.SH SEE ALSO
+\fBcurs_getch\fR(3),
+\fBcurs_mouse\fR(3),
+\fBcurs_print\fR(3),
+\fBdefine_key\fR(3),
+\fBdft_fgbg\fR(3),
+\fBkeybound\fR(3),
+\fBkeyok\fR(3),
+\fBresizeterm\fR(3),
+\fBwresize\fR(3).
+..
+.SH AUTHOR
+Thomas Dickey.
+.\"#
+.\"# The following sets edit modes for GNU EMACS
+.\"# Local Variables:
+.\"# mode:nroff
+.\"# fill-column:79
+.\"# End: