diff options
| author | Michael Kerrisk <mtk.manpages@gmail.com> | 2007-05-12 09:06:04 +0000 |
|---|---|---|
| committer | Michael Kerrisk <mtk.manpages@gmail.com> | 2007-05-12 09:06:04 +0000 |
| commit | 60a90ecdae7bf6d1a91dc5d1d7177e400b114e47 (patch) | |
| tree | 9f7c19a897084607a9688be5414d0d4cd6391b54 /man3/on_exit.3 | |
| parent | d92a60f2575c95cd532b822e4fb983c3a9e35641 (diff) | |
| download | man-pages-60a90ecdae7bf6d1a91dc5d1d7177e400b114e47.tar.gz | |
Convert function formatting of the form "\fBname\fP()" to ".BR name ()".
Diffstat (limited to 'man3/on_exit.3')
| -rw-r--r-- | man3/on_exit.3 | 11 |
1 files changed, 8 insertions, 3 deletions
diff --git a/man3/on_exit.3 b/man3/on_exit.3 index a3e1a14e26..988765430d 100644 --- a/man3/on_exit.3 +++ b/man3/on_exit.3 @@ -36,15 +36,20 @@ on_exit \- register a function to be called at normal process termination .BI "int on_exit(void (*" function ")(int , void *), void *" arg ); .fi .SH DESCRIPTION -The \fBon_exit\fP() function registers the given \fIfunction\fP to be +The +.BR on_exit () +function registers the given \fIfunction\fP to be called at normal process termination, whether via .BR exit (3) or via return from the program's \fImain\fP(). The \fIfunction\fP is passed the argument to .BR exit (3) -and the \fIarg\fP argument from \fBon_exit\fP(). +and the \fIarg\fP argument from +.BR on_exit (). .SH "RETURN VALUE" -The \fBon_exit\fP() function returns the value 0 if successful; otherwise +The +.BR on_exit () +function returns the value 0 if successful; otherwise it returns a non-zero value. .SH "CONFORMING TO" This function comes from SunOS 4, but is also present in |