X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_memleaks.3x.html;h=18b38c9604a90a42a872e08038530a8aca59664c;hp=20cc59d68174eb9637fe904b3158630a12011b64;hb=c0f109a299a82a33c16bd7af942a12ce9aefaaf0;hpb=cd142df6d9934f1bda19f5b968cc666291be5072 diff --git a/doc/html/man/curs_memleaks.3x.html b/doc/html/man/curs_memleaks.3x.html index 20cc59d6..18b38c96 100644 --- a/doc/html/man/curs_memleaks.3x.html +++ b/doc/html/man/curs_memleaks.3x.html @@ -1,6 +1,7 @@
- +#include <curses.h> + void exit_curses(int); + void exit_terminfo(int); + + /* deprecated */ void _nc_freeall(void); void _nc_free_and_exit(int); void _nc_free_tinfo(int); @@ -60,22 +65,19 @@
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. + 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 + 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 + 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: + 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. @@ -87,10 +89,20 @@ ply exiting (with the given exit-code) is safer. _nc_free_tinfo - Use this function if only the low-level terminfo functions (and + Use this function if only the low-level terminfo functions (and 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.