xref: /freebsd/lib/libc/stdlib/quick_exit.3 (revision 608da65de9552d5678c1000776ed69da04a45983)
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.Dd November 4, 2017
26.Dt QUICK_EXIT 3
27.Os
28.Sh NAME
29.Nm quick_exit
30.Nd exits a program quickly, running minimal cleanup
31.Sh LIBRARY
32.Lb libc
33.Sh SYNOPSIS
34.In stdlib.h
35.Ft _Noreturn void
36.Fn quick_exit "int status"
37.Sh DESCRIPTION
38The
39.Fn quick_exit
40function exits the program quickly calling any cleanup functions registered
41with
42.Xr at_quick_exit 3
43but not any C++ destructors or cleanup code registered with
44.Xr atexit 3 .
45The
46.Xr stdio 3
47file buffers are not flushed.
48.Pp
49The function
50.Fn quick_exit
51is
52.Em async-signal safe
53when the functions registered with
54.Xr at_quick_exit 3
55are.
56.Sh RETURN VALUES
57The
58.Fn quick_exit
59function does not return.
60.Sh SEE ALSO
61.Xr at_quick_exit 3 ,
62.Xr exit 3
63.Sh STANDARDS
64The
65.Fn quick_exit
66function conforms to
67.St -isoC-2011 .
68