Merge from vendor branch BZIP:
[dragonfly.git] / lib / libc / gen / sleep.3
1 .\" Copyright (c) 1986, 1991, 1993
2 .\"     The Regents of the University of California.  All rights reserved.
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\"    notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\"    notice, this list of conditions and the following disclaimer in the
11 .\"    documentation and/or other materials provided with the distribution.
12 .\" 3. All advertising materials mentioning features or use of this software
13 .\"    must display the following acknowledgement:
14 .\"     This product includes software developed by the University of
15 .\"     California, Berkeley and its contributors.
16 .\" 4. Neither the name of the University nor the names of its contributors
17 .\"    may be used to endorse or promote products derived from this software
18 .\"    without specific prior written permission.
19 .\"
20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 .\" SUCH DAMAGE.
31 .\"
32 .\"     @(#)sleep.3     8.1 (Berkeley) 6/4/93
33 .\" $FreeBSD: src/lib/libc/gen/sleep.3,v 1.12.2.3 2001/12/14 18:33:51 ru Exp $
34 .\" $DragonFly: src/lib/libc/gen/sleep.3,v 1.2 2003/06/17 04:26:42 dillon Exp $
35 .\"
36 .Dd February 13, 1998
37 .Dt SLEEP 3
38 .Os
39 .Sh NAME
40 .Nm sleep
41 .Nd suspend process execution for an interval measured in seconds
42 .Sh LIBRARY
43 .Lb libc
44 .Sh SYNOPSIS
45 .In unistd.h
46 .Ft unsigned int
47 .Fn sleep "unsigned int seconds"
48 .Sh DESCRIPTION
49 The
50 .Fn sleep
51 function suspends execution of the calling process until either
52 .Fa seconds
53 seconds have elapsed or a signal is delivered to the process and its
54 action is to invoke a signal-catching function or to terminate the
55 process.
56 System activity may lengthen the sleep by an indeterminate amount.
57 .Pp
58 This function is implemented using
59 .Xr nanosleep 2
60 by pausing for
61 .Fa seconds
62 seconds or until a signal occurs.
63 Consequently, in this implementation,
64 sleeping has no effect on the state of process timers,
65 and there is no special handling for SIGALRM.
66 .Sh RETURN VALUES
67 If the
68 .Fn sleep
69 function returns because the requested time has elapsed, the value
70 returned will be zero.  If the
71 .Fn sleep
72 function returns due to the delivery of a signal, the value returned
73 will be the unslept amount (the requested time minus the time actually
74 slept) in seconds.
75 .Sh SEE ALSO
76 .Xr nanosleep 2 ,
77 .Xr usleep 3
78 .Sh STANDARDS
79 The
80 .Fn sleep
81 function conforms to
82 .St -p1003.1-90 .
83 .Sh HISTORY
84 A
85 .Fn sleep
86 function appeared in
87 .At v7 .