aboutsummaryrefslogtreecommitdiffstats
path: root/alarm.1
diff options
context:
space:
mode:
authorMattias Andrée <maandree@kth.se>2017-10-13 20:45:48 +0200
committerMattias Andrée <maandree@kth.se>2017-10-13 20:45:55 +0200
commitdb656c928524eed059ecf3d418efdea0d923072c (patch)
tree61615486d7225e3c7c369fbcb2e9c2f7d49104b0 /alarm.1
parentupdate dist (diff)
downloadalarm-db656c928524eed059ecf3d418efdea0d923072c.tar.gz
alarm-db656c928524eed059ecf3d418efdea0d923072c.tar.bz2
alarm-db656c928524eed059ecf3d418efdea0d923072c.tar.xz
Improve style and license
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to 'alarm.1')
-rw-r--r--alarm.148
1 files changed, 48 insertions, 0 deletions
diff --git a/alarm.1 b/alarm.1
new file mode 100644
index 0000000..198b2c2
--- /dev/null
+++ b/alarm.1
@@ -0,0 +1,48 @@
+.TH ALARM 1 ALARM
+.SH NAME
+alarm - Schedule an alarm for a program when starting it
+.SH SYNOPSIS
+.BR alarm
+.IR duration
+.IR command
+.RI [ argument \ ...]
+.SH DESCRIPTION
+Schedules an
+.BR alarm (3)
+to best triggered after a specified
+.IR duration .
+The process than
+.BR execvp (3)
+into
+.IR command .
+.PP
+This means that
+.IR command
+will be killed by
+.BR SIGALRM
+after a selected
+.IR duration .
+.PP
+.IR duration
+must be a non-negative integer, no larger than 18h12m15s.
+Recognised patterns for
+.IR duration
+are:
+.TP
+*
+.IR seconds [s]
+.TP
+*
+.IR minutes m[ seconds s]
+.TP
+*
+.IR hours h[ minutes m][ seconds s]
+.SH 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.
+.SH "SEE ALSO"
+.BR alarm (3)
+.SH AUTHORS
+Mattias Andrée
+.RI < maandree@kth.se >