kitchentimer/README.md

33 lines
1.1 KiB
Markdown
Raw Normal View History

2021-04-18 10:21:55 +02:00
# kitchentimer
2021-04-24 08:38:39 +02:00
Small timing application for text terminals. Helper for preparing tea,
2021-04-18 10:18:31 +02:00
coffee, pasta etc.
2021-04-18 10:21:55 +02:00
Features a single large up-counting clock with optional alarm times. Alarm
times may be given as command line arguments, read from stdin or entered
interactively.
2021-04-18 10:18:31 +02:00
2021-04-19 12:10:47 +02:00
## Installation
2021-04-24 08:38:39 +02:00
cargo install --git "https://github.com/shybird/kitchentimer.git"
2021-04-19 12:10:47 +02:00
## Usage
2021-04-18 10:18:31 +02:00
USAGE: kitchentimer [-h|-v] [-e|--exec COMMAND] [-p] [-q] [ALARM[/LABEL]]
PARAMETERS:
[ALARM TIME[/LABEL]] Any number of alarm times (HH:MM:SS) with optional
label.
OPTIONS:
2021-04-19 13:03:28 +02:00
-h, --help Show this usage message.
2021-04-18 10:18:31 +02:00
-v, --version Show version information.
2021-04-19 13:03:28 +02:00
-e, --exec [COMMAND] Execute COMMAND on alarm. My be given multiple
times. Occurrences of {l} will be replaced by the
alarm label, {t} by alarm time in (HH:)MM:SS format.
2021-04-18 10:18:31 +02:00
-p, --plain Use simpler block chars to draw the clock.
-q, --quit Quit program after last alarm.
SIGNALS: <SIGUSR1> Reset clock.
2021-04-19 13:03:28 +02:00
<SIGUSR2> Pause or continue.
2021-04-18 10:18:31 +02:00