diff options
Diffstat (limited to 'doc/html/man/curs_extend.3x.html')
| -rw-r--r-- | doc/html/man/curs_extend.3x.html | 73 |
1 files changed, 40 insertions, 33 deletions
diff --git a/doc/html/man/curs_extend.3x.html b/doc/html/man/curs_extend.3x.html index e8b3a4682f73..9c163a0901a3 100644 --- a/doc/html/man/curs_extend.3x.html +++ b/doc/html/man/curs_extend.3x.html @@ -1,6 +1,6 @@ <!-- **************************************************************************** - * Copyright 2018-2023,2024 Thomas E. Dickey * + * Copyright 2018-2024,2025 Thomas E. Dickey * * Copyright 1999-2010,2016 Free Software Foundation, Inc. * * * * Permission is hereby granted, free of charge, to any person obtaining a * @@ -28,88 +28,94 @@ * authorization. * **************************************************************************** * Author: Thomas E. Dickey 1999-on - * @Id: curs_extend.3x,v 1.46 2024/03/16 15:35:01 tom Exp @ + * @Id: curs_extend.3x,v 1.67 2025/11/12 00:46:51 tom Exp @ --> <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <HTML> <HEAD> <meta http-equiv="Content-Type" content="text/html; charset=us-ascii"> <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts"> -<TITLE>curs_extend 3x 2024-03-16 ncurses 6.5 Library calls</TITLE> +<TITLE>curs_extend 3x 2025-11-11 ncurses 6.6 Library calls</TITLE> <link rel="author" href="mailto:bug-ncurses@gnu.org"> </HEAD> <BODY> -<H1 class="no-header">curs_extend 3x 2024-03-16 ncurses 6.5 Library calls</H1> +<H1 class="no-header">curs_extend 3x 2025-11-11 ncurses 6.6 Library calls</H1> <PRE> <STRONG><A HREF="curs_extend.3x.html">curs_extend(3x)</A></STRONG> Library calls <STRONG><A HREF="curs_extend.3x.html">curs_extend(3x)</A></STRONG> - - </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE> - <STRONG>curses_version</STRONG>, <STRONG>use_extended_names</STRONG> - miscellaneous <EM>curses</EM> extensions + <STRONG>curses_version</STRONG>, <STRONG>use_extended_names</STRONG> - miscellaneous <EM>ncurses</EM> extensions </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE> <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>curses_version(void);</STRONG> - <STRONG>int</STRONG> <STRONG>use_extended_names(bool</STRONG> <EM>enable</EM><STRONG>);</STRONG> + <STRONG>int</STRONG> <STRONG>use_extended_names(bool</STRONG> <EM>bf</EM><STRONG>);</STRONG> </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE> - These functions are extensions to the curses library which do not fit - easily into other categories. + These <EM>ncurses</EM> extensions to the <EM>curses</EM> library do not fit easily into + other functional categories. </PRE><H3><a name="h3-curses_version">curses_version</a></H3><PRE> - Use <STRONG>curses_version</STRONG> to get the version number, including patch level of - the library, prefixed by "ncurses", e.g., - - <STRONG>ncurses</STRONG> <STRONG>5.0.19991023</STRONG> + <STRONG>curses_version</STRONG> returns a pointer to a string containing the library's + name and version number, including its patch level, for example + "ncurses 6.5.20240720". </PRE><H3><a name="h3-use_extended_names">use_extended_names</a></H3><PRE> - The <STRONG>use_extended_names</STRONG> 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 <STRONG>-x</STRONG> option of <STRONG>tic</STRONG> to compile - extended terminal definitions. However you can disable this feature to - ensure compatibility with other implementations of curses. + <STRONG>use_extended_names</STRONG> configures whether the library recognizes user- + defined or nonstandard <EM>terminfo</EM> capability names that may be compiled + into terminal type descriptions via the <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG> or + <STRONG><A HREF="curs_termcap.3x.html">curs_termcap(3x)</A></STRONG> interfaces. Normally these names are available for + use, since the essential decision is made through use of <STRONG><A HREF="tic.1m.html">tic(1)</A></STRONG>'s <STRONG>-x</STRONG> + option to include such extensions in terminal type descriptions. + <STRONG>use_extended_names(FALSE)</STRONG> prevents <EM>ncurses</EM> from recognizing these + capabilities to ensure compatibility with other implementations of + <EM>curses</EM>. </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE> - <STRONG>curses_version</STRONG> returns a pointer to static memory; you should not free - this in your application. + <STRONG>curses_version</STRONG> returns a constant string. + + <STRONG>use_extended_names</STRONG> returns the previous state of extended capability + name recognition, allowing you to save this property and restore it. - <STRONG>use_extended_names</STRONG> returns the previous state, allowing you to save - this and restore it. + +</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE> + The pointer returned by <STRONG>curses_version</STRONG> corresponds to statically + allocated memory; do not attempt to <STRONG>free(3)</STRONG> it. </PRE><H2><a name="h2-EXTENSIONS">EXTENSIONS</a></H2><PRE> - These functions are <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG> extensions, and are not found in SVr4 - <EM>curses</EM>, 4.4BSD <EM>curses</EM>, or any other previous curses implementation. + These functions are <EM>ncurses</EM> extensions, and are not found in SVr4 + <EM>curses</EM>, 4.4BSD <EM>curses</EM>, or any other previous <EM>curses</EM> implementation. </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE> Applications employing <EM>ncurses</EM> extensions should condition their use on the visibility of the <STRONG>NCURSES_VERSION</STRONG> preprocessor macro. + NetBSD 9 added a <EM>curses</EM><STRONG>_</STRONG><EM>version</EM> function that intentionally returns a + string devoid of version information. + </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE> - Thomas Dickey. + Thomas Dickey </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE> - <STRONG><A HREF="curs_getch.3x.html">curs_getch(3x)</A></STRONG>, <STRONG><A HREF="curs_mouse.3x.html">curs_mouse(3x)</A></STRONG>, <STRONG><A HREF="curs_print.3x.html">curs_print(3x)</A></STRONG>, <STRONG><A HREF="curs_util.3x.html">curs_util(3x)</A></STRONG>, - <STRONG><A HREF="default_colors.3x.html">default_colors(3x)</A></STRONG>, <STRONG><A HREF="define_key.3x.html">define_key(3x)</A></STRONG>, <STRONG><A HREF="keybound.3x.html">keybound(3x)</A></STRONG>, <STRONG><A HREF="keyok.3x.html">keyok(3x)</A></STRONG>, - <STRONG><A HREF="resizeterm.3x.html">resizeterm(3x)</A></STRONG>, <STRONG><A HREF="wresize.3x.html">wresize(3x)</A></STRONG> - + <EM>ncurses</EM> offers several other extensions to the X/Open Curses API. + <STRONG><A HREF="curs_getch.3x.html">curs_getch(3x)</A></STRONG>, <STRONG><A HREF="curs_inopts.3x.html">curs_inopts(3x)</A></STRONG>, <STRONG><A HREF="curs_mouse.3x.html">curs_mouse(3x)</A></STRONG>, <STRONG><A HREF="curs_print.3x.html">curs_print(3x)</A></STRONG>, + <STRONG><A HREF="curs_util.3x.html">curs_util(3x)</A></STRONG>, <STRONG><A HREF="default_colors.3x.html">default_colors(3x)</A></STRONG>, <STRONG><A HREF="define_key.3x.html">define_key(3x)</A></STRONG>, <STRONG><A HREF="keybound.3x.html">keybound(3x)</A></STRONG>, + <STRONG><A HREF="keyok.3x.html">keyok(3x)</A></STRONG>, <STRONG><A HREF="new_pair.3x.html">new_pair(3x)</A></STRONG>, <STRONG><A HREF="resizeterm.3x.html">resizeterm(3x)</A></STRONG>, <STRONG><A HREF="wresize.3x.html">wresize(3x)</A></STRONG> -ncurses 6.5 2024-03-16 <STRONG><A HREF="curs_extend.3x.html">curs_extend(3x)</A></STRONG> +ncurses 6.6 2025-11-11 <STRONG><A HREF="curs_extend.3x.html">curs_extend(3x)</A></STRONG> </PRE> <div class="nav"> <ul> @@ -122,6 +128,7 @@ ncurses 6.5 2024-03-16 <STRONG><A HREF=" </ul> </li> <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li> +<li><a href="#h2-NOTES">NOTES</a></li> <li><a href="#h2-EXTENSIONS">EXTENSIONS</a></li> <li><a href="#h2-PORTABILITY">PORTABILITY</a></li> <li><a href="#h2-AUTHORS">AUTHORS</a></li> |