Move pthread* manpages to lib/libpthread as they are not libc_r specific.
[dragonfly.git] / lib / libpthread / pthread_equal.3
CommitLineData
984263bc
MD
1.\" Copyright (c) 1996 John Birrell <jb@cimlogic.com.au>.
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\" notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\" notice, this list of conditions and the following disclaimer in the
11.\" documentation and/or other materials provided with the distribution.
12.\" 3. All advertising materials mentioning features or use of this software
13.\" must display the following acknowledgement:
14.\" This product includes software developed by John Birrell.
15.\" 4. Neither the name of the author nor the names of any co-contributors
16.\" may be used to endorse or promote products derived from this software
17.\" without specific prior written permission.
18.\"
19.\" THIS SOFTWARE IS PROVIDED BY JOHN BIRRELL AND CONTRIBUTORS ``AS IS'' AND
20.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29.\" SUCH DAMAGE.
30.\"
31.\" $FreeBSD: src/lib/libc_r/man/pthread_equal.3,v 1.4.2.6 2001/12/17 10:08:26 ru Exp $
1de703da 32.\" $DragonFly: src/lib/libc_r/man/pthread_equal.3,v 1.2 2003/06/17 04:26:48 dillon Exp $
984263bc
MD
33.\"
34.Dd April 4, 1996
35.Dt PTHREAD_EQUAL 3
36.Os
37.Sh NAME
38.Nm pthread_equal
39.Nd compare thread IDs
40.Sh LIBRARY
41.Lb libc_r
42.Sh SYNOPSIS
43.In pthread.h
44.Ft int
45.Fn pthread_equal "pthread_t t1" "pthread_t t2"
46.Sh DESCRIPTION
47The
48.Fn pthread_equal
49function compares the thread IDs
50.Fa t1
51and
52.Fa t2 .
53.Sh RETURN VALUES
54The
55.Fn pthread_equal
56function will return non-zero if the thread IDs
57.Fa t1
58and
59.Fa t2
60correspond to the same thread, otherwise it will return zero.
61.Sh ERRORS
62None.
63.Sh SEE ALSO
64.Xr pthread_create 3 ,
65.Xr pthread_exit 3
66.Sh STANDARDS
67.Fn pthread_equal
68conforms to
69.St -p1003.1-96 .