From f0b437b4af7c026d0575f6bf067bc639dd465284 Mon Sep 17 00:00:00 2001
From: Mattias Andrée <maandree@operamail.com>
Date: Fri, 27 Nov 2015 08:40:36 +0100
Subject: update readme
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: Mattias Andrée <maandree@operamail.com>
---
 README | 30 +++++++++++++++++++++---------
 1 file changed, 21 insertions(+), 9 deletions(-)

diff --git a/README b/README
index 7ea3fb3..92848e7 100644
--- a/README
+++ b/README
@@ -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)
 
-- 
cgit v1.2.3-70-g09d2