X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_memleaks.3x.html;h=388d969a314661afa86560bc0fef4d7f02aafa9a;hp=20cc59d68174eb9637fe904b3158630a12011b64;hb=61790aa3ac9e0dff2b443ac567b174fc4d235b86;hpb=cd142df6d9934f1bda19f5b968cc666291be5072 diff --git a/doc/html/man/curs_memleaks.3x.html b/doc/html/man/curs_memleaks.3x.html index 20cc59d6..388d969a 100644 --- a/doc/html/man/curs_memleaks.3x.html +++ b/doc/html/man/curs_memleaks.3x.html @@ -1,6 +1,7 @@ - + curs_memleaks 3x - + @@ -46,36 +47,37 @@

NAME

-       _nc_freeall, _nc_free_and_exit, _nc_free_tinfo - curses memory-leak
-       checking
+       exit_curses, exit_terminfo - curses memory-leak checking

SYNOPSIS

        #include <curses.h>
+       void exit_curses(int code);
 
+       #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);
-       void _nc_free_tinfo(int);
+       void _nc_free_and_exit(int code);
+       void _nc_free_tinfo(int code);

DESCRIPTION

-       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.
+       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.
 
-       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.
@@ -91,6 +93,16 @@
             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.
+

RETURN VALUE

        These functions do not return a value.