summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTodd C. Miller <millert@cvs.openbsd.org>2001-02-04 22:33:50 +0000
committerTodd C. Miller <millert@cvs.openbsd.org>2001-02-04 22:33:50 +0000
commit1a724e3f3c1cb9472109291adee6cde2fcb8ff6c (patch)
tree4104431e6ba1ef7eebd269210ad2dd9afc9848ea
parent8cd0e5000d6a95628dd56214b1e80da0dfe44aff (diff)
Add RETURN VALUES section
Max alarm time is 100000000 seconds, not 2147483647 (as enforced by itimerfix() in kern_time.c)
-rw-r--r--lib/libc/gen/alarm.39
1 files changed, 7 insertions, 2 deletions
diff --git a/lib/libc/gen/alarm.3 b/lib/libc/gen/alarm.3
index 959036b5483..052e213c91a 100644
--- a/lib/libc/gen/alarm.3
+++ b/lib/libc/gen/alarm.3
@@ -1,4 +1,4 @@
-.\" $OpenBSD: alarm.3,v 1.8 2000/12/24 00:30:46 aaron Exp $
+.\" $OpenBSD: alarm.3,v 1.9 2001/02/04 22:33:49 millert Exp $
.\"
.\" Copyright (c) 1980, 1991, 1993, 1994
.\" The Regents of the University of California. All rights reserved.
@@ -59,7 +59,7 @@ returns the amount of time left on the clock.
The maximum number of
.Ar seconds
allowed
-is 2147483647.
+is 100000000.
.Pp
If an alarm has been set with
.Fn alarm ,
@@ -70,6 +70,11 @@ The request
.Fn alarm "0"
voids the current
alarm.
+.Sh RETURN VALUES
+If the call succeeds, any time left remaining from a previous call is returned.
+If an error occurs, the value \-1 is returned, and a more precise
+error code is placed in the global variable
+.Va errno .
.Sh SEE ALSO
.Xr setitimer 2 ,
.Xr sigaction 2 ,