new documentation

10 files changed, 436 insertions, 0 deletions

diff --git a/lib/libc_r/man/getc_unlocked.3 b/lib/libc_r/man/getc_unlocked.3
new file mode 100644
index 00000000000..75144930884
--- /dev/null
+++ b/lib/libc_r/man/getc_unlocked.3
@@ -0,0 +1,47 @@
+.\" $OpenBSD: getc_unlocked.3,v 1.1 1999/03/22 04:12:57 d Exp $
+.\" David Leonard <d@openbsd.org>, 1999. Public domain.
+.Dd March 20, 1999
+.Os
+.Dt GETC_UNLOCKED 3
+.Sh NAME
+.Nm getc_unlocked ,
+.Nm getchar_unlocked
+.Nd get next character from stream, efficiently
+.Sh SYNOPSIS
+.Fd #include <stdio.h>
+.Ft int
+.Fn getc_unlocked "FILE *stream"
+.Ft int
+.Fn getchar_unlocked
+.Sh DESCRIPTION
+The
+.Fn getc_unlocked
+and
+.Fn getchar_unlocked
+functions are equivalent to their locked counterparts,
+.Xr getc 3
+and
+.Xr getchar 3 .
+However,
+.Fn getc_unlocked
+and
+.Fn getchar_unlocked
+assume that the relevant stream has either been previous locked
+with
+.Xr flockfile 3 ,
+or that it will not be accessed by any other thread.
+.Sh RETURN VALUES
+The return values are as described for
+.Xr getc 3
+and
+.Xr getchar 3 .
+.Sh SEE ALSO
+.Xr getc 3 ,
+.Xr getchar 3
+.Sh STANDARDS
+.Fn getc_unlocked
+and
+.Fn getchar_unlocked
+conform to ISO/IEC 9945-1 ANSI/IEEE
+.Pq Dq Tn POSIX
+Std 1003.1 Second Edition 1996-07-12.
diff --git a/lib/libc_r/man/pthread_sigmask.3 b/lib/libc_r/man/pthread_sigmask.3
new file mode 100644
index 00000000000..6ce85538cd3
--- /dev/null
+++ b/lib/libc_r/man/pthread_sigmask.3
@@ -0,0 +1,31 @@
+.\" $OpenBSD: pthread_sigmask.3,v 1.1 1999/03/22 04:12:57 d Exp $
+.Dd March 21, 1999
+.Os
+.Dt PTHREAD_SIGMASK 3
+.Sh NAME
+.Nm pthread_sigmask
+.Nd manipulate the current thread's signal mask
+.Sh SYNOPSIS
+.Fd #include <pthread.h>
+.Fd #include <signal.h>
+.Ft int
+.Fn pthread_sigmask "int how" "const sigset_t *set" "sigset_t *oset"
+.Sh DESCRIPTION
+The
+.Fn pthread_sigmask
+function is identical to
+.Xr sigprocmask 2 ,
+except that it only affects the signal mask of the calling thread.
+.Sh RETURN VALUES
+The return values of
+.Fn pthread_sigmask
+are the same as
+.Xr sigprocmask 2 .
+.Sh SEE ALSO
+.Xr pthreads 3 ,
+.Xr sigprocmask 2 .
+.Sh STANDARDS
+.Fn pthread_sigmask
+conforms to ISO/IEC 9945-1 ANSI/IEEE
+.Pq Dq Tn POSIX
+Std 1003.1 Second Edition 1996-07-12.
diff --git a/lib/libc_r/man/pthread_single_np.3 b/lib/libc_r/man/pthread_single_np.3
new file mode 100644
index 00000000000..f48671d429a
--- /dev/null
+++ b/lib/libc_r/man/pthread_single_np.3
@@ -0,0 +1,41 @@
+.\" $OpenBSD: pthread_single_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_SINGLE_NP 3
+.Sh NAME
+.Nm pthread_single_np ,
+.Nm pthread_multi_np
+.Nd switch thread scheduling mode
+.Sh SYNOPSIS
+.Fd #include <pthread.h>
+.Fd #include <pthread_np.h>
+.Ft int
+.Fn pthread_single_np void
+.Ft int
+.Fn pthread_multi_np void
+.Sh DESCRIPTION
+The
+.Fn pthread_single_np
+function causes the process to 
+enter single-threaded (non-POSIX) scheduling mode.
+.Pp
+The
+.Fn pthread_multi_np
+function causes the process to 
+return to multi-threaded scheduling mode.
+.Sh RETURN VALUES
+The
+.Fn pthread_single_np
+and
+.Fn pthread_multi_np
+functions return zero on success, or an error number on failure.
+.Sh SEE ALSO
+.Xr pthreads 3
+.Sh STANDARDS
+The
+.Fn pthread_single_np
+and
+.Fn pthread_multi_np
+functions are non-portable and may not be supported with the above
+semantics on other POSIX systems.
diff --git a/lib/libc_r/man/pthread_suspend_np.3 b/lib/libc_r/man/pthread_suspend_np.3
new file mode 100644
index 00000000000..49f3ea23ab0
--- /dev/null
+++ b/lib/libc_r/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.
diff --git a/lib/libc_r/man/putc_unlocked.3 b/lib/libc_r/man/putc_unlocked.3
new file mode 100644
index 00000000000..a2c538952d7
--- /dev/null
+++ b/lib/libc_r/man/putc_unlocked.3
@@ -0,0 +1,47 @@
+.\" $OpenBSD: putc_unlocked.3,v 1.1 1999/03/22 04:12:57 d Exp $
+.\" David Leonard <d@openbsd.org>, 1998. Public domain.
+.Dd March 20, 1999
+.Os
+.Dt PUTC_UNLOCKED 3
+.Sh NAME
+.Nm putc_unlocked ,
+.Nm putchar_unlocked
+.Nd put next character from stream, efficiently
+.Sh SYNOPSIS
+.Fd #include <stdio.h>
+.Ft int
+.Fn putc_unlocked "int c" "FILE *stream"
+.Ft int
+.Fn putchar_unlocked "int c"
+.Sh DESCRIPTION
+The
+.Fn putc_unlocked
+and
+.Fn putchar_unlocked
+functions are equivalent to their locked counterparts,
+.Xr putc 3
+and
+.Xr putchar 3 .
+However,
+.Fn putc_unlocked
+and
+.Fn putchar_unlocked
+assume that the relevant stream has either been previous locked
+with
+.Xr flockfile 3 ,
+or that it will not be accessed by any other thread.
+.Sh RETURN VALUES
+The return values are as described for
+.Xr putc 3
+and
+.Xr putchar 3 .
+.Sh SEE ALSO
+.Xr putc 3 ,
+.Xr putchar 3
+.Sh STANDARDS
+.Fn putc_unlocked
+and
+.Fn putchar_unlocked
+conform to ISO/IEC 9945-1 ANSI/IEEE
+.Pq Dq Tn POSIX
+Std 1003.1 Second Edition 1996-07-12.
diff --git a/lib/libpthread/man/getc_unlocked.3 b/lib/libpthread/man/getc_unlocked.3
new file mode 100644
index 00000000000..75144930884
--- /dev/null
+++ b/lib/libpthread/man/getc_unlocked.3
@@ -0,0 +1,47 @@
+.\" $OpenBSD: getc_unlocked.3,v 1.1 1999/03/22 04:12:57 d Exp $
+.\" David Leonard <d@openbsd.org>, 1999. Public domain.
+.Dd March 20, 1999
+.Os
+.Dt GETC_UNLOCKED 3
+.Sh NAME
+.Nm getc_unlocked ,
+.Nm getchar_unlocked
+.Nd get next character from stream, efficiently
+.Sh SYNOPSIS
+.Fd #include <stdio.h>
+.Ft int
+.Fn getc_unlocked "FILE *stream"
+.Ft int
+.Fn getchar_unlocked
+.Sh DESCRIPTION
+The
+.Fn getc_unlocked
+and
+.Fn getchar_unlocked
+functions are equivalent to their locked counterparts,
+.Xr getc 3
+and
+.Xr getchar 3 .
+However,
+.Fn getc_unlocked
+and
+.Fn getchar_unlocked
+assume that the relevant stream has either been previous locked
+with
+.Xr flockfile 3 ,
+or that it will not be accessed by any other thread.
+.Sh RETURN VALUES
+The return values are as described for
+.Xr getc 3
+and
+.Xr getchar 3 .
+.Sh SEE ALSO
+.Xr getc 3 ,
+.Xr getchar 3
+.Sh STANDARDS
+.Fn getc_unlocked
+and
+.Fn getchar_unlocked
+conform to ISO/IEC 9945-1 ANSI/IEEE
+.Pq Dq Tn POSIX
+Std 1003.1 Second Edition 1996-07-12.
diff --git a/lib/libpthread/man/pthread_sigmask.3 b/lib/libpthread/man/pthread_sigmask.3
new file mode 100644
index 00000000000..6ce85538cd3
--- /dev/null
+++ b/lib/libpthread/man/pthread_sigmask.3
@@ -0,0 +1,31 @@
+.\" $OpenBSD: pthread_sigmask.3,v 1.1 1999/03/22 04:12:57 d Exp $
+.Dd March 21, 1999
+.Os
+.Dt PTHREAD_SIGMASK 3
+.Sh NAME
+.Nm pthread_sigmask
+.Nd manipulate the current thread's signal mask
+.Sh SYNOPSIS
+.Fd #include <pthread.h>
+.Fd #include <signal.h>
+.Ft int
+.Fn pthread_sigmask "int how" "const sigset_t *set" "sigset_t *oset"
+.Sh DESCRIPTION
+The
+.Fn pthread_sigmask
+function is identical to
+.Xr sigprocmask 2 ,
+except that it only affects the signal mask of the calling thread.
+.Sh RETURN VALUES
+The return values of
+.Fn pthread_sigmask
+are the same as
+.Xr sigprocmask 2 .
+.Sh SEE ALSO
+.Xr pthreads 3 ,
+.Xr sigprocmask 2 .
+.Sh STANDARDS
+.Fn pthread_sigmask
+conforms to ISO/IEC 9945-1 ANSI/IEEE
+.Pq Dq Tn POSIX
+Std 1003.1 Second Edition 1996-07-12.
diff --git a/lib/libpthread/man/pthread_single_np.3 b/lib/libpthread/man/pthread_single_np.3
new file mode 100644
index 00000000000..f48671d429a
--- /dev/null
+++ b/lib/libpthread/man/pthread_single_np.3
@@ -0,0 +1,41 @@
+.\" $OpenBSD: pthread_single_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_SINGLE_NP 3
+.Sh NAME
+.Nm pthread_single_np ,
+.Nm pthread_multi_np
+.Nd switch thread scheduling mode
+.Sh SYNOPSIS
+.Fd #include <pthread.h>
+.Fd #include <pthread_np.h>
+.Ft int
+.Fn pthread_single_np void
+.Ft int
+.Fn pthread_multi_np void
+.Sh DESCRIPTION
+The
+.Fn pthread_single_np
+function causes the process to 
+enter single-threaded (non-POSIX) scheduling mode.
+.Pp
+The
+.Fn pthread_multi_np
+function causes the process to 
+return to multi-threaded scheduling mode.
+.Sh RETURN VALUES
+The
+.Fn pthread_single_np
+and
+.Fn pthread_multi_np
+functions return zero on success, or an error number on failure.
+.Sh SEE ALSO
+.Xr pthreads 3
+.Sh STANDARDS
+The
+.Fn pthread_single_np
+and
+.Fn pthread_multi_np
+functions are non-portable and may not be supported with the above
+semantics on other POSIX systems.
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.
diff --git a/lib/libpthread/man/putc_unlocked.3 b/lib/libpthread/man/putc_unlocked.3
new file mode 100644
index 00000000000..a2c538952d7
--- /dev/null
+++ b/lib/libpthread/man/putc_unlocked.3
@@ -0,0 +1,47 @@
+.\" $OpenBSD: putc_unlocked.3,v 1.1 1999/03/22 04:12:57 d Exp $
+.\" David Leonard <d@openbsd.org>, 1998. Public domain.
+.Dd March 20, 1999
+.Os
+.Dt PUTC_UNLOCKED 3
+.Sh NAME
+.Nm putc_unlocked ,
+.Nm putchar_unlocked
+.Nd put next character from stream, efficiently
+.Sh SYNOPSIS
+.Fd #include <stdio.h>
+.Ft int
+.Fn putc_unlocked "int c" "FILE *stream"
+.Ft int
+.Fn putchar_unlocked "int c"
+.Sh DESCRIPTION
+The
+.Fn putc_unlocked
+and
+.Fn putchar_unlocked
+functions are equivalent to their locked counterparts,
+.Xr putc 3
+and
+.Xr putchar 3 .
+However,
+.Fn putc_unlocked
+and
+.Fn putchar_unlocked
+assume that the relevant stream has either been previous locked
+with
+.Xr flockfile 3 ,
+or that it will not be accessed by any other thread.
+.Sh RETURN VALUES
+The return values are as described for
+.Xr putc 3
+and
+.Xr putchar 3 .
+.Sh SEE ALSO
+.Xr putc 3 ,
+.Xr putchar 3
+.Sh STANDARDS
+.Fn putc_unlocked
+and
+.Fn putchar_unlocked
+conform to ISO/IEC 9945-1 ANSI/IEEE
+.Pq Dq Tn POSIX
+Std 1003.1 Second Edition 1996-07-12.