NetBSD/lib/libc/gen/sleep.3

.\"	$NetBSD: sleep.3,v 1.15 2003/08/07 16:42:57 agc Exp $
.\"
.\" 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. 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 LIBRARY
.Lb libc
.Sh SYNOPSIS
.In unistd.h
.Ft unsigned int
.Fn sleep "unsigned int seconds"
.Sh DESCRIPTION
The
.Fn sleep
function suspends execution of the calling process until either the
number of seconds specified by
.Fa seconds
have elapsed or a signal is delivered to the calling process and its
action is to invoke a signal-catching function or to terminate the
process.
The suspension time may be longer than requested due to the
scheduling of other activity by the system.
.Sh RETURN VALUES
If the
.Fn sleep
function returns because the requested time has elapsed, the value
returned will be zero.
If the
.Fn sleep
function returns due to the delivery of a signal, the value returned
will be the unslept amount (the request time minus the time actually
slept) in seconds.
.Sh SEE ALSO
.Xr nanosleep 2 ,
.Xr usleep 3
.Sh STANDARDS
The
.Fn sleep
function conforms to
.St -p1003.1-90 .
.Sh HISTORY
A
.Fn sleep
function appeared in
.At v7 .
Move UCB-licensed code from 4-clause to 3-clause licence. Patches provided by Joel Baker in PR 22280, verified by myself. 2003-08-07 20:42:00 +04:00			`.\" $NetBSD: sleep.3,v 1.15 2003/08/07 16:42:57 agc Exp $`
merge with 4.4-Lite, keeping local changes. clean up Ids 1995-02-27 08:50:11 +03:00			`.\"`
			`.\" Copyright (c) 1986, 1991, 1993`
			`.\" The Regents of the University of California. All rights reserved.`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.\"`
			`.\" 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.`
Move UCB-licensed code from 4-clause to 3-clause licence. Patches provided by Joel Baker in PR 22280, verified by myself. 2003-08-07 20:42:00 +04:00			`.\" 3. Neither the name of the University nor the names of its contributors`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.\" 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.`
			`.\"`
merge with 4.4-Lite, keeping local changes. clean up Ids 1995-02-27 08:50:11 +03:00			`.\" @(#)sleep.3 8.1 (Berkeley) 6/4/93`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.\"`
merge with 4.4-Lite, keeping local changes. clean up Ids 1995-02-27 08:50:11 +03:00			`.Dd June 4, 1993`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Dt SLEEP 3`
			`.Os`
			`.Sh NAME`
			`.Nm sleep`
			`.Nd suspend process execution for interval of seconds`
add LIBRARY section to man page 1998-02-05 21:45:17 +03:00			`.Sh LIBRARY`
			`.Lb libc`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Sh SYNOPSIS`
Use .In header.h instead of .Fd #include \[Lt]header.h\[Gt] Much easier to read and write, and supported by groff for ages. Okayed by ross. 2003-04-16 17:34:34 +04:00			`.In unistd.h`
Change SYNOPSIS section to use "unsigned" instead of "u_int". 1993-10-15 02:25:28 +03:00			`.Ft unsigned int`
			`.Fn sleep "unsigned int seconds"`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Sh DESCRIPTION`
			`The`
			`.Fn sleep`
Describe POSIX behavior of sleep. More could be added, especially describing the effects of scheduling and/or blocking SIGALRM outside of a sleep(). Also, using longjmp() in a signal handler. But this will do until someone gets inspired to fill in the grotty details. 1994-05-28 20:11:27 +04:00			`function suspends execution of the calling process until either the`
			`number of seconds specified by`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Fa seconds`
Describe POSIX behavior of sleep. More could be added, especially describing the effects of scheduling and/or blocking SIGALRM outside of a sleep(). Also, using longjmp() in a signal handler. But this will do until someone gets inspired to fill in the grotty details. 1994-05-28 20:11:27 +04:00			`have elapsed or a signal is delivered to the calling process and its`
			`action is to invoke a signal-catching function or to terminate the`
New sentence, new line. From Robert Elz. 2002-10-01 20:48:34 +04:00			`process.`
			`The suspension time may be longer than requested due to the`
Describe POSIX behavior of sleep. More could be added, especially describing the effects of scheduling and/or blocking SIGALRM outside of a sleep(). Also, using longjmp() in a signal handler. But this will do until someone gets inspired to fill in the grotty details. 1994-05-28 20:11:27 +04:00			`scheduling of other activity by the system.`
Standardize section headers, sort sections, sort SEE ALSO, punctuation and misc. fixes. 2001-09-16 06:57:03 +04:00			`.Sh RETURN VALUES`
Boring whitespace fixes. 2001-09-16 06:30:23 +04:00			`If the`
Describe POSIX behavior of sleep. More could be added, especially describing the effects of scheduling and/or blocking SIGALRM outside of a sleep(). Also, using longjmp() in a signal handler. But this will do until someone gets inspired to fill in the grotty details. 1994-05-28 20:11:27 +04:00			`.Fn sleep`
			`function returns because the requested time has elapsed, the value`
New sentence, new line. From Robert Elz. 2002-10-01 20:48:34 +04:00			`returned will be zero.`
			`If the`
Describe POSIX behavior of sleep. More could be added, especially describing the effects of scheduling and/or blocking SIGALRM outside of a sleep(). Also, using longjmp() in a signal handler. But this will do until someone gets inspired to fill in the grotty details. 1994-05-28 20:11:27 +04:00			`.Fn sleep`
			`function returns due to the delivery of a signal, the value returned`
			`will be the unslept amount (the request time minus the time actually`
			`slept) in seconds.`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Sh SEE ALSO`
Implement sleep() and usleep() in terms of nanosleep(). Uses only one syscall instead of eight, and doesn't have any interactions with alarm or interval timers. 1997-07-19 06:42:30 +04:00			`.Xr nanosleep 2 ,`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Xr usleep 3`
Change SYNOPSIS section to use "unsigned" instead of "u_int". 1993-10-15 02:25:28 +03:00			`.Sh STANDARDS`
Boring whitespace fixes. 2001-09-16 06:30:23 +04:00			`The`
			`.Fn sleep`
			`function conforms to`
Change SYNOPSIS section to use "unsigned" instead of "u_int". 1993-10-15 02:25:28 +03:00			`.St -p1003.1-90 .`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Sh HISTORY`
			`A`
			`.Fn sleep`
			`function appeared in`
			`.At v7 .`