plan9port/man/man3/sleep.3
Russ Cox 977b25a76a tmac: introduce real manual reference macro instead of overloading IR
The overloading of IR emits magic \X'...' sequences that turn into HTML manual links.
But not all such IR invocations should be manual links;
those had to be written to avoid the IR macro before.
Worse, the \X'...' ending the IR causes troff to emit only a single space after a period.

Defining a new IM macro for manual references fixes both problems.

Fixes #441.
2020-08-13 23:43:43 -04:00

56 lines
1.1 KiB
Groff

.TH SLEEP 3
.SH NAME
sleep, alarm \- delay, ask for delayed note
.SH SYNOPSIS
.B #include <u.h>
.br
.B #include <libc.h>
.PP
.B
int sleep(long millisecs)
.PP
.B
long alarm(unsigned long millisecs)
.SH DESCRIPTION
.I Sleep
suspends the current process for the number
of milliseconds specified by the argument.
The actual suspension time may be a little more or less than
the requested time. If
.I millisecs
is 0, the process
gives up the CPU if another process is waiting to run, returning
immediately if not.
Sleep returns \-1 if interrupted, 0 otherwise.
.PP
.I Alarm
causes an
.B alarm
note (see
.IM notify (3) )
to be sent to the invoking process after the number of milliseconds
given by the argument.
Successive calls to
.I alarm
reset the alarm clock.
A zero argument clears the alarm.
The return value is the amount of time previously remaining in
the alarm clock.
.SH SOURCE
.B \*9/src/lib9/sleep.c
.SH SEE ALSO
.IM intro (3)
.SH DIAGNOSTICS
These functions set
.IR errstr .
.SH BUGS
To avoid name conflicts with the underlying system,
.I sleep
and
.I alarm
are preprocessor macros defined as
.I p9sleep
and
.IR p9alarm ;
see
.IM intro (3) .