X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_memleaks.3x.html;h=f55ca60caae13e3cfd35308d09394fe2b214a807;hp=20cc59d68174eb9637fe904b3158630a12011b64;hb=9f479192e3ca3413d235c66bf058f8cc63764898;hpb=cd142df6d9934f1bda19f5b968cc666291be5072 diff --git a/doc/html/man/curs_memleaks.3x.html b/doc/html/man/curs_memleaks.3x.html index 20cc59d6..f55ca60c 100644 --- a/doc/html/man/curs_memleaks.3x.html +++ b/doc/html/man/curs_memleaks.3x.html @@ -1,6 +1,7 @@ -
- --curs_memleaks(3x) curs_memleaks(3x) +curs_memleaks(3X) curs_memleaks(3X)
- _nc_freeall, _nc_free_and_exit, _nc_free_tinfo - curses memory-leak - checking + exit_curses, exit_terminfo - curses memory-leak checking
- #include <curses.h> + #include <curses.h> + void exit_curses(int code); - void _nc_freeall(void); - void _nc_free_and_exit(int); - void _nc_free_tinfo(int); + #include <term.h> + void exit_terminfo(int code); + + /* deprecated (intentionally not declared in curses.h or term.h) */ + void _nc_freeall(void); + void _nc_free_and_exit(int code); + void _nc_free_tinfo(int code);
- These functions are used to simplify analysis of memory leaks in the - ncurses library. They are normally not available; they must be config- - ured into the library at build time using the --disable-leaks option. - That compiles-in code that frees memory that normally would not be - freed. + These functions are used to simplify analysis of memory leaks in the + ncurses library. Any implementation of curses must not free the memory associated with a - screen, since (even after calling endwin), it must be available for use - in the next call to refresh(3x). There are also chunks of memory held - for performance reasons. That makes it hard to analyze curses applica- - tions for memory leaks. When using the specially configured debugging - version of the ncurses library, applications can call functions which - free those chunks of memory, simplifying the process of memory-leak - checking. - - These functions are named with a "_nc_" prefix because they are not in- - tended for use in the non-debugging library: - - _nc_freeall + screen, since (even after calling endwin(3X)), it must be available for + use in the next call to refresh(3X). There are also chunks of memory + held for performance reasons. That makes it hard to analyze curses ap- + plications for memory leaks. When using the specially configured de- + bugging version of the ncurses library, applications can call functions + which free those chunks of memory, simplifying the process of memory- + leak checking. + + Some of the functions are named with a "_nc_" prefix because they are + not intended for use in the non-debugging library: + + _nc_freeall This frees (almost) all of the memory allocated by ncurses. - _nc_free_and_exit - This frees the memory allocated by ncurses (like _nc_freeall), and - exits the program. It is preferred over _nc_freeall since some of + _nc_free_and_exit + This frees the memory allocated by ncurses (like _nc_freeall), and + exits the program. It is preferred over _nc_freeall since some of that memory may be required to keep the application running. Sim- ply exiting (with the given exit-code) is safer. - _nc_free_tinfo + _nc_free_tinfo Use this function if only the low-level terminfo functions (and - corresponding library) are used. Like _nc_free_and_exit, it exits + corresponding library) are used. Like _nc_free_and_exit, it exits the program after freeing memory. + The functions prefixed "_nc" are normally not available; they must be + configured into the library at build time using the --disable-leaks op- + tion. That compiles-in code that frees memory that normally would not + be freed. + + The exit_curses and exit_terminfo functions call _nc_free_and_exit and + _nc_free_tinfo if the library is configured to support memory-leak + checking. If the library is not configured to support memory-leak + checking, they simply call exit. +
These functions do not return a value. @@ -102,11 +114,11 @@
- curses(3x). + curses(3X). - curs_memleaks(3x) + curs_memleaks(3X)