Update man page with new features
mdoc alternative @ https://ghostbin.com/paste/oj2b4/raw
This commit is contained in:
parent
938cd77b94
commit
8be5483b6a
56
spt.1
56
spt.1
|
@ -4,19 +4,22 @@ spt \- simple pomodoro timer
|
|||
.SH SYNOPSIS
|
||||
.B spt
|
||||
.RB [ \-e
|
||||
.IR notifycmd ]
|
||||
.RB [ \-n
|
||||
.IR notifyext ]
|
||||
.RB [ \-n
|
||||
.IR notifycmd ]
|
||||
.RB [ \-v ]
|
||||
.SH DESCRIPTION
|
||||
.B spt
|
||||
is a simple timer that uses pomodoro technique with desktop notification to
|
||||
double your efficiency.
|
||||
|
||||
To check the remaining time, send USR1 signal to spt by:
|
||||
|
||||
.B spt
|
||||
receives 2 signals:
|
||||
.RS
|
||||
.B pkill -USR1 spt
|
||||
.B SIGUSR1()
|
||||
\- show remaining time
|
||||
.br
|
||||
.B SIGUSR2()
|
||||
\- play/pause the timer
|
||||
.RE
|
||||
.SH OPTIONS
|
||||
.TP
|
||||
|
@ -26,35 +29,24 @@ Execute
|
|||
when timer starts ticking.
|
||||
.TP
|
||||
.BI \-n " notifycmd"
|
||||
If
|
||||
.IR empty ,
|
||||
do nothing. If
|
||||
.IR libnotify ,
|
||||
use the default notification. If neither, it will use the command specified.
|
||||
Execute
|
||||
.I notifycmd
|
||||
if not compiled with
|
||||
.IR "-DNOTIFY".
|
||||
.TP
|
||||
.BI \-v
|
||||
Prints version information to stderr, then exits.
|
||||
.SH TIMER
|
||||
4 pomodoro timer
|
||||
.RB ( "25 min." )
|
||||
with subsequent rests in between
|
||||
.RB ( "5 min." )
|
||||
and
|
||||
followed by a long rest
|
||||
.RB ( "15 min." )
|
||||
.B in an infinite loop
|
||||
4 pomodoro timer (
|
||||
.B 25 min.
|
||||
) with subsequent rests in between (
|
||||
.B 5 min.
|
||||
) and followed by a long rest (
|
||||
.B 15 min.
|
||||
) in an infinite loop.
|
||||
.SH EXAMPLES
|
||||
Use system notify_send and play a music without libnotify:
|
||||
|
||||
.RS
|
||||
.B spt -e 'aplay alarm.wav' -n 'notify-send'
|
||||
.RE
|
||||
.SH AUTHOR
|
||||
The author is not that important. A message from the author:
|
||||
.TP
|
||||
.I "Good luck and have a nice day!"
|
||||
.SH LICENSE
|
||||
See the LICENSE file for the terms of redistribution.
|
||||
.SH BUGS
|
||||
Bugs? You must be kidding; there is no bugs in this software. But if we
|
||||
happened to be wrong, please report the bugs!
|
||||
.IP
|
||||
spt -e 'aplay alarm.wav' -n 'notify-send'
|
||||
.SH AUTHORS
|
||||
Ivan Tham <pickfire@riseup.net>
|
||||
|
|
Loading…
Reference in New Issue
Block a user