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 .\" 4. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     @(#)sleep.3     8.1 (Berkeley) 6/4/93
  29 .\" $FreeBSD: src/lib/libc/gen/sleep.3,v 1.12.2.3 2001/12/14 18:33:51 ru Exp $
  30 .\" $DragonFly: src/lib/libc/gen/sleep.3,v 1.3 2007/09/08 20:50:49 swildner Exp $
  31 .\"
  32 .Dd February 13, 1998
  33 .Dt SLEEP 3
  34 .Os
  35 .Sh NAME
  36 .Nm sleep
  37 .Nd suspend process execution for an interval measured in seconds
  38 .Sh LIBRARY
  39 .Lb libc
  40 .Sh SYNOPSIS
  41 .In unistd.h
  42 .Ft unsigned int
  43 .Fn sleep "unsigned int seconds"
  44 .Sh DESCRIPTION
  45 The
  46 .Fn sleep
  47 function suspends execution of the calling process until either
  48 .Fa seconds
  49 seconds have elapsed or a signal is delivered to the process and its
  50 action is to invoke a signal-catching function or to terminate the
  51 process.
  52 System activity may lengthen the sleep by an indeterminate amount.
  53 .Pp
  54 This function is implemented using
  55 .Xr nanosleep 2
  56 by pausing for
  57 .Fa seconds
  58 seconds or until a signal occurs.
  59 Consequently, in this implementation,
  60 sleeping has no effect on the state of process timers,
  61 and there is no special handling for
  62 .Dv SIGALRM .
  63 .Sh RETURN VALUES
  64 If the
  65 .Fn sleep
  66 function returns because the requested time has elapsed, the value
  67 returned will be zero.
  68 If the
  69 .Fn sleep
  70 function returns due to the delivery of a signal, the value returned
  71 will be the unslept amount (the requested time minus the time actually
  72 slept) in seconds.
  73 .Sh SEE ALSO
  74 .Xr nanosleep 2 ,
  75 .Xr usleep 3
  76 .Sh STANDARDS
  77 The
  78 .Fn sleep
  79 function conforms to
  80 .St -p1003.1-90 .
  81 .Sh HISTORY
  82 A
  83 .Fn sleep
  84 function appeared in
  85 .At v7 .