1.\" $NetBSD: nanosleep.2,v 1.6 2002/02/08 01:28:20 ross Exp $ 2.\" 3.\" Copyright (c) 1986, 1991, 1993 4.\" The Regents of the University of California. All rights reserved. 5.\" 6.\" Redistribution and use in source and binary forms, with or without 7.\" modification, are permitted provided that the following conditions 8.\" are met: 9.\" 1. Redistributions of source code must retain the above copyright 10.\" notice, this list of conditions and the following disclaimer. 11.\" 2. Redistributions in binary form must reproduce the above copyright 12.\" notice, this list of conditions and the following disclaimer in the 13.\" documentation and/or other materials provided with the distribution. 14.\" 3. All advertising materials mentioning features or use of this software 15.\" must display the following acknowledgement: 16.\" This product includes software developed by the University of 17.\" California, Berkeley and its contributors. 18.\" 4. Neither the name of the University nor the names of its contributors 19.\" may be used to endorse or promote products derived from this software 20.\" without specific prior written permission. 21.\" 22.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 25.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 32.\" SUCH DAMAGE. 33.\" 34.\" @(#)sleep.3 8.1 (Berkeley) 6/4/93 35.\" 36.Dd April 17, 1997 37.Dt NANOSLEEP 2 38.Os 39.Sh NAME 40.Nm nanosleep 41.Nd high resolution sleep 42.Sh LIBRARY 43.Lb libc 44.Sh SYNOPSIS 45.Fd #include \*[Lt]time.h\*[Gt] 46.Ft int 47.Fn nanosleep "const struct timespec *rqtp" "struct timespec *rmtp" 48.Sh DESCRIPTION 49The 50.Fn nanosleep 51suspends execution of the calling process until either the number of 52seconds and nanoseconds specified by 53.Fa rqtp 54have elapsed or a signal is delivered to the calling process and its 55action is to invoke a signal catching function or to terminate the 56process. 57The suspension time may be longer than requested due to the 58scheduling of other activity by the system. 59.Sh RETURN VALUES 60If the 61.Fn nanosleep 62function returns because the requested time has elapsed, the value 63returned will be zero. 64.Pp 65If the 66.Fn nanosleep 67function returns due to the delivery of a signal, the value returned 68will be the -1, and the global variable 69.Va errno 70will be set to indicate the interruption. 71If 72.Fa rmtp 73is 74.Pf non- Dv NULL , 75the timespec structure it references is updated to contain the 76unslept amount (the request time minus the time actually slept). 77.Sh ERRORS 78If any of the following conditions occur, the 79.Nm 80function shall return -1 and set 81.Va errno 82to the corresponding value. 83.Bl -tag -width Er 84.It Bq Er EFAULT 85Either 86.Fa rqtp 87or 88.Fa rmtp 89points to memory that is not a valid part of the process 90address space. 91.It Bq Er EINTR 92.Nm 93was interrupted by the delivery of a signal. 94.It Bq Er EINVAL 95.Fa rqtp 96specified a nanosecond value less than zero or greater than 1000 million. 97.It Bq Er ENOSYS 98.Nm 99is not supported by this implementation. 100.El 101.Sh SEE ALSO 102.Xr sleep 3 103.Sh STANDARDS 104The 105.Fn nanosleep 106function conforms to 107.St -p1003.1b-93 . 108