ncurses 6.2 - patch 20210313

[ncurses.git] / man / curs_extend.3x

diff --git a/man/curs_extend.3x b/man/curs_extend.3x
index 16a3f80b27aa7bd04e6e8a6fd246012320f3379d..800d247d3cd7800249eae4f10a25464cfa212e9f 100644 (file)
--- a/man/curs_extend.3x
+++ b/man/curs_extend.3x
@@ -1,5 +1,6 @@
 .\"***************************************************************************
 .\"***************************************************************************

-.\" Copyright (c) 1999,2000 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            *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
 .\" copy of this software and associated documentation files (the            *


@@ -26,64 +27,71 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"

-.\" Author: Thomas E. Dickey <dickey@clark.net> 1999
+.\" Author: Thomas E. Dickey 1999-on

 .\"
 .\"

-.\" $Id: curs_extend.3x,v 1.4 2000/07/01 16:43:11 tom Exp $
-.TH use_default_colors 3X ""
+.\" $Id: curs_extend.3x,v 1.25 2021/03/13 13:43:05 tom Exp $
+.TH curs_extend 3X ""
+.ie \n(.g .ds `` \(lq
+.el       .ds `` ``
+.ie \n(.g .ds '' \(rq
+.el       .ds '' ''

 .SH NAME
 .SH NAME

-\fBcurs_extend\fR:

 \fBcurses_version\fP,
 \fBuse_extended_names\fP \- miscellaneous curses extensions
 \fBcurses_version\fP,
 \fBuse_extended_names\fP \- miscellaneous curses extensions

-..
+.

 .SH SYNOPSIS
 \fB#include <curses.h>\fP
 .SH SYNOPSIS
 \fB#include <curses.h>\fP

-
+.sp

 \fBconst char * curses_version(void);\fP
 .br
 \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.
 .SH DESCRIPTION
 These functions are extensions to the curses library
 which do not fit easily into other categories.

+.SS curses_version

 .PP
 .PP

-Use
-.I curses_version()
-to get the version number, including patch level of the library, e.g.,
-.B 5.0.19991023
+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

 .PP
 .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.
 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
+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
 extended terminal definitions.
 However you can disable this feature

-to ensure compatiblity with other implementations of curses
-..
+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
 .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.
 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),
 .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),
 \fBdefine_key\fR(3X),

-\fBdft_fgbg\fR(3X),

 \fBkeybound\fR(3X),
 \fBkeyok\fR(3X),
 \fBresizeterm\fR(3X),
 \fBwresize\fR(3X).
 \fBkeybound\fR(3X),
 \fBkeyok\fR(3X),
 \fBresizeterm\fR(3X),
 \fBwresize\fR(3X).

-..

 .SH AUTHOR
 Thomas Dickey.
 .SH AUTHOR
 Thomas Dickey.

-.\"#
-.\"# The following sets edit modes for GNU EMACS
-.\"# Local Variables:
-.\"# mode:nroff
-.\"# fill-column:79
-.\"# End: