summaryrefslogtreecommitdiffstats
path: root/lib/libc/gen/sleep.3
diff options
context:
space:
mode:
Diffstat (limited to 'lib/libc/gen/sleep.3')
-rw-r--r--lib/libc/gen/sleep.390
1 files changed, 90 insertions, 0 deletions
diff --git a/lib/libc/gen/sleep.3 b/lib/libc/gen/sleep.3
new file mode 100644
index 0000000..fa1057e
--- /dev/null
+++ b/lib/libc/gen/sleep.3
@@ -0,0 +1,90 @@
+.\" 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.
+.\"
+.\" @(#)sleep.3 8.1 (Berkeley) 6/4/93
+.\"
+.Dd June 4, 1993
+.Dt SLEEP 3
+.Os
+.Sh NAME
+.Nm sleep
+.Nd suspend process execution for interval of seconds
+.Sh SYNOPSIS
+.Fd #include <unistd.h>
+.Ft u_int
+.Fn sleep "u_int seconds"
+.Sh DESCRIPTION
+The
+.Fn sleep
+function
+suspends execution of the calling process
+for
+.Fa seconds
+of time.
+System activity or time spent in processing the
+call may lengthen the sleep by a second.
+.Pp
+If a timer is already running on the process its state is unaltered by
+this
+.Fn sleep
+implementation.
+If the value
+.Fa seconds
+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 seconds
+of time or until any signal occurse.
+.Sh RETURN VALUES
+The
+.Fn sleep
+function returns the number of seconds remaining to complete the operation. If
+sleep is interrupted or cannot allocate a timer it may will return the value
+needed to be passed to a subsequent sleep to complete the necessary delay.
+.Fn sleep
+repeatedly until it returns zero may busy-wait until a timer
+is available.
+.Sh SEE ALSO
+.Xr nanosleep 2 ,
+.Xr setitimer 2 ,
+.Xr alarm 3 ,
+.Xr signal 3 ,
+.Xr ualarm 3 ,
+.Xr usleep 3
+.Sh HISTORY
+A
+.Fn sleep
+function appeared in
+.At v7 .
OpenPOWER on IntegriCloud