X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fcurs_memleaks.3x;h=06a95edfe3e4b3f880fd44831de2b8e6941bdb0c;hp=9305edaaa3ca917c65daf76a8c91ac9b79b9b504;hb=84cf9f63bf604413fa5714ef91f83076ac8f236b;hpb=690589d8f19e38925db061296d4f704e4a965bb2 diff --git a/man/curs_memleaks.3x b/man/curs_memleaks.3x index 9305edaa..06a95edf 100644 --- a/man/curs_memleaks.3x +++ b/man/curs_memleaks.3x @@ -1,5 +1,6 @@ .\"*************************************************************************** -.\" Copyright (c) 2008-2010,2017 Free Software Foundation, Inc. * +.\" Copyright 2019,2020 Thomas E. Dickey * +.\" Copyright 2008-2010,2017 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * .\" copy of this software and associated documentation files (the * @@ -26,7 +27,7 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_memleaks.3x,v 1.5 2017/07/28 00:04:34 tom Exp $ +.\" $Id: curs_memleaks.3x,v 1.8 2020/02/02 23:34:34 tom Exp $ .TH curs_memleaks 3X "" .ie \n(.g .ds `` \(lq .el .ds `` `` @@ -35,14 +36,20 @@ .na .hy 0 .SH NAME -\fB_nc_freeall\fP -\fB_nc_free_and_exit\fP +\fB_nc_freeall\fP, +\fB_nc_free_and_exit\fP, \fB_nc_free_tinfo\fP \- \fBcurses\fR memory-leak checking .ad .hy .SH SYNOPSIS \fB#include \fR .sp +\fBvoid exit_curses(int);\fR +.br +\fBvoid exit_terminfo(int);\fR +.sp +/* deprecated */ +.br \fBvoid _nc_freeall(void);\fR .br \fBvoid _nc_free_and_exit(int);\fR @@ -51,10 +58,6 @@ .SH DESCRIPTION These functions are used to simplify analysis of memory leaks in the ncurses library. -They are normally not available; -they must be configured into the library -at build time using the \fB\-\-disable-leaks\fP option. -That compiles-in code that frees memory that normally would not be freed. .PP Any implementation of curses must not free the memory associated with a screen, since (even after calling \fBendwin\fP), it must be available @@ -65,8 +68,8 @@ 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. .PP -These functions are named with a \*(``_nc_\*('' prefix because they are not -intended 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: .TP 5 \fB_nc_freeall\fP This frees (almost) all of the memory allocated by ncurses. @@ -82,6 +85,17 @@ Simply exiting (with the given exit-code) is safer. Use this function if only the low-level terminfo functions (and corresponding library) are used. Like \fB_nc_free_and_exit\fP, it exits the program after freeing memory. +.PP +The functions prefixed \*(``_nc\*('' are normally not available; +they must be configured into the library +at build time using the \fB\-\-disable-leaks\fP option. +That compiles-in code that frees memory that normally would not be freed. +.PP +The \fBexit_curses\fP and \fBexit_terminfo\fP functions +call \fB_nc_free_and_exit\fP and \fB_nc_free_tinfo\fP if +the library is configured to support memory-leak checking. +If the library is not configured to support memory-leak checking, +they simply call \fBexit\fP. .SH RETURN VALUE These functions do not return a value. .SH PORTABILITY