[apple/libc.git] / stdlib / FreeBSD / abort.3

.\" Copyright (c) 1990, 1991, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" This code is derived from software contributed to Berkeley by
.\" the American National Standards Committee X3, on Information
.\" Processing Systems.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"     @(#)abort.3	8.1 (Berkeley) 6/4/93
.\" $FreeBSD: src/lib/libc/stdlib/abort.3,v 1.10 2007/01/09 00:28:09 imp Exp $
.\"
.Dd June 4, 1993
.Dt ABORT 3
.Os
.Sh NAME
.Nm abort
.Nd cause abnormal program termination
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.In stdlib.h
.Ft void
.Fn abort void
.Sh DESCRIPTION
The
.Fn abort
function causes abnormal program termination to occur, unless the
signal
.Dv SIGABRT
is being caught and the signal handler does not return.
.Pp
Any open streams are flushed and closed.
.Sh IMPLEMENTATION NOTES
The
.Fn abort
function is thread-safe.
It is unknown if it is async-cancel-safe.
.Pp
The
.Fn abort
function causes a report to be generated by Crash Reporter.  If you wish to
terminate without generating a crash report, use
.Xr exit 3
instead.
.Sh RETURN VALUES
The
.Fn abort
function
never returns.
.Sh SEE ALSO
.Xr sigaction 2 ,
.Xr exit 3
.Sh STANDARDS
The
.Fn abort
function
conforms to
.St -p1003.1-90 .
The
.Fn abort
function also conforms to
.St -isoC-99
with the implementation specific details as noted above.
Commit	Line	Data
5b2abdfb	1	.\" Copyright (c) 1990, 1991, 1993
e9ce8d39 A	2	.\" The Regents of the University of California. All rights reserved.
e9ce8d39 A	3	.\"
5b2abdfb A	4	.\" This code is derived from software contributed to Berkeley by
	5	.\" the American National Standards Committee X3, on Information
	6	.\" Processing Systems.
	7	.\"
e9ce8d39 A	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.
e9ce8d39 A	16	.\" 4. 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	.\"
5b2abdfb	32	.\" @(#)abort.3 8.1 (Berkeley) 6/4/93
1f2f436a	33	.\" $FreeBSD: src/lib/libc/stdlib/abort.3,v 1.10 2007/01/09 00:28:09 imp Exp $
e9ce8d39	34	.\"
5b2abdfb A	35	.Dd June 4, 1993
5b2abdfb A	36	.Dt ABORT 3
e9ce8d39 A	37	.Os
e9ce8d39 A	38	.Sh NAME
5b2abdfb A	39	.Nm abort
5b2abdfb A	40	.Nd cause abnormal program termination
e9ce8d39 A	41	.Sh LIBRARY
	42	.Lb libc
	43	.Sh SYNOPSIS
5b2abdfb A	44	.In stdlib.h
	45	.Ft void
	46	.Fn abort void
e9ce8d39 A	47	.Sh DESCRIPTION
e9ce8d39 A	48	The
5b2abdfb A	49	.Fn abort
	50	function causes abnormal program termination to occur, unless the
	51	signal
	52	.Dv SIGABRT
	53	is being caught and the signal handler does not return.
	54	.Pp
	55	Any open streams are flushed and closed.
	56	.Sh IMPLEMENTATION NOTES
e9ce8d39	57	The
5b2abdfb A	58	.Fn abort
	59	function is thread-safe.
	60	It is unknown if it is async-cancel-safe.
ad3c9f2a A	61	.Pp
	62	The
	63	.Fn abort
	64	function causes a report to be generated by Crash Reporter. If you wish to
	65	terminate without generating a crash report, use
	66	.Xr exit 3
	67	instead.
e9ce8d39	68	.Sh RETURN VALUES
5b2abdfb A	69	The
	70	.Fn abort
	71	function
	72	never returns.
e9ce8d39	73	.Sh SEE ALSO
5b2abdfb A	74	.Xr sigaction 2 ,
	75	.Xr exit 3
	76	.Sh STANDARDS
	77	The
	78	.Fn abort
	79	function
	80	conforms to
	81	.St -p1003.1-90 .
e9ce8d39	82	The
5b2abdfb A	83	.Fn abort
	84	function also conforms to
	85	.St -isoC-99
	86	with the implementation specific details as noted above.