gen/FreeBSD/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.16 2004/07/02 23:52:10 ru Exp $
  34 .\"
  35 .Dd February 13, 1998
  36 .Dt SLEEP 3
  37 .Os
  38 .Sh NAME
  39 .Nm sleep
  40 .Nd suspend process execution for an interval measured in seconds
  41 .Sh LIBRARY
  42 .Lb libc
  43 .Sh SYNOPSIS
  44 .In unistd.h
  45 .Ft unsigned int
  46 .Fn sleep "unsigned int seconds"
  47 .Sh DESCRIPTION
  48 The
  49 .Fn sleep
  50 function suspends execution of the calling process until either
  51 .Fa seconds
  52 seconds have elapsed or a signal is delivered to the process and its
  53 action is to invoke a signal-catching function or to terminate the
  54 process.
  55 System activity may lengthen the sleep by an indeterminate amount.
  56 .Pp
  57 This function is implemented using
  58 .Xr nanosleep 2
  59 by pausing for
  60 .Fa seconds
  61 seconds or until a signal occurs.
  62 Consequently, in this implementation,
  63 sleeping has no effect on the state of process timers,
  64 and there is no special handling for SIGALRM.
  65 .Sh RETURN VALUES
  66 If the
  67 .Fn sleep
  68 function returns because the requested time has elapsed, the value
  69 returned will be zero.
  70 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 .