xref: /minix3/lib/libc/gen/sleep.3 (revision 2fe8fb192fe7e8720e3e7a77f928da545e872a6a)
1*2fe8fb19SBen Gras.\"	$NetBSD: sleep.3,v 1.15 2003/08/07 16:42:57 agc Exp $
2*2fe8fb19SBen Gras.\"
3*2fe8fb19SBen Gras.\" Copyright (c) 1986, 1991, 1993
4*2fe8fb19SBen Gras.\"	The Regents of the University of California.  All rights reserved.
5*2fe8fb19SBen Gras.\"
6*2fe8fb19SBen Gras.\" Redistribution and use in source and binary forms, with or without
7*2fe8fb19SBen Gras.\" modification, are permitted provided that the following conditions
8*2fe8fb19SBen Gras.\" are met:
9*2fe8fb19SBen Gras.\" 1. Redistributions of source code must retain the above copyright
10*2fe8fb19SBen Gras.\"    notice, this list of conditions and the following disclaimer.
11*2fe8fb19SBen Gras.\" 2. Redistributions in binary form must reproduce the above copyright
12*2fe8fb19SBen Gras.\"    notice, this list of conditions and the following disclaimer in the
13*2fe8fb19SBen Gras.\"    documentation and/or other materials provided with the distribution.
14*2fe8fb19SBen Gras.\" 3. Neither the name of the University nor the names of its contributors
15*2fe8fb19SBen Gras.\"    may be used to endorse or promote products derived from this software
16*2fe8fb19SBen Gras.\"    without specific prior written permission.
17*2fe8fb19SBen Gras.\"
18*2fe8fb19SBen Gras.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
19*2fe8fb19SBen Gras.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20*2fe8fb19SBen Gras.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21*2fe8fb19SBen Gras.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
22*2fe8fb19SBen Gras.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23*2fe8fb19SBen Gras.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24*2fe8fb19SBen Gras.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25*2fe8fb19SBen Gras.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26*2fe8fb19SBen Gras.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27*2fe8fb19SBen Gras.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28*2fe8fb19SBen Gras.\" SUCH DAMAGE.
29*2fe8fb19SBen Gras.\"
30*2fe8fb19SBen Gras.\"     @(#)sleep.3	8.1 (Berkeley) 6/4/93
31*2fe8fb19SBen Gras.\"
32*2fe8fb19SBen Gras.Dd June 4, 1993
33*2fe8fb19SBen Gras.Dt SLEEP 3
34*2fe8fb19SBen Gras.Os
35*2fe8fb19SBen Gras.Sh NAME
36*2fe8fb19SBen Gras.Nm sleep
37*2fe8fb19SBen Gras.Nd suspend process execution for interval of seconds
38*2fe8fb19SBen Gras.Sh LIBRARY
39*2fe8fb19SBen Gras.Lb libc
40*2fe8fb19SBen Gras.Sh SYNOPSIS
41*2fe8fb19SBen Gras.In unistd.h
42*2fe8fb19SBen Gras.Ft unsigned int
43*2fe8fb19SBen Gras.Fn sleep "unsigned int seconds"
44*2fe8fb19SBen Gras.Sh DESCRIPTION
45*2fe8fb19SBen GrasThe
46*2fe8fb19SBen Gras.Fn sleep
47*2fe8fb19SBen Grasfunction suspends execution of the calling process until either the
48*2fe8fb19SBen Grasnumber of seconds specified by
49*2fe8fb19SBen Gras.Fa seconds
50*2fe8fb19SBen Grashave elapsed or a signal is delivered to the calling process and its
51*2fe8fb19SBen Grasaction is to invoke a signal-catching function or to terminate the
52*2fe8fb19SBen Grasprocess.
53*2fe8fb19SBen GrasThe suspension time may be longer than requested due to the
54*2fe8fb19SBen Grasscheduling of other activity by the system.
55*2fe8fb19SBen Gras.Sh RETURN VALUES
56*2fe8fb19SBen GrasIf the
57*2fe8fb19SBen Gras.Fn sleep
58*2fe8fb19SBen Grasfunction returns because the requested time has elapsed, the value
59*2fe8fb19SBen Grasreturned will be zero.
60*2fe8fb19SBen GrasIf the
61*2fe8fb19SBen Gras.Fn sleep
62*2fe8fb19SBen Grasfunction returns due to the delivery of a signal, the value returned
63*2fe8fb19SBen Graswill be the unslept amount (the request time minus the time actually
64*2fe8fb19SBen Grasslept) in seconds.
65*2fe8fb19SBen Gras.Sh SEE ALSO
66*2fe8fb19SBen Gras.Xr nanosleep 2 ,
67*2fe8fb19SBen Gras.Xr usleep 3
68*2fe8fb19SBen Gras.Sh STANDARDS
69*2fe8fb19SBen GrasThe
70*2fe8fb19SBen Gras.Fn sleep
71*2fe8fb19SBen Grasfunction conforms to
72*2fe8fb19SBen Gras.St -p1003.1-90 .
73*2fe8fb19SBen Gras.Sh HISTORY
74*2fe8fb19SBen GrasA
75*2fe8fb19SBen Gras.Fn sleep
76*2fe8fb19SBen Grasfunction appeared in
77*2fe8fb19SBen Gras.At v7 .
78