BSD 4_3_Net_2 release

[unix-history] / usr / src / lib / libc / gen / ualarm.3

diff --git a/usr/src/lib/libc/gen/ualarm.3 b/usr/src/lib/libc/gen/ualarm.3
index 2dea28c..19fd216 100644 (file)
--- a/usr/src/lib/libc/gen/ualarm.3
+++ b/usr/src/lib/libc/gen/ualarm.3
@@ -1,48 +1,90 @@
-.\" Copyright (c) 1980 Regents of the University of California.
-.\" All rights reserved.  The Berkeley software License Agreement
-.\" specifies the terms and conditions for redistribution.
+.\" Copyright (c) 1986, 1991 Regents of the University of California.
+.\" All rights reserved.

 .\"
 .\"

-.\"    @(#)@(#)ualarm.3        6.4 (Berkeley) %G%
+.\" 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.

 .\"
 .\"

-.TH UALARM 3  ""
-.UC 6
-.SH NAME
-ualarm \- schedule signal after specified time
-.SH SYNOPSIS
-.nf
-.B unsigned ualarm(value, interval)
-.B unsigned value;
-.B unsigned interval;
-.fi
-.SH DESCRIPTION
-.ft B
+.\" 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.
+.\"
+.\"     @(#)ualarm.3   6.5 (Berkeley) 4/19/91
+.\"
+.Dd April 19, 1991
+.Dt UALARM 3
+.Os BSD 4.3
+.Sh NAME
+.Nm ualarm
+.Nd schedule signal after specified time
+.Sh SYNOPSIS
+.Fd #include <unistd.h>
+.Ft u_int 
+.Fn ualarm "u_int microseconds" "u_int interval"
+.Sh DESCRIPTION
+.Bf -symbolic

 This is a simplified interface to setitimer(2).
 This is a simplified interface to setitimer(2).

-.ft R
-.PP
-.I Ualarm
-causes signal SIGALRM, see
-.IR signal (3C),
-to be sent to the invoking process
-in a number of microseconds given by the
-.I value
-argument.
-Unless caught or ignored, the signal terminates the process.
-.PP
+.Ef
+.Pp
+The
+.Fn ualarm
+function
+waits a count of
+.Ar microseconds
+before asserting the terminating signal
+.Dv SIGALRM .
+System activity or time used in processing the call may cause a slight
+delay.
+.Pp

 If the
 If the

-.I interval
-argument is non-zero, the SIGALRM signal will be sent
+.Fa interval
+argument is non-zero, the
+.Dv SIGALRM
+signal will be sent

 to the process every
 to the process every

-.I interval
+.Fa interval

 microseconds after the timer expires (e.g. after
 microseconds after the timer expires (e.g. after

-.I value
+.Fa value

 microseconds have passed).
 microseconds have passed).

-.PP
-Because of scheduling delays,
-resumption of execution of when the signal is
-caught may be delayed an arbitrary amount.
-The longest specifiable delay time (on the vax) is 2147483647 microseconds.
-.PP
-The return value is the amount of time previously remaining in the alarm clock.
-.SH "SEE ALSO"
-getitimer(2), setitimer(2), sigpause(2), sigvec(2), signal(3C), sleep(3),
-alarm(3), usleep(3)
+.Sh RETURN VALUES
+When the signal has successfully been caught,
+.Fn alarm
+returns the amount of time left on the clock.
+The maximum mumber of
+.Ar microseconds
+allowed
+is 2147483647.
+.Sh SEE ALSO
+.Xr getitimer 2 ,
+.Xr setitimer 2 ,
+.Xr sigpause 2 ,
+.Xr sigvec 2 ,
+.Xr signal 3 ,
+.Xr sleep 3 ,
+.Xr alarm 3 ,
+.Xr usleep 3
+.Sh HISTORY
+The
+.Fn ualarm
+function appeared in 
+.Bx 4.3 .