libcr copy: Retarget build paths from ../libc to ../libcr and retarget
[dragonfly.git] / lib / libcr / stdlib / exit.3
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 .\" $DragonFly: src/lib/libcr/stdlib/Attic/exit.3,v 1.2 2003/06/17 04:26:46 dillon Exp $
39 .\"
40 .Dd June 4, 1993
41 .Dt EXIT 3
42 .Os
43 .Sh NAME
44 .Nm exit
45 .Nd perform normal program termination
46 .Sh LIBRARY
47 .Lb libc
48 .Sh SYNOPSIS
49 .In stdlib.h
50 .Ft void
51 .Fn exit "int status"
52 .Sh DESCRIPTION
53 .Fn Exit
54 terminates a process.
55 .Pp
56 Before termination it performs the following functions in the
57 order listed:
58 .Bl -enum -offset indent
59 .It
60 Call the functions registered with the
61 .Xr atexit 3
62 function, in the reverse order of their registration.
63 .It
64 Flush all open output streams.
65 .It
66 Close all open streams.
67 .It
68 Unlink all files created with the
69 .Xr tmpfile 3
70 function.
71 .El
72 .Pp
73 Passing arbitrary values back to the environment as
74 .Ar status
75 is considered bad style;
76 you should use the values
77 .Dv EXIT_SUCCESS
78 and
79 .Dv EXIT_FAILURE .
80 If portability is not a concern, you may
81 use the values described in
82 .Xr sysexits 3 .
83 .Sh RETURN VALUES
84 The
85 .Fn exit
86 function
87 never returns.
88 .Sh SEE ALSO
89 .Xr _exit 2 ,
90 .Xr atexit 3 ,
91 .Xr intro 3 ,
92 .Xr sysexits 3 ,
93 .Xr tmpfile 3
94 .Sh STANDARDS
95 The
96 .Fn exit
97 function
98 conforms to
99 .St -isoC .