pthread*.3: Sync the pthread manpages with FreeBSD.
[dragonfly.git] / lib / libpthread / pthread_yield.3
1 .\" $OpenBSD: pthread_yield.3,v 1.3 2004/01/25 14:48:32 jmc Exp $
2 .\"
3 .\" PUBLIC DOMAIN: No Rights Reserved. Marco S Hyman <marc@snafu.org>
4 .\"
5 .\" $FreeBSD: src/share/man/man3/pthread_yield.3,v 1.2 2007/10/22 10:08:01 ru Exp $
6 .\"
7 .Dd July 10, 2009
8 .Dt PTHREAD_YIELD 3
9 .Os
10 .Sh NAME
11 .Nm pthread_yield
12 .Nd yield control of the current thread
13 .Sh LIBRARY
14 .Lb libpthread
15 .Sh SYNOPSIS
16 .In pthread.h
17 .Ft void
18 .Fn pthread_yield void
19 .Sh DESCRIPTION
20 The
21 .Fn pthread_yield
22 forces the running thread to relinquish the processor until it again
23 becomes the head of its thread list.
24 .Sh SEE ALSO
25 .Xr sched_yield 2
26 .Sh STANDARDS
27 The
28 .Fn pthread_yield
29 is a non-portable (but quite common) extension to
30 .St -p1003.1-2001 .