blob: 2ca310c35a62d24cacf49e04d19bfa38d422f989 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
|
.TH MINITIMER 1 minitimer\-VERSION
.SH NAME
Mini Timer \- A timer in your terminal
.SH SYNOPSIS
.B minitimer
.RB [ \-sv ]
.RB [ HH:MM:SS ]
.SH DESCRIPTION
Mini Timer is a very simple timer that lives in the terminal of your system. It
supports pausing and resuming the countdown. It also provides a named pipe
which you can pass commands to to control a running instance of Mini Timer.
.SH OPTIONS
.TP
.B \-s
Switch to stopwatch mode (i.e. counting time up), from the time provided at the
command line (00:00:00 by default).
.TP
.B \-v
Show version information and exit.
.SH USAGE
Mini Timer is started by passing the initial time in 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.
.TP
.B +
Increment the countdown by 10 secs. (amount configurable in config.h).
.TP
.B q
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
file. By default, the named pipe is located at
.B /tmp/minitimer.$PID.
.SH CONFIGURATION
Mini Timer is configured by creating a custom config.h and recompiling the
source code.
.SH BUGS
Report bugs to https://todo.sr.ht/~emvigo/minitimer
|
