ncurses 6.2 - patch 20201205
[ncurses.git] / man / curs_extend.3x
index a5f187f0221748043e367a8408905740bac196bf..52ba27d07fb3c928f1eeb6e090da6ba788523314 100644 (file)
@@ -1,5 +1,6 @@
 .\"***************************************************************************
-.\" Copyright (c) 1999-2003,2004 Free Software Foundation, Inc.              *
+.\" Copyright 2018,2020 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            *
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" Author: Thomas E. Dickey 1999
+.\" Author: Thomas E. Dickey 1999-on
 .\"
-.\" $Id: curs_extend.3x,v 1.13 2004/07/05 13:16:08 tom Exp $
+.\" $Id: curs_extend.3x,v 1.24 2020/10/24 09:37:07 tom Exp $
 .TH curs_extend 3X ""
 .SH NAME
 \fBcurses_version\fP,
 \fBuse_extended_names\fP \- miscellaneous curses extensions
-
+.
 .SH SYNOPSIS
 \fB#include <curses.h>\fP
-
+.sp
 \fBconst char * curses_version(void);\fP
 .br
-\fBint use_extended_names(bool enable);\fP
+\fBint use_extended_names(bool \fP\fIenable\fP\fB);\fP
 .SH DESCRIPTION
 These functions are extensions to the curses library
 which do not fit easily into other categories.
+.SS curses_version
 .PP
-Use
-.I curses_version()
+Use \fBcurses_version\fP
 to get the version number, including patch level of the library, e.g.,
 .B 5.0.19991023
+.SS use_extended_names
 .PP
-The
-.I 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 \fItic\fP to compile
+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
+.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.
 .SH PORTABILITY
-These routines are specific to ncurses.  They were not supported on
-Version 7, BSD or System V implementations.  It is recommended that
+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(3X),
 \fBcurs_mouse\fR(3X),
 \fBcurs_print\fR(3X),
+\fBcurs_util\fR(3X),
 \fBdefault_colors\fR(3X),
 \fBdefine_key\fR(3X),
 \fBkeybound\fR(3X),
@@ -76,9 +87,3 @@ any code depending on them be conditioned using NCURSES_VERSION.
 \fBwresize\fR(3X).
 .SH AUTHOR
 Thomas Dickey.
-.\"#
-.\"# The following sets edit modes for GNU EMACS
-.\"# Local Variables:
-.\"# mode:nroff
-.\"# fill-column:79
-.\"# End: