NetBSD/lib/libc/gen/usleep.3

.\"	$NetBSD: usleep.3,v 1.15 2002/09/04 01:03:58 wiz Exp $
.\"
.\" Copyright (c) 1986, 1991, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"	This product includes software developed by the University of
.\"	California, Berkeley and its contributors.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"     @(#)usleep.3	8.1 (Berkeley) 6/4/93
.\"
.Dd June 4, 1993
.Dt USLEEP 3
.Os
.Sh NAME
.Nm usleep
.Nd suspend execution for interval of microseconds
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.Fd #include \*[Lt]unistd.h\*[Gt]
.Ft int
.Fn usleep "useconds_t microseconds"
.Sh DESCRIPTION
The
.Fn usleep
function
suspends execution of the calling process
until either the number of microseconds specified by
.Fa microseconds
have elapsed or a signal is delivered to the calling process and its
action is to invoke a signal catching function or to terminate the
process.  The suspension time may be longer than requested due to the
scheduling of other activity by the system.
.Pp
The
.Fa microseconds
argument must be less than 1,000,000.  If the value of
.Fa microseconds
is 0, then the call has no effect.
.Sh RETURN VALUES
On successful completion,
.Fn usleep
returns 0.  Otherwise, it returns \-1 and sets
.Va errno
to indicate the error.
.Sh ERRORS
The
.Fn usleep
function may fail if:
.Bl -tag -width Er
.It Bq Er EINVAL
The
.Fa microseconds
interval specified 1,000,000 or more microseconds.
.El
.Sh SEE ALSO
.Xr nanosleep 2 ,
.Xr sleep 3
.Sh STANDARDS
The
.Fn usleep
function conforms to
.St -xpg4.2 .
.Sh HISTORY
The
.Fn usleep
function appeared in
.Bx 4.3 .
completion, not completition; mark up errno; use \- instead of -. 2002-09-04 05:03:58 +04:00			`.\" $NetBSD: usleep.3,v 1.15 2002/09/04 01:03:58 wiz Exp $`
merge with Lite, keep local changes. clean up id usage 1995-02-25 18:39:01 +03:00			`.\"`
			`.\" Copyright (c) 1986, 1991, 1993`
			`.\" The Regents of the University of California. All rights reserved.`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.\"`
			`.\" Redistribution and use in source and binary forms, with or without`
			`.\" modification, are permitted provided that the following conditions`
			`.\" are met:`
			`.\" 1. Redistributions of source code must retain the above copyright`
			`.\" notice, this list of conditions and the following disclaimer.`
			`.\" 2. Redistributions in binary form must reproduce the above copyright`
			`.\" notice, this list of conditions and the following disclaimer in the`
			`.\" documentation and/or other materials provided with the distribution.`
			`.\" 3. All advertising materials mentioning features or use of this software`
			`.\" must display the following acknowledgement:`
			`.\" This product includes software developed by the University of`
			`.\" California, Berkeley and its contributors.`
			`.\" 4. Neither the name of the University nor the names of its contributors`
			`.\" may be used to endorse or promote products derived from this software`
			`.\" without specific prior written permission.`
			`.\"`
			.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
			`.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE`
			`.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE`
			`.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE`
			`.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL`
			`.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS`
			`.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)`
			`.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT`
			`.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY`
			`.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF`
			`.\" SUCH DAMAGE.`
			`.\"`
merge with Lite, keep local changes. clean up id usage 1995-02-25 18:39:01 +03:00			`.\" @(#)usleep.3 8.1 (Berkeley) 6/4/93`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.\"`
merge with Lite, keep local changes. clean up id usage 1995-02-25 18:39:01 +03:00			`.Dd June 4, 1993`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Dt USLEEP 3`
Last of the .Os cleanups. .Os is defined in the tmac.doc-common file, so we shouldn't override it with versions in the manpages. Wheee! 1999-03-22 22:44:33 +03:00			`.Os`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Sh NAME`
			`.Nm usleep`
			`.Nd suspend execution for interval of microseconds`
add LIBRARY section to man page 1998-02-05 21:45:17 +03:00			`.Sh LIBRARY`
			`.Lb libc`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Sh SYNOPSIS`
Generate <>& symbolically. 2002-02-07 10:00:09 +03:00			`.Fd #include \[Lt]unistd.h\[Gt]`
Per XPG4.2: * Change argument to type useconds_t, return an int. * If an interval of 1,000,000 or more microseconds was requested, fail with -1/EINVAL. 1997-11-24 22:56:30 +03:00			`.Ft int`
			`.Fn usleep "useconds_t microseconds"`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Sh DESCRIPTION`
			`The`
merge with Lite, keep local changes. clean up id usage 1995-02-25 18:39:01 +03:00			`.Fn usleep`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`function`
			`suspends execution of the calling process`
crib text from sleep(3) to document response to signals; fixes PR 4008 1997-09-20 08:52:36 +04:00			`until either the number of microseconds specified by`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Fa microseconds`
crib text from sleep(3) to document response to signals; fixes PR 4008 1997-09-20 08:52:36 +04:00			`have elapsed or a signal is delivered to the calling process and its`
			`action is to invoke a signal catching function or to terminate the`
			`process. The suspension time may be longer than requested due to the`
			`scheduling of other activity by the system.`
Per XPG4.2: * Change argument to type useconds_t, return an int. * If an interval of 1,000,000 or more microseconds was requested, fail with -1/EINVAL. 1997-11-24 22:56:30 +03:00			`.Pp`
			`The`
			`.Fa microseconds`
Typo. 2000-08-22 03:23:23 +04:00			`argument must be less than 1,000,000. If the value of`
Per XPG4.2: * Change argument to type useconds_t, return an int. * If an interval of 1,000,000 or more microseconds was requested, fail with -1/EINVAL. 1997-11-24 22:56:30 +03:00			`.Fa microseconds`
			`is 0, then the call has no effect.`
Standardize section headers, sort sections, sort SEE ALSO, punctuation and misc. fixes. 2001-09-16 06:57:03 +04:00			`.Sh RETURN VALUES`
completion, not completition; mark up errno; use \- instead of -. 2002-09-04 05:03:58 +04:00			`On successful completion,`
Per XPG4.2: * Change argument to type useconds_t, return an int. * If an interval of 1,000,000 or more microseconds was requested, fail with -1/EINVAL. 1997-11-24 22:56:30 +03:00			`.Fn usleep`
completion, not completition; mark up errno; use \- instead of -. 2002-09-04 05:03:58 +04:00			`returns 0. Otherwise, it returns \-1 and sets`
			`.Va errno`
			`to indicate the error.`
Per XPG4.2: * Change argument to type useconds_t, return an int. * If an interval of 1,000,000 or more microseconds was requested, fail with -1/EINVAL. 1997-11-24 22:56:30 +03:00			`.Sh ERRORS`
crib text from sleep(3) to document response to signals; fixes PR 4008 1997-09-20 08:52:36 +04:00			`The`
			`.Fn usleep`
Per XPG4.2: * Change argument to type useconds_t, return an int. * If an interval of 1,000,000 or more microseconds was requested, fail with -1/EINVAL. 1997-11-24 22:56:30 +03:00			`function may fail if:`
Boring whitespace fixes. 2001-09-16 06:30:23 +04:00			`.Bl -tag -width Er`
Per XPG4.2: * Change argument to type useconds_t, return an int. * If an interval of 1,000,000 or more microseconds was requested, fail with -1/EINVAL. 1997-11-24 22:56:30 +03:00			`.It Bq Er EINVAL`
			`The`
			`.Fa microseconds`
			`interval specified 1,000,000 or more microseconds.`
			`.El`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Sh SEE ALSO`
Implement sleep() and usleep() in terms of nanosleep(). Uses only one syscall instead of eight, and doesn't have any interactions with alarm or interval timers. 1997-07-19 06:42:30 +04:00			`.Xr nanosleep 2 ,`
xref sigsuspend(2), not obsolete sigpause(2). 1997-05-12 11:12:00 +04:00			`.Xr sleep 3`
Per XPG4.2: * Change argument to type useconds_t, return an int. * If an interval of 1,000,000 or more microseconds was requested, fail with -1/EINVAL. 1997-11-24 22:56:30 +03:00			`.Sh STANDARDS`
			`The`
			`.Fn usleep`
			`function conforms to`
			`.St -xpg4.2 .`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Sh HISTORY`
			`The`
			`.Fn usleep`
Boring whitespace fixes. 2001-09-16 06:30:23 +04:00			`function appeared in`
initial import of 386bsd-0.1 sources 1993-03-21 12:45:37 +03:00			`.Bx 4.3 .`