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