Merge branch 'vendor/OPENSSL'
[dragonfly.git] / lib / libc / stdlib / abort.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. Neither the name of the University nor the names of its contributors
17 .\"    may be used to endorse or promote products derived from this software
18 .\"    without specific prior written permission.
19 .\"
20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 .\" SUCH DAMAGE.
31 .\"
32 .\"     @(#)abort.3     8.1 (Berkeley) 6/4/93
33 .\" $FreeBSD: src/lib/libc/stdlib/abort.3,v 1.10 2007/01/09 00:28:09 imp Exp $
34 .\" $DragonFly: src/lib/libc/stdlib/abort.3,v 1.3 2005/06/02 18:44:07 asmodai Exp $
35 .\"
36 .Dd June 4, 1993
37 .Dt ABORT 3
38 .Os
39 .Sh NAME
40 .Nm abort
41 .Nd cause abnormal program termination
42 .Sh LIBRARY
43 .Lb libc
44 .Sh SYNOPSIS
45 .In stdlib.h
46 .Ft void
47 .Fn abort void
48 .Sh DESCRIPTION
49 The
50 .Fn abort
51 function causes abnormal program termination to occur, unless the
52 signal
53 .Dv SIGABRT
54 is being caught and the signal handler does not return.
55 .Pp
56 Any open streams are flushed and closed.
57 .Sh IMPLEMENTATION NOTES
58 The
59 .Fn abort
60 function is thread-safe.
61 It is unknown if it is async-cancel-safe.
62 .Sh RETURN VALUES
63 The
64 .Fn abort
65 function
66 never returns.
67 .Sh SEE ALSO
68 .Xr sigaction 2 ,
69 .Xr exit 3
70 .Sh STANDARDS
71 The
72 .Fn abort
73 function
74 conforms to
75 .St -p1003.1-90 .
76 The
77 .Fn abort
78 function also conforms to
79 .St -isoC-99
80 with the implementation specific details as noted above.