summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAriadna Vigo <arivigodr@gmail.com>2020-06-23 13:32:56 +0200
committerAriadna Vigo <arivigodr@gmail.com>2020-06-23 13:32:56 +0200
commit1541d4b70a1c4f5159d2012027c19b35a891085d (patch)
tree949c41336690054bef6262b23604d7882bd6acac
parentc84b4b748d8c62ed35c0c5ef01851278c85a8b50 (diff)
Documenting + command in manual page
-rw-r--r--minitimer.19
1 files changed, 6 insertions, 3 deletions
diff --git a/minitimer.1 b/minitimer.1
index 47d2c65..daad9d4 100644
--- a/minitimer.1
+++ b/minitimer.1
@@ -13,17 +13,20 @@ Mini Timer.
.SH OPTIONS
.TP
.B \-v
-Show version information
+Show version information.
.SH USAGE
Mini Timer is started by passing the amount of time to count down in an
HH:MM:SS format (e.g. 01:10:10 for 1 hour, 10 mins., 10 secs.). During
execution, pressing these keys will perform an action:
.TP
.B p
-Pause/resume the countdown
+Pause/resume the countdown.
+.TP
+.B +
+Increment the countdown by 10 secs. (amount configurable in config.h).
.TP
.B q
-Quit Mini Timer
+Quit Mini Timer.
.SS Named pipe
On startup a named pipe is set up which allows for communication with a Mini
Timer process by writing any of the commands listed above to the named pipe