aboutsummaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authorMattias Andrée <maandree@kth.se>2021-02-07 00:24:39 +0100
committerMattias Andrée <maandree@kth.se>2021-02-07 00:24:39 +0100
commit68dd947b82c6508cb72558130759c9eb2480f1eb (patch)
tree519b32f07c9f46d48849acb88c6687ecb28db12b /README
parentAdd posix time support (diff)
downloadmongotimer-68dd947b82c6508cb72558130759c9eb2480f1eb.tar.gz
mongotimer-68dd947b82c6508cb72558130759c9eb2480f1eb.tar.bz2
mongotimer-68dd947b82c6508cb72558130759c9eb2480f1eb.tar.xz
Fork mongoclock and turn into a timer and stopwatch
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to '')
-rw-r--r--README39
1 files changed, 15 insertions, 24 deletions
diff --git a/README b/README
index c9d800d..a5c89fa 100644
--- a/README
+++ b/README
@@ -1,17 +1,20 @@
NAME
- mongoclock - Just a humongous clock for the terminal
+ mongotimer - A humongous timer or stopwatch for the terminal
SYNOPSIS
- mongoclock
+ mongotimer [[-e] [[hh:]mm:]ss]
DESCRIPTION
- Type mongoclock in the terminal and it will either,
- depending on the terminal size, show the time HH:MM
- or HH:MM:SS with humongous digits.
+ mongotimer will, if no arguments are specified,
+ simply display time since it started. If a time
+ is specified, it will count down from that time.
- If the terminal is too small, it will not run.
+ Pressing space will pause the timer/stopwatch,
+ and the time be displayed in yellow will
+ paused. Pressing space again will unpause the
+ timer/stopwatch.
- mongoclock is designed to be fit on most screens
+ mongotimer is designed to be fit on most screens
and be readable from all practical distances, so
that it can be used in place of a standard wall-
or alarm-clock. If the font is not big enough for
@@ -22,26 +25,14 @@ DESCRIPTION
OPTIONS
The mongoclock utility shall conform to the Base
- Definitions volume of POSIX.1‐2008, Section 12.2,
+ Definitions volume of POSIX.1-2008, Section 12.2,
Utility Syntax Guidelines.
The following options shall be supported:
- -s Display the posix time (seconds since
- 1970-01-01 00:00:00 UTC, ignoring inserted
- and removed leap seconds).
-
-RATIONALE
- It is really nice to have a large clock on your
- computer, instead of a small clock somewhere in
- your room, when your are sleeping. It is also
- nice to have a glansable clock available on your
- netbook for when you need to keep track of the
- time but are not working on a computer.
- Pocket-watches are just too much work to getting
- up, opening, closing, and putting down, and you
- would not like to forget it when you leave if
- you are in a public place.
+ -e Exit with status 0 when the timer reaches 0.
+ If not specified, the timer will continue
+ into negative times but with a red font.
SEE ALSO
- watch(1)
+ mongoclock(1), watch(1)