Changes.old: Add missing entry in 5.13 changelog
[man-pages.git] / man3 / on_exit.3
blob7997b601e6d094d890d0ad1806b5fead023222ff
1 .\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
2 .\"
3 .\" %%%LICENSE_START(VERBATIM)
4 .\" Permission is granted to make and distribute verbatim copies of this
5 .\" manual provided the copyright notice and this permission notice are
6 .\" preserved on all copies.
7 .\"
8 .\" Permission is granted to copy and distribute modified versions of this
9 .\" manual under the conditions for verbatim copying, provided that the
10 .\" entire resulting derived work is distributed under the terms of a
11 .\" permission notice identical to this one.
12 .\"
13 .\" Since the Linux kernel and libraries are constantly changing, this
14 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
15 .\" responsibility for errors or omissions, or for damages resulting from
16 .\" the use of the information contained herein.  The author(s) may not
17 .\" have taken the same level of care in the production of this manual,
18 .\" which is licensed free of charge, as they might when working
19 .\" professionally.
20 .\"
21 .\" Formatted or processed versions of this manual, if unaccompanied by
22 .\" the source, must acknowledge the copyright and authors of this work.
23 .\" %%%LICENSE_END
24 .\"
25 .\" References consulted:
26 .\"     Linux libc source code
27 .\"     Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
28 .\"     386BSD man pages
29 .\" Modified 1993-04-02, David Metcalfe
30 .\" Modified 1993-07-25, Rik Faith (faith@cs.unc.edu)
31 .TH ON_EXIT 3  2021-03-22 "GNU" "Linux Programmer's Manual"
32 .SH NAME
33 on_exit \- register a function to be called at normal process termination
34 .SH SYNOPSIS
35 .nf
36 .B #include <stdlib.h>
37 .PP
38 .BI "int on_exit(void (*" function ")(int, void *), void *" arg );
39 .fi
40 .PP
41 .RS -4
42 Feature Test Macro Requirements for glibc (see
43 .BR feature_test_macros (7)):
44 .RE
45 .PP
46 .BR on_exit ():
47 .nf
48     Since glibc 2.19:
49         _DEFAULT_SOURCE
50     Glibc 2.19 and earlier:
51         _BSD_SOURCE || _SVID_SOURCE
52 .fi
53 .SH DESCRIPTION
54 The
55 .BR on_exit ()
56 function registers the given
57 .I function
58 to be
59 called at normal process termination, whether via
60 .BR exit (3)
61 or via return from the program's
62 .IR main ().
63 The
64 .I function
65 is passed the status argument given to the last call to
66 .BR exit (3)
67 and the
68 .I arg
69 argument from
70 .BR on_exit ().
71 .PP
72 The same function may be registered multiple times:
73 it is called once for each registration.
74 .PP
75 When a child process is created via
76 .BR fork (2),
77 it inherits copies of its parent's registrations.
78 Upon a successful call to one of the
79 .BR exec (3)
80 functions, all registrations are removed.
81 .SH RETURN VALUE
82 The
83 .BR on_exit ()
84 function returns the value 0 if successful; otherwise
85 it returns a nonzero value.
86 .SH ATTRIBUTES
87 For an explanation of the terms used in this section, see
88 .BR attributes (7).
89 .ad l
90 .nh
91 .TS
92 allbox;
93 lbx lb lb
94 l l l.
95 Interface       Attribute       Value
97 .BR on_exit ()
98 T}      Thread safety   MT-Safe
99 .TE
102 .sp 1
103 .SH CONFORMING TO
104 This function comes from SunOS 4, but is also present in glibc.
105 It no longer occurs in Solaris (SunOS 5).
106 Portable application should avoid this function, and use the standard
107 .BR atexit (3)
108 instead.
109 .SH NOTES
110 By the time
111 .I function
112 is executed, stack
113 .RI ( auto )
114 variables may already have gone out of scope.
115 Therefore,
116 .I arg
117 should not be a pointer to a stack variable;
118 it may however be a pointer to a heap variable or a global variable.
119 .SH SEE ALSO
120 .BR _exit (2),
121 .BR atexit (3),
122 .BR exit (3)