[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.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"	This product includes software developed by the University of
.\"	California, Berkeley and its contributors.
.\" 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.9 2001/09/09 18:52:00 asmodai 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.
.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.
	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	.\"
5b2abdfb A	36	.\" @(#)abort.3 8.1 (Berkeley) 6/4/93
5b2abdfb A	37	.\" $FreeBSD: src/lib/libc/stdlib/abort.3,v 1.9 2001/09/09 18:52:00 asmodai Exp $
e9ce8d39	38	.\"
5b2abdfb A	39	.Dd June 4, 1993
5b2abdfb A	40	.Dt ABORT 3
e9ce8d39 A	41	.Os
e9ce8d39 A	42	.Sh NAME
5b2abdfb A	43	.Nm abort
5b2abdfb A	44	.Nd cause abnormal program termination
e9ce8d39 A	45	.Sh LIBRARY
	46	.Lb libc
	47	.Sh SYNOPSIS
5b2abdfb A	48	.In stdlib.h
	49	.Ft void
	50	.Fn abort void
e9ce8d39 A	51	.Sh DESCRIPTION
e9ce8d39 A	52	The
5b2abdfb A	53	.Fn abort
	54	function causes abnormal program termination to occur, unless the
	55	signal
	56	.Dv SIGABRT
	57	is being caught and the signal handler does not return.
	58	.Pp
	59	Any open streams are flushed and closed.
	60	.Sh IMPLEMENTATION NOTES
e9ce8d39	61	The
5b2abdfb A	62	.Fn abort
	63	function is thread-safe.
	64	It is unknown if it is async-cancel-safe.
e9ce8d39	65	.Sh RETURN VALUES
5b2abdfb A	66	The
	67	.Fn abort
	68	function
	69	never returns.
e9ce8d39	70	.Sh SEE ALSO
5b2abdfb A	71	.Xr sigaction 2 ,
	72	.Xr exit 3
	73	.Sh STANDARDS
	74	The
	75	.Fn abort
	76	function
	77	conforms to
	78	.St -p1003.1-90 .
e9ce8d39	79	The
5b2abdfb A	80	.Fn abort
	81	function also conforms to
	82	.St -isoC-99
	83	with the implementation specific details as noted above.