freebsd-dev/lib/libc/gen/alarm.3

.\" Copyright (c) 1980, 1991, 1993, 1994
.\"	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.
.\" 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.
.\"
.\"     @(#)alarm.3	8.2 (Berkeley) 4/19/94
.\" $FreeBSD$
.\"
.Dd April 19, 1994
.Dt ALARM 3
.Os
.Sh NAME
.Nm alarm
.Nd set signal timer alarm
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.In unistd.h
.Ft unsigned int
.Fn alarm "unsigned int seconds"
.Sh DESCRIPTION
.Bf -symbolic
This interface is made obsolete by
.Xr setitimer 2 .
.Ef
.Pp
The
.Fn alarm
function sets a timer to deliver the signal
.Dv SIGALRM
to the calling process after the specified number of
.Fa seconds .
If an alarm has already been set with
.Fn alarm
but has not been delivered, another call to
.Fn alarm
will supersede the prior call.
The request
.Fn alarm "0"
voids the current
alarm and the signal SIGALRM will not be delivered.
.Pp
Due to
.Xr setitimer 2
restriction the maximum number of
.Fa seconds
allowed is 100000000.
.Sh RETURN VALUES
The return value of
.Fn alarm
is the amount of time left on the timer from a previous call to
.Fn alarm .
If no alarm is currently set, the return value is 0.
.Sh SEE ALSO
.Xr setitimer 2 ,
.Xr sigaction 2 ,
.Xr sigsuspend 2 ,
.Xr signal 3 ,
.Xr sleep 3 ,
.Xr ualarm 3 ,
.Xr usleep 3
.\" .Sh STANDARDS
.\" The
.\" .Fn alarm
.\" function conforms to
.\" .St -p1003.1-90 .
.Sh HISTORY
An
.Fn alarm
function appeared in
.At v7 .
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.\" Copyright (c) 1980, 1991, 1993, 1994`
			`.\" 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.`
			`.\" 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.`
			`.\"`
			`.\" @(#)alarm.3 8.2 (Berkeley) 4/19/94`
$Id$ -> $FreeBSD$ 1999-08-28 00:22:10 +00:00			`.\" $FreeBSD$`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.\"`
			`.Dd April 19, 1994`
			`.Dt ALARM 3`
mdoc(7) police: removed HISTORY info from the .Os call. 2001-07-10 13:41:46 +00:00			`.Os`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Sh NAME`
			`.Nm alarm`
			`.Nd set signal timer alarm`
Introduce ".Lb" macro to libc manpages. More libraries manpages updates following. 2000-04-21 09:42:15 +00:00			`.Sh LIBRARY`
			`.Lb libc`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Sh SYNOPSIS`
mdoc(7) police: Use the new .In macro for #include statements. 2001-10-01 16:09:29 +00:00			`.In unistd.h`
The previous change to alarm.3 to improve the wording was still somewhat confusing and poorly worded. So I took the alarm.3 man page from NetBSD, which looked much better all around. Obtained from: NetBSD 1996-07-19 22:19:08 +00:00			`.Ft unsigned int`
			`.Fn alarm "unsigned int seconds"`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Sh DESCRIPTION`
			`.Bf -symbolic`
mdoc(7) police: expand plain text xrefs. 2001-08-08 11:48:28 +00:00			`This interface is made obsolete by`
			`.Xr setitimer 2 .`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Ef`
			`.Pp`
			`The`
			`.Fn alarm`
The previous change to alarm.3 to improve the wording was still somewhat confusing and poorly worded. So I took the alarm.3 man page from NetBSD, which looked much better all around. Obtained from: NetBSD 1996-07-19 22:19:08 +00:00			`function sets a timer to deliver the signal`
Whitespace only change: trim trailing whitespace. 2000-10-30 13:23:19 +00:00			`.Dv SIGALRM`
The previous change to alarm.3 to improve the wording was still somewhat confusing and poorly worded. So I took the alarm.3 man page from NetBSD, which looked much better all around. Obtained from: NetBSD 1996-07-19 22:19:08 +00:00			`to the calling process after the specified number of`
			`.Fa seconds .`
			`If an alarm has already been set with`
Whitespace only change: trim trailing whitespace. 2000-10-30 13:23:19 +00:00			`.Fn alarm`
The previous change to alarm.3 to improve the wording was still somewhat confusing and poorly worded. So I took the alarm.3 man page from NetBSD, which looked much better all around. Obtained from: NetBSD 1996-07-19 22:19:08 +00:00			`but has not been delivered, another call to`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Fn alarm`
The previous change to alarm.3 to improve the wording was still somewhat confusing and poorly worded. So I took the alarm.3 man page from NetBSD, which looked much better all around. Obtained from: NetBSD 1996-07-19 22:19:08 +00:00			`will supersede the prior call.`
			`The request`
			`.Fn alarm "0"`
			`voids the current`
Describe upper limit based on itimerfix restriction 1997-08-14 07:44:57 +00:00			`alarm and the signal SIGALRM will not be delivered.`
			`.Pp`
			`Due to`
			`.Xr setitimer 2`
			`restriction the maximum number of`
mdoc(7) police: Fixed abuses of the .Ar and .Em macros. 2002-12-18 13:33:04 +00:00			`.Fa seconds`
Describe upper limit based on itimerfix restriction 1997-08-14 07:44:57 +00:00			`allowed is 100000000.`
			`.Sh RETURN VALUES`
Whitespace only change: trim trailing whitespace. 2000-10-30 13:23:19 +00:00			`The return value of`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Fn alarm`
The previous change to alarm.3 to improve the wording was still somewhat confusing and poorly worded. So I took the alarm.3 man page from NetBSD, which looked much better all around. Obtained from: NetBSD 1996-07-19 22:19:08 +00:00			`is the amount of time left on the timer from a previous call to`
			`.Fn alarm .`
			`If no alarm is currently set, the return value is 0.`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Sh SEE ALSO`
			`.Xr setitimer 2 ,`
Sort cross references. 1997-01-20 23:23:22 +00:00			`.Xr sigaction 2 ,`
Update xrefs from 4.3BSD to modern signal functions in various man pages. sigvec(2) references have been updated to sigaction(2), sigsetmask(2) and sigblock(2) to sigprocmask(2), sigpause(2) to sigsuspend(2). Some legacy man pages still refer to them, that is OK. 2010-05-06 22:49:54 +00:00			`.Xr sigsuspend 2 ,`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Xr signal 3 ,`
			`.Xr sleep 3 ,`
			`.Xr ualarm 3 ,`
			`.Xr usleep 3`
Don't claim to be POSIX compliant, since our alarm function isn't. 1996-08-15 21:12:49 +00:00			`.\" .Sh STANDARDS`
			`.\" The`
			`.\" .Fn alarm`
Whitespace only change: trim trailing whitespace. 2000-10-30 13:23:19 +00:00			`.\" function conforms to`
Don't claim to be POSIX compliant, since our alarm function isn't. 1996-08-15 21:12:49 +00:00			`.\" .St -p1003.1-90 .`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Sh HISTORY`
			`An`
			`.Fn alarm`
Whitespace only change: trim trailing whitespace. 2000-10-30 13:23:19 +00:00			`function appeared in`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.At v7 .`