commit bb1f7edb906a2e7dd92f46785e47148ab1a8927b
parent 84bb7df35e218eaedfd1e8bfb2d87cde53e50115
Author: Claudio Alessi <smoppy@gmail.com>
Date: Sun, 24 Jan 2016 19:09:13 +0100
Add shortcuts to the doc.
Diffstat:
2 files changed, 22 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
@@ -11,6 +11,17 @@ for the amount of time specified by the sum of their values. A visual feedback
is given by printing the flowing of time in both ascending and descending
order.
+SHORTCUTS
+
+ Enter output the split time
+
+ Ctrl-s pause execution
+
+ Ctrl-q resume execution
+
+
+You may stop
+
Installation
------------
Edit config.mk to match your local setup (snore is installed into the
diff --git a/snore.1 b/snore.1
@@ -7,11 +7,21 @@ snore \- sleep with feedback
.RI "" NUMBER [ SUFFIX ]...
.SH DESCRIPTION
.B snore
-snore pause for NUMBER seconds. SUFFIX may be 's' for seconds (default), 'm'
+pause for NUMBER seconds. SUFFIX may be 's' for seconds (default), 'm'
for minutes, 'h' four hours or 'd' for days. Given two or more arguments, pause
for the amount of time specified by the sum of their values. A visual feedback
is given by printing the flowing of time in both ascending and descending
order.
+.SH SHORTCUTS
+.TP
+.B Enter
+output the split time
+.TP
+.B Ctrl-s
+pause
+.TP
+.B Ctrl-q
+resume
.SH AUTHORS
See the LICENSE file for the authors.
.SH LICENSE