diff options
| author | Mattias Andrée <maandree@operamail.com> | 2015-11-27 08:40:36 +0100 |
|---|---|---|
| committer | Mattias Andrée <maandree@operamail.com> | 2015-11-27 08:40:36 +0100 |
| commit | f0b437b4af7c026d0575f6bf067bc639dd465284 (patch) | |
| tree | 2bc71cd3833deeb26b09ff1f0eb62c9fb500e1ba | |
| parent | typo (diff) | |
| download | alarm-f0b437b4af7c026d0575f6bf067bc639dd465284.tar.gz alarm-f0b437b4af7c026d0575f6bf067bc639dd465284.tar.bz2 alarm-f0b437b4af7c026d0575f6bf067bc639dd465284.tar.xz | |
update readme
Signed-off-by: Mattias Andrée <maandree@operamail.com>
| -rw-r--r-- | README | 30 |
1 files changed, 21 insertions, 9 deletions
@@ -1,15 +1,27 @@ -Schedule an alarm for a program when starting it. +NAME + alarm - Schedule an alarm for a program when starting it +SYNOPSIS + alarm DURATION COMMAND [ARGS...] -USAGE: alarm <TIME> <COMMAND> <ARGS...> +DESCRIPTION + Schedules an alarm(3) to best triggered after a specified + DURATION. The process than execvp(3) into COMMAND ARGS. -Recognised patterns for <TIME>: + This means that COMMAND will be killed by SIGALRM after + a selected DURATION. - <SECONDS>[s] - <MINUTES>m[<SECONDS>s] - <HOURS>h[<MINUTES>m][<SECONDS>s] + DURATION must be a non-negative integer, no larger + than 18h12m15s. Recognised patterns for DURATION are: + * SECONDS[s] + * MINUTESm[SECONDSs] + * HOURSh[MINUTESm][SECONDSs] - All values are non-negative integers, and - the interval must be greater than zero and - at most 18h12m15s. +RATIONALE + This program is useful when testing programs for a limited + duration. Especially when running in the background, or + there is a chance of it locking the computer. + +SEE ALSO + alarm(3) |