108 lines
3.2 KiB
Groff
108 lines
3.2 KiB
Groff
.\" Copyright (c) 1986, 1991, 1993
|
|
.\" The Regents of the University of California. All rights reserved.
|
|
.\"
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
.\" modification, are permitted provided that the following conditions
|
|
.\" are met:
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
.\" 3. All advertising materials mentioning features or use of this software
|
|
.\" must display the following acknowledgement:
|
|
.\" This product includes software developed by the University of
|
|
.\" California, Berkeley and its contributors.
|
|
.\" 4. Neither the name of the University nor the names of its contributors
|
|
.\" may be used to endorse or promote products derived from this software
|
|
.\" without specific prior written permission.
|
|
.\"
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
|
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
|
|
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
.\" SUCH DAMAGE.
|
|
.\"
|
|
.\" @(#)usleep.3 8.1 (Berkeley) 6/4/93
|
|
.\"
|
|
.Dd June 4, 1993
|
|
.Dt USLEEP 3
|
|
.Os BSD 4.3
|
|
.Sh NAME
|
|
.Nm usleep
|
|
.Nd suspend execution for interval of microseconds
|
|
.Sh SYNOPSIS
|
|
.Fd #include <unistd.h>
|
|
.Ft int
|
|
.Fn usleep "u_int microseconds"
|
|
.Sh DESCRIPTION
|
|
The
|
|
.Fn usleep
|
|
function
|
|
suspends execution of the calling process
|
|
for
|
|
.Fa microseconds
|
|
of time.
|
|
System activity or time spent in processing the
|
|
call may lengthen the sleep slightly.
|
|
.Pp
|
|
The
|
|
.Fa microseconds
|
|
argument must be less than 1000000.
|
|
.Pp
|
|
If a timer is already running on the process its state is unaltered by
|
|
this
|
|
.Fn usleep
|
|
implementation.
|
|
If the value
|
|
.Fa microseconds
|
|
is more than or equal to the remaining clock time for the running timer,
|
|
the sleep time is set to
|
|
the remaining clock time.
|
|
.Pp
|
|
This function is implemented using
|
|
.Xr nanosleep 2
|
|
by pausing for
|
|
.Fa microseconds
|
|
of time or until any signal occurse.
|
|
.Sh RETURN VALUES
|
|
The
|
|
.Fn usleep
|
|
function returns 0 on successful completion. Otherwise, it returns -1
|
|
and sets
|
|
.Va errno
|
|
to indicate the error.
|
|
.Sh ERRORS
|
|
The
|
|
.Fn usleep
|
|
function
|
|
will fail if:
|
|
.Bl -tag -width [EINVAL]
|
|
.It Bq Er EINTR
|
|
Some signal occurse.
|
|
.It Bq Er EINVAL
|
|
The
|
|
.Fa microseconds
|
|
argument specified 1000000 or more microseconds.
|
|
.Sh NOTES
|
|
.Pp
|
|
A microsecond is 0.000001 seconds.
|
|
.Sh SEE ALSO
|
|
.Xr nanosleep 2 ,
|
|
.Xr setitimer 2 ,
|
|
.Xr alarm 3 ,
|
|
.Xr signal 3 ,
|
|
.Xr sleep 3 ,
|
|
.Xr ualarm 3
|
|
.Sh HISTORY
|
|
The
|
|
.Fn usleep
|
|
function appeared in
|
|
.Bx 4.3 .
|