X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_extend.3x.html;h=f3d396ec3ca430cc16f52f026c241d6138a7e135;hb=HEAD;hp=8dc4cf7594347a972d33051914055666a2d2ab0e;hpb=d90067f9008bb8338a77c1ed519bc108c275ed04;p=ncurses.git diff --git a/doc/html/man/curs_extend.3x.html b/doc/html/man/curs_extend.3x.html index 8dc4cf75..e2a9234f 100644 --- a/doc/html/man/curs_extend.3x.html +++ b/doc/html/man/curs_extend.3x.html @@ -1,6 +1,6 @@ -curs_extend 3x 2023-12-16 ncurses 6.4 Library calls +curs_extend 3x 2024-09-14 ncurses 6.5 Library calls -

curs_extend 3x 2023-12-16 ncurses 6.4 Library calls

curs_extend 3x 2024-09-14 ncurses 6.5 Library calls

 curs_extend(3x)                  Library calls                 curs_extend(3x)
 
@@ -55,57 +55,68 @@
        #include <curses.h>
 
        const char * curses_version(void);
-       int use_extended_names(bool enable);
+       int use_extended_names(bool bf);

DESCRIPTION

-       These  functions  are extensions to the curses library which do not fit
-       easily into other categories.
+       These  ncurses  extensions to the curses library do not fit easily into
+       other functional categories.

curses_version

-       Use curses_version to get the version number, including patch level  of
-       the library, prefixed by "ncurses", e.g.,
-
-              ncurses 5.0.19991023
+       curses_version returns a pointer to a string containing  the  library's
+       name  and  version  number,  including  its  patch  level,  for example
+       "ncurses 6.5.20240720".

use_extended_names

-       The   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 decision is made by using the -x option of tic to compile
-       extended terminal definitions.  However you can disable this feature to
-       ensure compatibility with other implementations of curses.
+       use_extended_names configures  whether  the  library  recognizes  user-
+       defined  or  nonstandard terminfo capability names that may be compiled
+       into  terminal  type  descriptions   via   the   curs_terminfo(3x)   or
+       curs_termcap(3x)  interfaces.   Normally  these names are available for
+       use, since the essential decision is made through use  of  tic(1)'s  -x
+       option  to  include  such  extensions  in  terminal  type descriptions.
+       use_extended_names  can  prevent   ncurses   from   recognizing   these
+       capabilities  to  ensure  compatibility  with  other implementations of
+       curses.

RETURN VALUE

-       curses_version  returns a pointer to static memory; you should not free
-       this in your application.
+       curses_version returns a constant string.
+
+       use_extended_names returns the previous state  of  extended  capability
+       name recognition, allowing you to save this property and restore it.
+
 
-       use_extended_names returns the previous state,  allowing  you  to  save
-       this and restore it.
+

NOTES

+       The  pointer  returned  by  curses_version  corresponds  to  statically
+       allocated memory; do not attempt to free(3) it.
+
+
+

EXTENSIONS

+       These functions are ncurses(3x) extensions, and are not found  in  SVr4
+       curses, 4.4BSD curses, or any other previous curses implementation.

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.
+       Applications employing ncurses extensions should condition their use on
+       the visibility of the NCURSES_VERSION preprocessor macro.

AUTHORS

-       Thomas Dickey.
+       Thomas Dickey