Manual pages: renmae man->man3 to follow existing conventions. Add files _Exit.3...

[pdclib.old] / man3 / abort.3

diff --git a/man3/abort.3 b/man3/abort.3
new file mode 100644 (file)
index 0000000..4062011
--- /dev/null
+++ b/man3/abort.3
@@ -0,0 +1,52 @@
+.\" This file is part of the Public Domain C Library (PDCLib).\r
+.\" Permission is granted to use, modify, and / or redistribute at will.\r
+.\"\r
+.Dd\r
+.Dt abort 3\r
+.Os\r
+\r
+.Sh NAME\r
+.Nm abort\r
+.Nd abnormal process termination\r
+\r
+.Sh SYNOPSIS\r
+.In stdlib.h\r
+.Fn "noreturn void abort" "void"\r
+\r
+.Sh DESCRIPTION\r
+.Fn abort\r
+causes abnormal process termination to occur.\r
+\r
+.Pp\r
+First,\r
+.Dv SIGABRT\r
+will be raised, as if by\r
+.Fn raise SIGABRT .\r
+If the signal is not being caught, or the handler which catches the signal \r
+returns, \r
+.Fn abort\r
+will then proceed to cause the process to terminate with a failure exit status.\r
+It is implementation defined whether any open\r
+.Vt FILE\r
+streams are flushed before the process exits.\r
+\r
+.Sh IMPLEMENTATION NOTES\r
+PDCLib implements termination (in the case that the \r
+.Dv SIGABRT\r
+handler returns) by calling\r
+.Fn _Exit EXIT_FAILURE .\r
+Therefore, stream flushing rules for\r
+.Nm\r
+follow those defined for\r
+.Fn _Exit .\r
+\r
+.Sh SEE ALSO\r
+.Xr exit 3\r
+.Xr quick_exit 3\r
+.Xr _Exit 3\r
+.Xr raise 3\r
+\r
+.Sh STANDARDS\r
+.Fn abort\r
+is first defined in\r
+.St -isoC-90 .
\ No newline at end of file