ncurses 6.4 - patch 20240413

[ncurses.git] / man / curs_memleaks.3x

diff --git a/man/curs_memleaks.3x b/man/curs_memleaks.3x
index 1cd1dc921f321e199b6e26200b8d7a414d29b876..0626d774097b6196d6084becf3f4b25ee2b4ae5d 100644 (file)
--- a/man/curs_memleaks.3x
+++ b/man/curs_memleaks.3x
@@ -1,5 +1,5 @@
 .\"***************************************************************************
 .\"***************************************************************************

-.\" Copyright 2019-2021,2022 Thomas E. Dickey                                *
+.\" Copyright 2019-2023,2024 Thomas E. Dickey                                *

 .\" Copyright 2008-2010,2017 Free Software Foundation, Inc.                  *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
 .\" Copyright 2008-2010,2017 Free Software Foundation, Inc.                  *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *


@@ -27,77 +27,80 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"

-.\" $Id: curs_memleaks.3x,v 1.16 2022/06/04 23:33:48 tom Exp $
-.TH curs_memleaks 3X 2022-06-04 "ncurses 6.4" "Library calls"
-.ie \n(.g .ds `` \(lq
-.el       .ds `` ``
-.ie \n(.g .ds '' \(rq
-.el       .ds '' ''
+.\" $Id: curs_memleaks.3x,v 1.35 2024/03/16 15:35:01 tom Exp $
+.TH curs_memleaks 3X 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls"
+.ie \n(.g \{\
+.ds `` \(lq
+.ds '' \(rq
+.\}
+.el \{\
+.ie t .ds `` ``
+.el   .ds `` ""
+.ie t .ds '' ''
+.el   .ds '' ""
+.\}
+.

 .de bP
 .ie n  .IP \(bu 4
 .el    .IP \(bu 2
 ..
 .de bP
 .ie n  .IP \(bu 4
 .el    .IP \(bu 2
 ..

-.na
-.hy 0

 .SH NAME
 .SH NAME

-\fBexit_curses\fP,
-\fBexit_terminfo\fP \- \fBcurses\fP memory-leak checking
-.ad
-.hy
+\fB\%exit_curses\fP,
+\fB\%exit_terminfo\fP \-
+check for memory leaks in \fIcurses\fR

 .SH SYNOPSIS
 .SH SYNOPSIS

-\fB#include <curses.h>\fP
-.br
-\fBvoid exit_curses(int \fIcode\fB);\fR
-.sp
-\fB#include <term.h>\fP
-.br
-\fBvoid exit_terminfo(int \fIcode\fB);\fR
-.sp
-/* deprecated (intentionally not declared in curses.h or term.h) */
-.br
-\fBvoid _nc_freeall(void);\fP
-.br
-\fBvoid _nc_free_and_exit(int \fIcode\fB);\fR
-.br
-\fBvoid _nc_free_tinfo(int \fIcode\fB);\fR
+.nf
+\fB#include <curses.h>
+\fBvoid exit_curses(int \fIcode\fP);
+.PP
+\fB#include <term.h>
+\fBvoid exit_terminfo(int \fIcode\fP);
+.PP
+\fI/* deprecated (intentionally not declared in curses.h or term.h) */
+\fBvoid _nc_freeall(void);
+\fBvoid _nc_free_and_exit(int \fIcode\fP);
+\fBvoid _nc_free_tinfo(int \fIcode\fP);
+.fi

 .SH DESCRIPTION
 .SH DESCRIPTION

-These functions are used to simplify analysis of memory leaks in the ncurses
-library.
+These functions are used to simplify analysis of memory leaks in the
+\fI\%ncurses\fP library.

 .PP
 Any implementation of curses must not free the memory associated with
 .PP
 Any implementation of curses must not free the memory associated with

-a screen, since (even after calling \fBendwin\fP(3X)), it must be available
-for use in the next call to \fBrefresh\fP(3X).
+a screen, since (even after calling \fB\%endwin\fP(3X)), it must be available
+for use in the next call to \fB\%refresh\fP(3X).

 There are also chunks of memory held for performance reasons.
 That makes it hard to analyze curses applications for memory leaks.
 There are also chunks of memory held for performance reasons.
 That makes it hard to analyze curses applications for memory leaks.

-When using the specially configured debugging version of the ncurses library,
+When using the specially configured debugging version of the
+\fI\%ncurses\fP library,

 applications can call functions which free those chunks of memory,
 simplifying the process of memory-leak checking.
 .PP
 Some of the functions are named with a \*(``_nc_\*('' prefix
 because they are not intended for use in the non-debugging library:
 .TP 5
 applications can call functions which free those chunks of memory,
 simplifying the process of memory-leak checking.
 .PP
 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.
+\fB\%_nc_freeall\fP
+This frees (almost) all of the memory allocated by \fI\%ncurses\fP.

 .TP 5
 .TP 5

-\fB_nc_free_and_exit\fP
-This frees the memory allocated by ncurses (like \fB_nc_freeall\fP),
+\fB\%_nc_free_and_exit\fP
+This frees the memory allocated by \fI\%ncurses\fP
+(like \fB\%_nc_freeall\fP),

 and exits the program.
 and exits the program.

-It is preferred over \fB_nc_freeall\fP since some of that memory
+It is preferred over \fB\%_nc_freeall\fP since some of that memory

 may be required to keep the application running.
 Simply exiting (with the given exit-code) is safer.
 .TP 5
 may be required to keep the application running.
 Simply exiting (with the given exit-code) is safer.
 .TP 5

-\fB_nc_free_tinfo\fP
+\fB\%_nc_free_tinfo\fP

 Use this function if only the low-level terminfo functions (and
 corresponding library) are used.
 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.
+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
 .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.
+at build time using the \fB\%\-\-disable-leaks\fP option.

 That compiles-in code that frees memory that normally would not be freed.
 .PP
 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 \fB\%exit_curses\fP and \fB\%exit_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.
 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.


@@ -110,18 +113,19 @@ nor do other implementations of curses provide a similar feature.
 In any implementation of X/Open Curses, an application can free part
 of the memory allocated by curses:
 .bP
 In any implementation of X/Open Curses, an application can free part
 of the memory allocated by curses:
 .bP

-The portable part of \fBexit_curses\fP can be freed using \fBdelscreen\fP,
-passing the \fBSCREEN*\fP pointer returned by \fBnewterm\fP.
+The portable part of \fB\%exit_curses\fP can be freed using \fB\%delscreen\fP,
+passing the \fISCREEN\fP pointer returned by \fB\%newterm\fP.

 .IP
 In some implementations, there is a global variable \fBsp\fP
 which could be used, e.g., if the screen were only initialized
 .IP
 In some implementations, there is a global variable \fBsp\fP
 which could be used, e.g., if the screen were only initialized

-using \fBinitscr\fP.
+using \fB\%initscr\fP.

 .bP
 .bP

-The portable part of \fBexit_terminfo\fP can be freed using \fBdel_curterm\fP.
+The portable part of \fB\%exit_terminfo\fP can be freed
+using \fB\%del_curterm\fP.

 .IP
 .IP

-In this case, there is a global variable \fBcur_term\fP which can be
+In this case, there is a global variable \fB\%cur_term\fP which can be

 used as parameter.
 .SH SEE ALSO
 used as parameter.
 .SH SEE ALSO

-\fBcurs_initscr\fP(3X),
-\fBcurs_terminfo\fP(3X).
-\fBcurses\fP(3X).
+\fB\%curses\fP(3X),
+\fB\%curs_initscr\fP(3X),
+\fB\%curs_terminfo\fP(3X)