kitchentimer/README.md
2021-04-18 10:18:31 +02:00

1.1 KiB

Simple timing application for text terminals. Helper for preparing tea, coffee, pasta etc.

Single large up-counting clock with optional alarm times. Alarm times may be given as command line arguments, read from stdin or entered interactively.

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:
  -h, --help            Show this help.
  -v, --version         Show version information.
  -e, --exec [COMMAND]  Execute COMMAND on alarm. Occurrences of {t} will
                        be replaced by the alarm time in (HH:)MM:SS format.
                        Occurrences of {l} by alarm label.
  -p, --plain           Use simpler block chars to draw the clock.
  -f, --fancy           Make use of less common unicode characters.
  -q, --quit            Quit program after last alarm.

SIGNALS: <SIGUSR1> Reset clock.
         <SIGUSR2> Pause or un-pause clock.