new documentation

1 files changed, 52 insertions, 0 deletions

diff --git a/lib/libpthread/man/pthread_suspend_np.3 b/lib/libpthread/man/pthread_suspend_np.3
new file mode 100644
index 00000000000..49f3ea23ab0
--- /dev/null
+++ b/lib/libpthread/man/pthread_suspend_np.3
@@ -0,0 +1,52 @@
+.\" $OpenBSD: pthread_suspend_np.3,v 1.1 1999/03/22 04:12:57 d Exp $
+.\" David Leonard <d@openbsd.org>, 1999. Public domain.
+.Dd March 21, 1999
+.Os
+.Dt PTHREAD_SUSPEND_NP 3
+.Sh NAME
+.Nm pthread_suspend_np ,
+.Nm pthread_resume_np
+.Nd suspend and resume a thread
+.Sh SYNOPSIS
+.Fd #include <pthread.h>
+.Fd #include <pthread_np.h>
+.Ft int
+.Fn pthread_suspend_np "pthread_t thread"
+.Ft int
+.Fn pthread_resume_np "pthread_t thread"
+.Sh DESCRIPTION
+The
+.Fn pthread_suspend_np
+function interrupts the given thread and places it in a suspended state.
+.Pp
+The
+.Fn pthread_resume_np
+function resumes a thread suspended with
+.Fn pthread_suspend_np .
+It has no effect on threads that have not been suspended.
+.Pp
+Suspending and resuming a thread has an effect similar to that of
+receiving a signal,
+namely that resumed system calls will return an error value of
+.Er EINTR .
+.Sh RETURN VALUES
+The
+.Fn pthread_suspend_np
+and
+.Fn pthread_resume_np
+functions fail if:
+.Bl -tag -width Er
+.It Bq Er ESRCH
+No thread could be found corresponding to that specified by the given
+thread ID.
+.El
+.Sh SEE ALSO
+.Xr pthread_cancel 3 ,
+.Xr pthreads 3
+.Sh STANDARDS
+The
+.Fn pthread_suspend_np
+and
+.Fn pthread_resume_np
+functions are non-portable and may not be supported with the above
+semantics on other POSIX systems.