xref: /freebsd/lib/libc/stdlib/quick_exit.3 (revision 3078531de10dcae44b253a35125c949ff4235284)
1.\"  Copyright (c) 2011 David Chisnall
2.\"  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.\"
13.\"  THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\"  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\"  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\"  ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\"  FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\"  DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\"  OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\"  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\"  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\"  OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\"  SUCH DAMAGE.
24.\"
25.\"  $FreeBSD$
26.\"
27.Dd November 4, 2017
28.Dt QUICK_EXIT 3
29.Os
30.Sh NAME
31.Nm quick_exit
32.Nd exits a program quickly, running minimal cleanup
33.Sh LIBRARY
34.Lb libc
35.Sh SYNOPSIS
36.In stdlib.h
37.Ft _Noreturn void
38.Fn quick_exit "int status"
39.Sh DESCRIPTION
40The
41.Fn quick_exit
42function exits the program quickly calling any cleanup functions registered
43with
44.Xr at_quick_exit 3
45but not any C++ destructors or cleanup code registered with
46.Xr atexit 3 .
47The
48.Xr stdio 3
49file buffers are not flushed.
50.Pp
51The function
52.Fn quick_exit
53is
54.Em async-signal safe
55when the functions registered with
56.Xr at_quick_exit 3
57are.
58.Sh RETURN VALUES
59The
60.Fn quick_exit
61function does not return.
62.Sh SEE ALSO
63.Xr at_quick_exit 3 ,
64.Xr exit 3
65.Sh STANDARDS
66The
67.Fn quick_exit
68function conforms to
69.St -isoC-2011 .
70