Initial import from FreeBSD RELENG_4:
[dragonfly.git] / lib / libc / sys / _exit.2
1 .\" Copyright (c) 1980, 1993
2 .\"     The Regents of the University of California.  All rights reserved.
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\"    notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\"    notice, this list of conditions and the following disclaimer in the
11 .\"    documentation and/or other materials provided with the distribution.
12 .\" 3. All advertising materials mentioning features or use of this software
13 .\"    must display the following acknowledgement:
14 .\"     This product includes software developed by the University of
15 .\"     California, Berkeley and its contributors.
16 .\" 4. Neither the name of the University nor the names of its contributors
17 .\"    may be used to endorse or promote products derived from this software
18 .\"    without specific prior written permission.
19 .\"
20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 .\" SUCH DAMAGE.
31 .\"
32 .\"     @(#)_exit.2     8.1 (Berkeley) 6/4/93
33 .\" $FreeBSD: src/lib/libc/sys/_exit.2,v 1.10.2.4 2001/12/14 18:34:00 ru Exp $
34 .\"
35 .Dd June 4, 1993
36 .Dt EXIT 2
37 .Os
38 .Sh NAME
39 .Nm _exit
40 .Nd terminate the calling process
41 .Sh LIBRARY
42 .Lb libc
43 .Sh SYNOPSIS
44 .In unistd.h
45 .Ft void
46 .Fn _exit "int status"
47 .Sh DESCRIPTION
48 The
49 .Fn _exit
50 function
51 terminates a process with the following consequences:
52 .Bl -bullet
53 .It
54 All of the descriptors open in the calling process are closed.
55 This may entail delays, for example, waiting for output to drain;
56 a process in this state may not be killed, as it is already dying.
57 .It
58 If the parent process of the calling process has an outstanding
59 .Xr wait 2
60 call
61 or catches the
62 .Dv SIGCHLD
63 signal,
64 it is notified of the calling process's termination and
65 the
66 .Em status
67 is set as defined by
68 .Xr wait 2 .
69 .It
70 The parent process-ID of all of the calling process's existing child
71 processes are set to 1; the initialization process
72 (see the
73 .Sx DEFINITIONS
74 section of
75 .Xr intro 2 )
76 inherits each of these processes.
77 .It
78 If the termination of the process causes any process group
79 to become orphaned (usually because the parents of all members
80 of the group have now exited; see
81 .Dq orphaned process group
82 in
83 .Xr intro 2 ) ,
84 and if any member of the orphaned group is stopped,
85 the
86 .Dv SIGHUP
87 signal and the
88 .Dv SIGCONT
89 signal are sent to all members of the newly-orphaned process group.
90 .It
91 If the process is a controlling process (see
92 .Xr intro 2 ) ,
93 the
94 .Dv SIGHUP
95 signal is sent to the foreground process group of the controlling terminal,
96 and all current access to the controlling terminal is revoked.
97 .El
98 .Pp
99 Most C programs call the library routine
100 .Xr exit 3 ,
101 which flushes buffers, closes streams, unlinks temporary files, etc.,
102 before
103 calling
104 .Fn _exit .
105 .Sh RETURN VALUES
106 .Fn _exit
107 can never return.
108 .Sh SEE ALSO
109 .Xr fork 2 ,
110 .Xr sigaction 2 ,
111 .Xr wait 2 ,
112 .Xr exit 3
113 .Sh STANDARDS
114 The
115 .Fn _exit
116 function call is expected to conform to
117 .St -p1003.1-90 .
118 .Sh HISTORY
119 An
120 .Fn _exit
121 function call appeared in
122 .At v7 .