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