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. 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 .\"
  30 .Dd February 13, 1998
  31 .Dt SLEEP 3
  32 .Os
  33 .Sh NAME
  34 .Nm sleep
  35 .Nd suspend thread execution for an interval measured in seconds
  36 .Sh LIBRARY
  37 .Lb libc
  38 .Sh SYNOPSIS
  39 .In unistd.h
  40 .Ft unsigned int
  41 .Fn sleep "unsigned int seconds"
  42 .Sh DESCRIPTION
  43 The
  44 .Fn sleep
  45 function suspends execution of the calling thread until either
  46 .Fa seconds
  47 seconds have elapsed or a signal is delivered to the thread and its
  48 action is to invoke a signal-catching function or to terminate the
  49 thread or process.
  50 System activity may lengthen the sleep by an indeterminate amount.
  51 .Pp
  52 This function is implemented using
  53 .Xr nanosleep 2
  54 by pausing for
  55 .Fa seconds
  56 seconds or until a signal occurs.
  57 Consequently, in this implementation,
  58 sleeping has no effect on the state of process timers,
  59 and there is no special handling for SIGALRM.
  60 .Sh RETURN VALUES
  61 If the
  62 .Fn sleep
  63 function returns because the requested time has elapsed, the value
  64 returned will be zero.
  65 If the
  66 .Fn sleep
  67 function returns due to the delivery of a signal, the value returned
  68 will be the unslept amount (the requested time minus the time actually
  69 slept) in seconds.
  70 .Sh SEE ALSO
  71 .Xr nanosleep 2 ,
  72 .Xr usleep 3
  73 .Sh STANDARDS
  74 The
  75 .Fn sleep
  76 function conforms to
  77 .St -p1003.1-90 .
  78 .Sh HISTORY
  79 A
  80 .Fn sleep
  81 function appeared in
  82 .At v7 .