pthread_equal.3: New page for pthread_equal(3)

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>

diff --git a/man3/pthread_equal.3 b/man3/pthread_equal.3
new file mode 100644 (file)
index 0000000..d29742c
--- /dev/null
+++ b/man3/pthread_equal.3
@@ -0,0 +1,56 @@
+.\" Copyright (c) 2008 Linux Foundation, written by Michael Kerrisk
+.\"     <mtk.manpages@gmail.com>
+.\"
+.\" Permission is granted to make and distribute verbatim copies of this
+.\" manual provided the copyright notice and this permission notice are
+.\" preserved on all copies.
+.\"
+.\" Permission is granted to copy and distribute modified versions of this
+.\" manual under the conditions for verbatim copying, provided that the
+.\" entire resulting derived work is distributed under the terms of a
+.\" permission notice identical to this one.
+.\"
+.\" Since the Linux kernel and libraries are constantly changing, this
+.\" manual page may be incorrect or out-of-date.  The author(s) assume no
+.\" responsibility for errors or omissions, or for damages resulting from
+.\" the use of the information contained herein.  The author(s) may not
+.\" have taken the same level of care in the production of this manual,
+.\" which is licensed free of charge, as they might when working
+.\" professionally.
+.\"
+.\" Formatted or processed versions of this manual, if unaccompanied by
+.\" the source, must acknowledge the copyright and authors of this work.
+.\"
+.TH PTHREAD_EQUAL 3 2008-10-24 "Linux" "Linux Programmer's Manual"
+.SH NAME
+pthread_self \- compare thread IDs
+.SH SYNOPSIS
+.nf
+.B #include <pthread.h>
+
+.BI "int pthread_equal(pthread_t " t1 ", pthread_t " t2 );
+.sp
+Compile and link with \fI\-pthread\fP.
+.SH DESCRIPTION
+The
+.BR pthread_equal ()
+function compares two thread identifiers.
+.SH RETURN VALUE
+If the two thread IDs are equal,
+.BR pthread_equal ()
+returns a non-zero value; otherwise, it returns 0.
+.SH ERRORS
+This function always succeeds.
+.SH CONFORMING TO
+POSIX.1-2001.
+.SH NOTES
+The
+.BR pthread_equal ()
+function is necessary because thread IDs should be considered opaque:
+there is no portable way for applications to directly compare two
+.I pthread_t
+values.
+.SH SEE ALSO
+.BR pthread_create (3),
+.BR pthread_self (3),
+.BR pthreads (7)