share/man/man3lib/librt.3lib

   1 '\" te
   2 .\" Copyright (c) 2008, Sun Microsystems, Inc.  All Rights Reserved.
   3 .\" 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.
   4 .\" 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.
   5 .\" 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]
   6 .TH LIBRT 3LIB "Feb 5, 2008"
   7 .SH NAME
   8 librt, libposix4 \- POSIX.1b Realtime Extensions library
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 cc [ \fIflag\fR... ] \fIfile\fR... \fB-lrt\fR [ \fIlibrary\fR... ]
  13 .fi
  14
  15 .SH DESCRIPTION
  16 .sp
  17 .LP
  18 Historically, functions in this library provided many of the interfaces
  19 specified by the POSIX.1b Realtime Extension.  See \fBstandards\fR(5). This
  20 functionality now resides in \fBlibc\fR(3LIB).
  21 .sp
  22 .LP
  23 This library is maintained to provide backward compatibility for both runtime
  24 and compilation environments. The shared      object is implemented as a filter
  25 on libc.so.1. New application development need not specify \fB-lrt\fR.
  26 .SH INTERFACES
  27 .sp
  28 .LP
  29 The shared objects \fBlibrt.so.1\fR and \fBlibposix4.so.1\fR provide the public
  30 interfaces defined below. See \fBIntro\fR(3) for additional information on
  31 shared object interfaces.
  32 .sp
  33
  34 .sp
  35 .TS
  36 l l
  37 l l .
  38 \fBaio_cancel\fR        \fBaio_error\fR
  39 \fBaio_fsync\fR \fBaio_read\fR
  40 \fBaio_return\fR        \fBaio_suspend\fR
  41 \fBaio_waitn\fR \fBaio_write\fR
  42 \fBclock_getres\fR      \fBclock_gettime\fR
  43 \fBclock_nanosleep\fR   \fBclock_settime\fR
  44 \fBclose\fR     \fBfdatasync\fR
  45 \fBfork\fR      \fBlio_listio\fR
  46 \fBmq_close\fR  \fBmq_getattr\fR
  47 \fBmq_notify\fR \fBmq_open\fR
  48 \fBmq_receive\fR        \fBmq_reltimedreceive_np\fR
  49 \fBmq_reltimedsend_np\fR        \fBmq_send\fR
  50 \fBmq_setattr\fR        \fBmq_timedreceive\fR
  51 \fBmq_timedsend\fR      \fBmq_unlink\fR
  52 \fBnanosleep\fR \fBsched_get_priority_max\fR
  53 \fBsched_get_priority_min\fR    \fBsched_getparam\fR
  54 \fBsched_getscheduler\fR        \fBsched_rr_get_interval\fR
  55 \fBsched_setparam\fR    \fBsched_setscheduler\fR
  56 \fBsched_yield\fR       \fBsem_close\fR
  57 \fBsem_destroy\fR       \fBsem_getvalue\fR
  58 \fBsem_init\fR  \fBsem_open\fR
  59 \fBsem_post\fR  \fBsem_reltimedwait_np\fR
  60 \fBsem_timedwait\fR     \fBsem_trywait\fR
  61 \fBsem_unlink\fR        \fBsem_wait\fR
  62 \fBshm_open\fR  \fBshm_unlink\fR
  63 \fBsigqueue\fR  \fBsigtimedwait\fR
  64 \fBsigwaitinfo\fR       \fBtimer_create\fR
  65 \fBtimer_delete\fR      \fBtimer_getoverrun\fR
  66 \fBtimer_gettime\fR     \fBtimer_settime\fR
  67 .TE
  68
  69 .sp
  70 .LP
  71 The following interfaces are unique to the 32-bit version of this library:
  72 .sp
  73
  74 .sp
  75 .TS
  76 l l
  77 l l .
  78 \fBaio_cancel64\fR      \fBaio_error64\fR
  79 \fBaio_fsync64\fR       \fBaio_read64\fR
  80 \fBaio_return64\fR      \fBaio_suspend64\fR
  81 \fBaio_waitn64\fR       \fBaio_write64\fR
  82 \fBlio_listio64\fR
  83 .TE
  84
  85 .SH FILES
  86 .sp
  87 .ne 2
  88 .na
  89 \fB\fB/lib/librt.so.1\fR\fR
  90 .ad
  91 .RS 26n
  92 shared object
  93 .RE
  94
  95 .sp
  96 .ne 2
  97 .na
  98 \fB\fB/lib/64/librt.so.1\fR\fR
  99 .ad
 100 .RS 26n
 101 64-bit shared object file
 102 .RE
 103
 104 .sp
 105 .ne 2
 106 .na
 107 \fB\fB/lib/libposix4.so.1\fR\fR
 108 .ad
 109 .RS 26n
 110 shared object
 111 .RE
 112
 113 .sp
 114 .ne 2
 115 .na
 116 \fB\fB/lib/64/libposix4.so.1\fR\fR
 117 .ad
 118 .RS 26n
 119 64-bit shared object file
 120 .RE
 121
 122 .SH ATTRIBUTES
 123 .sp
 124 .LP
 125 See \fBattributes\fR(5) for descriptions of the following attributes:
 126 .sp
 127
 128 .sp
 129 .TS
 130 box;
 131 c | c
 132 l | l .
 133 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 134 _
 135 MT-Level        Safe
 136 .TE
 137
 138 .SH SEE ALSO
 139 .sp
 140 .LP
 141 \fBpvs\fR(1), \fBIntro\fR(3), \fBlibc\fR(3LIB), \fBattributes\fR(5),
 142 \fBstandards\fR(5)