Libc-1272.250.1.tar.gz

[apple/libc.git] / gen / FreeBSD / usleep.3

diff --git a/gen/FreeBSD/usleep.3 b/gen/FreeBSD/usleep.3
index dc6109689bd0e06df3c2e7591aeba60863408f43..12b9274672474be307175560813566e63e8ea103 100644 (file)
--- a/gen/FreeBSD/usleep.3
+++ b/gen/FreeBSD/usleep.3
@@ -26,14 +26,14 @@
 .\" SUCH DAMAGE.
 .\"
 .\"     @(#)usleep.3   8.1 (Berkeley) 6/4/93
 .\" SUCH DAMAGE.
 .\"
 .\"     @(#)usleep.3   8.1 (Berkeley) 6/4/93

-.\" $FreeBSD: src/lib/libc/gen/usleep.3,v 1.19 2007/01/09 00:27:56 imp Exp $
+.\" $FreeBSD$

 .\"
 .Dd February 13, 1998
 .Dt USLEEP 3
 .Os
 .Sh NAME
 .Nm usleep
 .\"
 .Dd February 13, 1998
 .Dt USLEEP 3
 .Os
 .Sh NAME
 .Nm usleep

-.Nd suspend process execution for an interval measured in microseconds
+.Nd suspend thread execution for an interval measured in microseconds

 .Sh LIBRARY
 .Lb libc
 .Sh SYNOPSIS
 .Sh LIBRARY
 .Lb libc
 .Sh SYNOPSIS


@@ -43,12 +43,12 @@
 .Sh DESCRIPTION
 The
 .Fn usleep
 .Sh DESCRIPTION
 The
 .Fn usleep

-function suspends execution of the calling process until either
+function suspends execution of the calling thread until either

 .Fa microseconds
 .Fa microseconds

-microseconds have elapsed or a signal is delivered to the process and its
+microseconds have elapsed or a signal is delivered to the thread and its

 action is to invoke a signal-catching function or to terminate the
 process.
 action is to invoke a signal-catching function or to terminate the
 process.

-System activity may lengthen the sleep by an indeterminate amount.
+System activity or limitations may lengthen the sleep by an indeterminate amount.

 .Pp
 This function is implemented using
 .Xr nanosleep 2
 .Pp
 This function is implemented using
 .Xr nanosleep 2


@@ -58,6 +58,18 @@ microseconds or until a signal occurs.
 Consequently, in this implementation,
 sleeping has no effect on the state of process timers,
 and there is no special handling for SIGALRM.
 Consequently, in this implementation,
 sleeping has no effect on the state of process timers,
 and there is no special handling for SIGALRM.

+Also, this implementation does not put a limit on the value of
+.Fa microseconds
+(other than that limited by the size of the
+.Ft useconds_t
+type); some other platforms require it to be less than one million.
+.Sh NOTE
+The
+.Fn usleep
+function is obsolescent.
+Use
+.Xr nanosleep 2
+instead.

 .Sh RETURN VALUES
 .Rv -std usleep
 .Sh ERRORS
 .Sh RETURN VALUES
 .Rv -std usleep
 .Sh ERRORS