Macaulay2 » Documentation
Packages » Macaulay2Doc > The Macaulay2 language > system facilities > alarm
next | previous | forward | backward | up | index | toc

alarm -- set an alarm

Synopsis

Description

If n is zero, then no alarm is scheduled, and any previously scheduled alarm is cancelled. Any pending alarm will be cancelled when any other error occurs, or when the top level loop offers an input prompt to the user.

The value returned is the number of seconds remaining until any previously scheduled alarm was due to be delivered, or zero if there was no previously scheduled alarm.

This command may interfere with time or sleep on some systems.

For the programmer

The object alarm is a compiled function.