man-pages/man3/exit.3

172 lines
4.6 KiB
Groff
Raw Normal View History

2004-11-03 13:51:07 +00:00
.\" Copyright (C) 2001 Andries Brouwer <aeb@cwi.nl>.
.\"
.\" Permission is granted to make and distribute verbatim copies of this
.\" manual provided the copyright notice and this permission notice are
.\" preserved on all copies.
.\"
.\" Permission is granted to copy and distribute modified versions of this
.\" manual under the conditions for verbatim copying, provided that the
.\" entire resulting derived work is distributed under the terms of a
.\" permission notice identical to this one.
.\"
2004-11-03 13:51:07 +00:00
.\" Since the Linux kernel and libraries are constantly changing, this
.\" manual page may be incorrect or out-of-date. The author(s) assume no
.\" responsibility for errors or omissions, or for damages resulting from
.\" the use of the information contained herein. The author(s) may not
.\" have taken the same level of care in the production of this manual,
.\" which is licensed free of charge, as they might when working
.\" professionally.
.\"
2004-11-03 13:51:07 +00:00
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.\"
.TH EXIT 3 2009-09-20 "Linux" "Linux Programmer's Manual"
2004-11-03 13:51:07 +00:00
.SH NAME
2005-06-14 11:25:12 +00:00
exit \- cause normal process termination
2004-11-03 13:51:07 +00:00
.SH SYNOPSIS
.nf
.B #include <stdlib.h>
.sp
.BI "void exit(int " status );
.fi
.SH DESCRIPTION
The
.BR exit ()
function causes normal process termination and the
value of \fIstatus & 0377\fP is returned to the parent
2004-11-03 13:51:07 +00:00
(see
.BR wait (2)).
.LP
All functions registered with
.BR atexit (3)
and
.BR on_exit (3)
are called, in the reverse order of their registration.
(It is possible for one of these functions to use
.BR atexit (3)
or
.BR on_exit (3)
to register an additional
function to be executed during exit processing;
the new registration is added to the front of the list of functions
that remain to be called.)
If one of these functions does not return
(e.g., it calls
.BR _exit (2),
or kills itself with a signal),
then none of the remaining functions is called,
and further exit processing (in particular, flushing of
.BR stdio (3)
streams) is abandoned.
If a function has been registered multiple times using
.BR atexit (3)
or
.BR on_exit (3),
then it is called as many times as it was registered.
.LP
All open
.BR stdio (3)
streams are flushed and closed.
Files created by
.BR tmpfile (3)
are removed.
.LP
The C standard specifies two constants,
2007-06-20 22:21:22 +00:00
\fBEXIT_SUCCESS\fP and \fBEXIT_FAILURE\fP,
that may be passed to
.BR exit ()
to indicate successful or unsuccessful
2004-11-03 13:51:07 +00:00
termination, respectively.
.SH "RETURN VALUE"
The
.BR exit ()
function does not return.
2004-11-03 13:51:07 +00:00
.SH "CONFORMING TO"
SVr4, 4.3BSD, POSIX.1-2001, C89, C99.
2004-11-03 13:51:07 +00:00
.SH NOTES
2005-06-14 11:25:12 +00:00
.LP
It is undefined what happens if one of the
functions registered using
.BR atexit (3)
and
.BR on_exit (3)
calls either
.BR exit ()
or
.BR longjmp (3).
2004-11-03 13:51:07 +00:00
.LP
2007-06-21 05:38:48 +00:00
The use of
.B EXIT_SUCCESS
and
.B EXIT_FAILURE
is slightly more portable
intro.1, time.1, accept.2, bind.2, connect.2, execve.2, flock.2, getdents.2, getpriority.2, getuid.2, intro.2, ioctl.2, mincore.2, mknod.2, personality.2, ptrace.2, read.2, recv.2, select_tut.2, send.2, sendfile.2, shmctl.2, sigaction.2, signal.2, stat.2, times.2, truncate.2, umask.2, wait.2, MB_CUR_MAX.3, MB_LEN_MAX.3, argz_add.3, btowc.3, clearenv.3, clock.3, cmsg.3, end.3, endian.3, errno.3, exit.3, fgetwc.3, fgetws.3, fopen.3, fputwc.3, fputws.3, fseek.3, fwide.3, getfsent.3, getgrnam.3, gethostid.3, getipnodebyname.3, getmntent.3, getpwnam.3, getwchar.3, grantpt.3, iconv.3, iconv_close.3, iconv_open.3, insque.3, intro.3, iswalnum.3, iswalpha.3, iswblank.3, iswcntrl.3, iswctype.3, iswdigit.3, iswgraph.3, iswlower.3, iswprint.3, iswpunct.3, iswspace.3, iswupper.3, iswxdigit.3, malloc.3, mblen.3, mbrlen.3, mbrtowc.3, mbsinit.3, mbsnrtowcs.3, mbsrtowcs.3, mbstowcs.3, mbtowc.3, mkstemp.3, mktemp.3, nl_langinfo.3, openpty.3, posix_openpt.3, printf.3, ptsname.3, putwchar.3, qecvt.3, rcmd.3, readdir.3, rexec.3, rpc.3, setnetgrent.3, shm_open.3, sigpause.3, stdin.3, stpcpy.3, strftime.3, strptime.3, syslog.3, towctrans.3, towlower.3, towupper.3, ttyslot.3, ungetwc.3, unlocked_stdio.3, wcpcpy.3, wcpncpy.3, wcrtomb.3, wcscasecmp.3, wcscat.3, wcschr.3, wcscmp.3, wcscpy.3, wcscspn.3, wcsdup.3, wcslen.3, wcsncasecmp.3, wcsncat.3, wcsncmp.3, wcsncpy.3, wcsnlen.3, wcsnrtombs.3, wcspbrk.3, wcsrchr.3, wcsrtombs.3, wcsspn.3, wcsstr.3, wcstok.3, wcstombs.3, wcswidth.3, wctob.3, wctomb.3, wctrans.3, wctype.3, wcwidth.3, wmemchr.3, wmemcmp.3, wmemcpy.3, wmemmove.3, wmemset.3, wprintf.3, console_ioctl.4, pts.4, elf.5, filesystems.5, hosts.5, proc.5, ttytype.5, boot.7, capabilities.7, credentials.7, epoll.7, glob.7, koi8-r.7, path_resolution.7, pty.7, signal.7, suffixes.7, time.7, unicode.7, unix.7, uri.7, utf-8.7: global fix: s/Unix/UNIX/ The man pages were rather inconsistent in the use of "Unix" versus "UNIX". Let's go with the trademark usage. Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2010-10-12 04:45:38 +00:00
(to non-UNIX environments) than the use of 0 and some nonzero value
like 1 or \-1.
In particular, VMS uses a different convention.
2004-11-03 13:51:07 +00:00
.LP
2005-07-06 08:00:30 +00:00
BSD has attempted to standardize exit codes; see the file
2004-11-03 13:51:07 +00:00
.IR <sysexits.h> .
.LP
After
.BR exit (),
the exit status must be transmitted to the
parent process.
There are three cases.
If the parent has set
2007-06-21 05:38:48 +00:00
.BR SA_NOCLDWAIT ,
or has set the
.B SIGCHLD
handler to
.BR SIG_IGN ,
the status is discarded.
If the parent was waiting on the child
it is notified of the exit status.
In both cases the exiting
process dies immediately.
If the parent has not indicated that
2004-11-03 13:51:07 +00:00
it is not interested in the exit status, but is not waiting,
the exiting process turns into a "zombie" process
(which is nothing but a container for the single byte representing
the exit status) so that the parent can learn the exit status when
2007-06-21 22:55:04 +00:00
it later calls one of the
.BR wait (2)
functions.
2004-11-03 13:51:07 +00:00
.LP
2007-06-21 05:38:48 +00:00
If the implementation supports the
2007-09-20 16:26:31 +00:00
.B SIGCHLD
2007-06-21 05:38:48 +00:00
signal, this signal
is sent to the parent.
2007-06-21 05:38:48 +00:00
If the parent has set
.BR SA_NOCLDWAIT ,
it is undefined whether a
.B SIGCHLD
signal is sent.
2004-11-03 13:51:07 +00:00
.LP
If the process is a session leader and its controlling terminal
2005-08-04 14:01:47 +00:00
is the controlling terminal of the session, then each process in
2004-11-03 13:51:07 +00:00
the foreground process group of this controlling terminal
2007-06-21 05:38:48 +00:00
is sent a
.B SIGHUP
signal, and the terminal is disassociated
2004-11-03 13:51:07 +00:00
from this session, allowing it to be acquired by a new controlling
process.
.LP
If the exit of the process causes a process group to become orphaned,
2005-06-14 11:25:12 +00:00
and if any member of the newly orphaned process group is stopped,
2007-06-21 05:38:48 +00:00
then a
.B SIGHUP
signal followed by a
.B SIGCONT
signal will be
2004-11-03 13:51:07 +00:00
sent to each process in this process group.
See
.BR setpgid (2)
for an explanation of orphaned process groups.
2004-11-03 13:51:07 +00:00
.SH "SEE ALSO"
.BR _exit (2),
.BR setpgid (2),
2004-11-03 13:51:07 +00:00
.BR wait (2),
.BR atexit (3),
.BR on_exit (3),
.BR tmpfile (3)