man3/sleep.3

   1 .\" Copyright (c) 1993 by Thomas Koenig (ig25@rz.uni-karlsruhe.de)
   2 .\"
   3 .\" %%%LICENSE_START(VERBATIM)
   4 .\" Permission is granted to make and distribute verbatim copies of this
   5 .\" manual provided the copyright notice and this permission notice are
   6 .\" preserved on all copies.
   7 .\"
   8 .\" Permission is granted to copy and distribute modified versions of this
   9 .\" manual under the conditions for verbatim copying, provided that the
  10 .\" entire resulting derived work is distributed under the terms of a
  11 .\" permission notice identical to this one.
  12 .\"
  13 .\" Since the Linux kernel and libraries are constantly changing, this
  14 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  15 .\" responsibility for errors or omissions, or for damages resulting from
  16 .\" the use of the information contained herein.  The author(s) may not
  17 .\" have taken the same level of care in the production of this manual,
  18 .\" which is licensed free of charge, as they might when working
  19 .\" professionally.
  20 .\"
  21 .\" Formatted or processed versions of this manual, if unaccompanied by
  22 .\" the source, must acknowledge the copyright and authors of this work.
  23 .\" %%%LICENSE_END
  24 .\"
  25 .\" Modified Sat Jul 24 18:16:02 1993 by Rik Faith (faith@cs.unc.edu)
  26 .TH SLEEP 3  2021-03-22 "GNU" "Linux Programmer's Manual"
  27 .SH NAME
  28 sleep \- sleep for a specified number of seconds
  29 .SH SYNOPSIS
  30 .nf
  31 .B #include <unistd.h>
  32 .PP
  33 .BI "unsigned int sleep(unsigned int " "seconds" );
  34 .fi
  35 .SH DESCRIPTION
  36 .BR sleep ()
  37 causes the calling thread to sleep either until
  38 the number of real-time seconds specified in
  39 .I seconds
  40 have elapsed or until a signal arrives which is not ignored.
  41 .SH RETURN VALUE
  42 Zero if the requested time has elapsed,
  43 or the number of seconds left to sleep,
  44 if the call was interrupted by a signal handler.
  45 .SH ATTRIBUTES
  46 For an explanation of the terms used in this section, see
  47 .BR attributes (7).
  48 .ad l
  49 .nh
  50 .TS
  51 allbox;
  52 lbx lb lb
  53 l l l.
  54 Interface       Attribute       Value
  55 T{
  56 .BR sleep ()
  57 T}      Thread safety   MT-Unsafe sig:SIGCHLD/linux
  58 .TE
  59 .hy
  60 .ad
  61 .sp 1
  62 .SH CONFORMING TO
  63 POSIX.1-2001, POSIX.1-2008.
  64 .SH NOTES
  65 On Linux,
  66 .BR sleep ()
  67 is implemented via
  68 .BR nanosleep (2).
  69 See the
  70 .BR nanosleep (2)
  71 man page for a discussion of the clock used.
  72 .SS Portability notes
  73 On some systems,
  74 .BR sleep ()
  75 may be implemented using
  76 .BR alarm (2)
  77 and
  78 .BR SIGALRM
  79 (POSIX.1 permits this);
  80 mixing calls to
  81 .BR alarm (2)
  82 and
  83 .BR sleep ()
  84 is a bad idea.
  85 .PP
  86 Using
  87 .BR longjmp (3)
  88 from a signal handler or modifying the handling of
  89 .B SIGALRM
  90 while sleeping will cause undefined results.
  91 .SH SEE ALSO
  92 .BR sleep (1),
  93 .BR alarm (2),
  94 .BR nanosleep (2),
  95 .BR signal (2),
  96 .BR signal (7)