summaryrefslogtreecommitdiffstats
path: root/upstream/archlinux/man3/curs_extend.3x
diff options
context:
space:
mode:
Diffstat (limited to 'upstream/archlinux/man3/curs_extend.3x')
-rw-r--r--upstream/archlinux/man3/curs_extend.3x81
1 files changed, 46 insertions, 35 deletions
diff --git a/upstream/archlinux/man3/curs_extend.3x b/upstream/archlinux/man3/curs_extend.3x
index 851e4768..bb34777e 100644
--- a/upstream/archlinux/man3/curs_extend.3x
+++ b/upstream/archlinux/man3/curs_extend.3x
@@ -1,5 +1,5 @@
.\"***************************************************************************
-.\" Copyright 2018-2021,2022 Thomas E. Dickey *
+.\" 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 *
@@ -29,27 +29,33 @@
.\"
.\" Author: Thomas E. Dickey 1999-on
.\"
-.\" $Id: curs_extend.3x,v 1.28 2022/02/12 20:07:29 tom Exp $
-.TH curs_extend 3X ""
-.ie \n(.g .ds `` \(lq
-.el .ds `` ``
-.ie \n(.g .ds '' \(rq
-.el .ds '' ''
+.\" $Id: curs_extend.3x,v 1.46 2024/03/16 15:35:01 tom Exp $
+.TH curs_extend 3X 2024-03-16 "ncurses 6.5" "Library calls"
+.ie \n(.g \{\
+.ds `` \(lq
+.ds '' \(rq
+.\}
+.el \{\
+.ie t .ds `` ``
+.el .ds `` ""
+.ie t .ds '' ''
+.el .ds '' ""
+.\}
.SH NAME
-\fBcurses_version\fP,
-\fBuse_extended_names\fP \- miscellaneous curses extensions
-.
+\fB\%curses_version\fP,
+\fB\%use_extended_names\fP \-
+miscellaneous \fIcurses\fR extensions
.SH SYNOPSIS
-\fB#include <curses.h>\fP
-.sp
-\fBconst char * curses_version(void);\fP
-.br
-\fBint use_extended_names(bool \fIenable\fB);\fR
+.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
-.PP
Use \fBcurses_version\fP
to get the version number, including patch level of the library,
prefixed by \*(``ncurses\*('', e.g.,
@@ -58,7 +64,6 @@ prefixed by \*(``ncurses\*('', e.g.,
.B ncurses 5.0.19991023
.RE
.SS use_extended_names
-.PP
The \fBuse_extended_names\fP
function controls whether the calling application
is able to use user-defined or nonstandard names
@@ -70,28 +75,34 @@ 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 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
-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\fP(3X),
-\fBcurs_mouse\fP(3X),
-\fBcurs_print\fP(3X),
-\fBcurs_util\fP(3X),
-\fBdefault_colors\fP(3X),
-\fBdefine_key\fP(3X),
-\fBkeybound\fP(3X),
-\fBkeyok\fP(3X),
-\fBresizeterm\fP(3X),
-\fBwresize\fP(3X).
-.SH AUTHOR
+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)