intro.1, _exit.2, access.2, alarm.2, alloc_hugepages.2, arch_prctl.2, bind.2, chdir...

[thirdparty/man-pages.git] / man3 / usleep.3

diff --git a/man3/usleep.3 b/man3/usleep.3
index 4e12651645923c81f1b9ea5eaa7d1664963544e1..292df58598eb9d6313ccdce9373ee92f5f668217 100644 (file)
--- a/man3/usleep.3
+++ b/man3/usleep.3
@@ -1,5 +1,6 @@
 .\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
 .\"
+.\" %%%LICENSE_START(VERBATIM)
 .\" Permission is granted to make and distribute verbatim copies of this
 .\" manual provided the copyright notice and this permission notice are
 .\" preserved on all copies.
@@ -19,6 +20,7 @@
 .\"
 .\" Formatted or processed versions of this manual, if unaccompanied by
 .\" the source, must acknowledge the copyright and authors of this work.
+.\" %%%LICENSE_END
 .\"
 .\" References consulted:
 .\"     Linux libc source code
@@ -28,40 +30,66 @@
 .\" Modified 2001-04-01 by aeb
 .\" Modified 2003-07-23 by aeb
 .\"
-.TH USLEEP 3  2007-02-01 "" "Linux Programmer's Manual"
+.TH USLEEP 3  2010-12-03 "" "Linux Programmer's Manual"
 .SH NAME
 usleep \- suspend execution for microsecond intervals
 .SH SYNOPSIS
 .nf
-.B "#define _XOPEN_SOURCE 500     /* Or: #define _BSD_SOURCE */"
-.br
 .B "#include <unistd.h>"
 .sp
 .BI "int usleep(useconds_t " usec );
 .fi
+.sp
+.in -4n
+Feature Test Macro Requirements for glibc (see
+.BR feature_test_macros (7)):
+.in
+.sp
+.BR usleep ():
+.ad l
+.RS 4
+.PD 0
+.TP 4
+Since glibc 2.12:
+.nf
+_BSD_SOURCE ||
+    (_XOPEN_SOURCE\ >=\ 500 ||
+        _XOPEN_SOURCE\ &&\ _XOPEN_SOURCE_EXTENDED) &&
+    !(_POSIX_C_SOURCE\ >=\ 200809L || _XOPEN_SOURCE\ >=\ 700)
+.TP 4
+.fi
+Before glibc 2.12:
+_BSD_SOURCE || _XOPEN_SOURCE\ >=\ 500 ||
+_XOPEN_SOURCE\ &&\ _XOPEN_SOURCE_EXTENDED
+.PD
+.RE
+.ad b
 .SH DESCRIPTION
 The
 .BR usleep ()
-function suspends execution of the calling process for
+function suspends execution of the calling thread for
 (at least) \fIusec\fP microseconds.
 The sleep may be lengthened slightly
 by any system activity or by the time spent processing the call or by the
 granularity of system timers.
-.SH "RETURN VALUE"
+.SH RETURN VALUE
 0 on success, \-1 on error.
 .SH ERRORS
 .TP
-EINTR
-Interrupted by a signal.
+.B EINTR
+Interrupted by a signal; see
+.BR signal (7).
 .TP
-EINVAL
+.B EINVAL
 \fIusec\fP is not smaller than 1000000.
 (On systems where that is considered an error.)
-.SH "CONFORMING TO"
+.SH CONFORMING TO
 4.3BSD, POSIX.1-2001.
 POSIX.1-2001 declares this function obsolete; use
 .BR nanosleep (2)
 instead.
+POSIX.1-2008 removes the specification of
+.BR usleep ().
 
 On the original BSD implementation,
 and in glibc before version 2.2.2, the return type of this function is
@@ -70,26 +98,27 @@ The POSIX version returns
 .IR int ,
 and this is also the prototype used since glibc 2.2.2.
 
-Only the EINVAL error return is documented by SUSv2.
+Only the
+.B EINVAL
+error return is documented by SUSv2 and POSIX.1-2001.
 .SH NOTES
 The type
-.B useconds_t
+.I useconds_t
 is an unsigned integer type capable of holding integers
 in the range [0,1000000].
 Programs will be more portable
 if they never mention this type explicitly.
 Use
-.RS
+.in +4n
 .nf
-.ta 8
 .sp
 #include <unistd.h>
 \&...
     unsigned int usecs;
-\&.
+\&...
     usleep(usecs);
 .fi
-.RE
+.in
 .LP
 The interaction of this function with the
 .B SIGALRM
@@ -98,20 +127,19 @@ signal, and with other timer functions such as
 .BR sleep (3),
 .BR nanosleep (2),
 .BR setitimer (2),
-.BR timer_create (3),
-.BR timer_delete (3),
-.BR timer_getoverrun (3),
-.BR timer_gettime (3),
-.BR timer_settime (3),
+.BR timer_create (2),
+.BR timer_delete (2),
+.BR timer_getoverrun (2),
+.BR timer_gettime (2),
+.BR timer_settime (2),
 .BR ualarm (3)
 is unspecified.
-.SH "SEE ALSO"
+.SH SEE ALSO
 .BR alarm (2),
 .BR getitimer (2),
 .BR nanosleep (2),
 .BR select (2),
 .BR setitimer (2),
-.BR ualarm (3),
 .BR sleep (3),
-.BR feature_test_macros (7),
+.BR ualarm (3),
 .BR time (7)