ualarm.3: Add note on the behavior when 'usecs' is zero

POSIX.1-2001 does not specify the behavior in this case
and no other system that I checked documented the behavior.
Probably, most or all systems do what Linux does in this
case: cancel any pending alarm, just as alarm(0) does.
Add that info in NOTES.

Reported-by: Nicolas Hillegeer <nicolas@hillegeer.com>
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
This commit is contained in:
Michael Kerrisk 2013-04-18 16:18:50 +02:00
parent d82b435b70
commit 70ef44dec5
1 changed files with 8 additions and 1 deletions

View File

@ -21,7 +21,7 @@
.\" <http://www.gnu.org/licenses/>.
.\" %%%LICENSE_END
.\"
.TH UALARM 3 2010-09-20 "" "Linux Programmer's Manual"
.TH UALARM 3 2013-04-18 "" "Linux Programmer's Manual"
.SH NAME
ualarm \- schedule signal after given number of microseconds
.SH SYNOPSIS
@ -98,6 +98,13 @@ POSIX.1-2008 removes the specification of
.BR ualarm ().
4.3BSD, SUSv2, and POSIX do not define any errors.
.SH NOTES
POSIX.1-2001 does not specify what happens if the
.I usecs
argument is 0.
.\" This case is not documented in HP-US, Solar, FreeBSD, NetBSD, or OpenBSD!
On Linux (and probably most other systems),
the effect is to cancel any pending alarm.
The type
.I useconds_t
is an unsigned integer type capable of holding integers