xref: /dragonfly/lib/libc/stdlib/exit.3 (revision 984263bc)
1.\" Copyright (c) 1990, 1991, 1993
2.\"	The Regents of the University of California.  All rights reserved.
3.\"
4.\" This code is derived from software contributed to Berkeley by
5.\" the American National Standards Committee X3, on Information
6.\" Processing Systems.
7.\"
8.\" Redistribution and use in source and binary forms, with or without
9.\" modification, are permitted provided that the following conditions
10.\" are met:
11.\" 1. Redistributions of source code must retain the above copyright
12.\"    notice, this list of conditions and the following disclaimer.
13.\" 2. Redistributions in binary form must reproduce the above copyright
14.\"    notice, this list of conditions and the following disclaimer in the
15.\"    documentation and/or other materials provided with the distribution.
16.\" 3. All advertising materials mentioning features or use of this software
17.\"    must display the following acknowledgement:
18.\"	This product includes software developed by the University of
19.\"	California, Berkeley and its contributors.
20.\" 4. Neither the name of the University nor the names of its contributors
21.\"    may be used to endorse or promote products derived from this software
22.\"    without specific prior written permission.
23.\"
24.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34.\" SUCH DAMAGE.
35.\"
36.\"     @(#)exit.3	8.1 (Berkeley) 6/4/93
37.\" $FreeBSD: src/lib/libc/stdlib/exit.3,v 1.6.2.4 2001/12/14 18:33:58 ru Exp $
38.\"
39.Dd June 4, 1993
40.Dt EXIT 3
41.Os
42.Sh NAME
43.Nm exit
44.Nd perform normal program termination
45.Sh LIBRARY
46.Lb libc
47.Sh SYNOPSIS
48.In stdlib.h
49.Ft void
50.Fn exit "int status"
51.Sh DESCRIPTION
52.Fn Exit
53terminates a process.
54.Pp
55Before termination it performs the following functions in the
56order listed:
57.Bl -enum -offset indent
58.It
59Call the functions registered with the
60.Xr atexit 3
61function, in the reverse order of their registration.
62.It
63Flush all open output streams.
64.It
65Close all open streams.
66.It
67Unlink all files created with the
68.Xr tmpfile 3
69function.
70.El
71.Pp
72Passing arbitrary values back to the environment as
73.Ar status
74is considered bad style;
75you should use the values
76.Dv EXIT_SUCCESS
77and
78.Dv EXIT_FAILURE .
79If portability is not a concern, you may
80use the values described in
81.Xr sysexits 3 .
82.Sh RETURN VALUES
83The
84.Fn exit
85function
86never returns.
87.Sh SEE ALSO
88.Xr _exit 2 ,
89.Xr atexit 3 ,
90.Xr intro 3 ,
91.Xr sysexits 3 ,
92.Xr tmpfile 3
93.Sh STANDARDS
94The
95.Fn exit
96function
97conforms to
98.St -isoC .
99