usr/src/man/man3lib/libpthread.3lib

   1 '\" te
   2 .\" Copyright (c) 2014, Joyent, Inc.
   3 .\" Copyright (c) 2004, Sun Microsystems, Inc.  All Rights Reserved.
   4 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   5 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   6 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   7 .TH LIBPTHREAD 3LIB "Oct 1, 2014"
   8 .SH NAME
   9 libpthread \- POSIX threads library
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 cc -mt [ \fIflag\fR... ] \fIfile\fR... \fB-lpthread\fR [ \fB -lrt \fR \fIlibrary\fR... ]
  14 .fi
  15
  16 .SH DESCRIPTION
  17 .LP
  18 Historically, functions in this library provided POSIX threading support. See
  19 \fBstandards\fR(5). This functionality now resides in \fBlibc\fR(3LIB).
  20 .LP
  21 This library is maintained to provide backward compatibility for both runtime
  22 and compilation environments. The shared object is implemented as a filter on
  23 \fBlibc.so.1\fR. New application development need not specify \fB-lpthread\fR
  24 although doing so has no effect.
  25 .SH INTERFACES
  26 .LP
  27 The shared object \fBlibpthread.so.1\fR provides the public interfaces defined
  28 below. See \fBIntro\fR(3) for additional information on shared object
  29 interfaces.
  30 .sp
  31
  32 .sp
  33 .TS
  34 l l
  35 l l .
  36 \fB__pthread_cleanup_pop\fR     \fB__pthread_cleanup_push\fR
  37 \fBpthread_attr_destroy\fR      \fBpthread_attr_getdetachstate\fR
  38 \fBpthread_attr_getguardsize\fR \fBpthread_attr_getinheritsched\fR
  39 \fBpthread_attr_getschedparam\fR        \fBpthread_attr_getschedpolicy\fR
  40 \fBpthread_attr_getscope\fR     \fBpthread_attr_getstackaddr\fR
  41 \fBpthread_attr_getstacksize\fR \fBpthread_attr_init\fR
  42 \fBpthread_attr_setdetachstate\fR       \fBpthread_attr_setguardsize\fR
  43 \fBpthread_attr_setinheritsched\fR      \fBpthread_attr_setschedparam\fR
  44 \fBpthread_attr_setschedpolicy\fR       \fBpthread_attr_setscope\fR
  45 \fBpthread_attr_setstackaddr\fR \fBpthread_attr_setstacksize\fR
  46 \fBpthread_cancel\fR    \fBpthread_cond_broadcast\fR
  47 \fBpthread_cond_destroy\fR      \fBpthread_cond_init\fR
  48 \fBpthread_cond_reltimedwait_np\fR      \fBpthread_cond_signal\fR
  49 \fBpthread_cond_timedwait\fR    \fBpthread_cond_wait\fR
  50 \fBpthread_condattr_destroy\fR  \fBpthread_condattr_getpshared\fR
  51 \fBpthread_condattr_init\fR     \fBpthread_condattr_setpshared\fR
  52 \fBpthread_create\fR    \fBpthread_detach\fR
  53 \fBpthread_equal\fR     \fBpthread_exit\fR
  54 \fBpthread_getconcurrency\fR    \fBpthread_getschedparam\fR
  55 \fBpthread_getspecific\fR       \fBpthread_join\fR
  56 \fBpthread_key_create\fR        \fBpthread_key_delete\fR
  57 \fBpthread_kill\fR      \fBpthread_mutex_consistent_np\fR
  58 \fBpthread_mutex_destroy\fR     \fBpthread_mutex_getprioceiling\fR
  59 \fBpthread_mutex_init\fR        \fBpthread_mutex_lock\fR
  60 \fBpthread_mutex_setprioceiling\fR      \fBpthread_mutex_trylock\fR
  61 \fBpthread_mutex_unlock\fR      \fBpthread_mutexattr_destroy\fR
  62 \fBpthread_mutexattr_getprioceiling\fR  \fBpthread_mutexattr_getprotocol\fR
  63 \fBpthread_mutexattr_getpshared\fR      \fBpthread_mutexattr_getrobust_np\fR
  64 \fBpthread_mutexattr_gettype\fR \fBpthread_mutexattr_init\fR
  65 \fBpthread_mutexattr_setprioceiling\fR  \fBpthread_mutexattr_setprotocol\fR
  66 \fBpthread_mutexattr_setpshared\fR      \fBpthread_mutexattr_setrobust_np\fR
  67 \fBpthread_mutexattr_settype\fR \fBpthread_once\fR
  68 \fBpthread_rwlock_destroy\fR    \fBpthread_rwlock_init\fR
  69 \fBpthread_rwlock_rdlock\fR     \fBpthread_rwlock_tryrdlock\fR
  70 \fBpthread_rwlock_trywrlock\fR  \fBpthread_rwlock_unlock\fR
  71 \fBpthread_rwlock_wrlock\fR     \fBpthread_rwlockattr_destroy\fR
  72 \fBpthread_rwlockattr_getpshared\fR     \fBpthread_rwlockattr_init\fR
  73 \fBpthread_rwlockattr_setpshared\fR     \fBpthread_self\fR
  74 \fBpthread_setcancelstate\fR    \fBpthread_setcanceltype\fR
  75 \fBpthread_setconcurrency\fR    \fBpthread_setschedparam\fR
  76 \fBpthread_setspecific\fR       \fBpthread_sigmask\fR
  77 \fBpthread_testcancel\fR
  78 .TE
  79
  80 .SH FILES
  81 .ne 2
  82 .na
  83 \fB\fB/lib/libpthread.so.1\fR\fR
  84 .ad
  85 .RS 27n
  86 a filter on \fB/lib/libc.so.1\fR
  87 .RE
  88
  89 .sp
  90 .ne 2
  91 .na
  92 \fB\fB/lib/64/libpthread.so.1\fR\fR
  93 .ad
  94 .RS 27n
  95 a filter on \fB/lib/64/libc.so.1\fR
  96 .RE
  97
  98 .SH ATTRIBUTES
  99 .LP
 100 See \fBattributes\fR(5) for descriptions of the following attributes:
 101 .sp
 102
 103 .sp
 104 .TS
 105 box;
 106 c | c
 107 l | l .
 108 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 109 _
 110 MT-Level        Safe
 111 .TE
 112
 113 .SH SEE ALSO
 114 .LP
 115 \fBpvs\fR(1), \fBIntro\fR(2), \fBIntro\fR(3), \fBlibc\fR(3LIB),
 116 \fBlibc_db\fR(3LIB), \fBlibthread\fR(3LIB), \fBattributes\fR(5),
 117 \fBstandards\fR(5), \fBthreads\fR(5)