about summary refs log tree commit diff
path: root/linuxthreads/man/pthread_exit.man
diff options
context:
space:
mode:
Diffstat (limited to 'linuxthreads/man/pthread_exit.man')
-rw-r--r--linuxthreads/man/pthread_exit.man32
1 files changed, 32 insertions, 0 deletions
diff --git a/linuxthreads/man/pthread_exit.man b/linuxthreads/man/pthread_exit.man
new file mode 100644
index 0000000000..54751e9d05
--- /dev/null
+++ b/linuxthreads/man/pthread_exit.man
@@ -0,0 +1,32 @@
+.TH PTHREAD_EXIT 3 LinuxThreads
+
+.SH NAME
+pthread_exit \- terminate the calling thread
+
+.SH SYNOPSIS
+#include <pthread.h>
+
+void pthread_exit(void *retval);
+
+.SH DESCRIPTION
+!pthread_exit! terminates the execution of the calling thread.
+All cleanup handlers that have been set for the calling thread with
+!pthread_cleanup_push!(3) are executed in reverse order (the most
+recently pushed handler is executed first). Finalization functions for
+thread-specific data are then called for all keys that have non-!NULL!
+values associated with them in the calling thread (see
+!pthread_key_create!(3)). Finally, execution of the calling thread is
+stopped.
+
+The |retval| argument is the return value of the thread. It can be
+consulted from another thread using !pthread_join!(3).
+
+.SH "RETURN VALUE"
+The !pthread_exit! function never returns.
+
+.SH AUTHOR
+Xavier Leroy <Xavier.Leroy@inria.fr>
+
+.SH "SEE ALSO"
+!pthread_create!(3),
+!pthread_join!(3).