Update man page with new features

mdoc alternative @ https://ghostbin.com/paste/oj2b4/raw
This commit is contained in:
Ivan Tham 2016-07-15 22:02:36 +08:00
parent 938cd77b94
commit 8be5483b6a

56
spt.1
View File

@ -4,19 +4,22 @@ spt \- simple pomodoro timer
.SH SYNOPSIS .SH SYNOPSIS
.B spt .B spt
.RB [ \-e .RB [ \-e
.IR notifycmd ]
.RB [ \-n
.IR notifyext ] .IR notifyext ]
.RB [ \-n
.IR notifycmd ]
.RB [ \-v ] .RB [ \-v ]
.SH DESCRIPTION .SH DESCRIPTION
.B spt .B spt
is a simple timer that uses pomodoro technique with desktop notification to is a simple timer that uses pomodoro technique with desktop notification to
double your efficiency. double your efficiency.
.B spt
To check the remaining time, send USR1 signal to spt by: receives 2 signals:
.RS .RS
.B pkill -USR1 spt .B SIGUSR1()
\- show remaining time
.br
.B SIGUSR2()
\- play/pause the timer
.RE .RE
.SH OPTIONS .SH OPTIONS
.TP .TP
@ -26,35 +29,24 @@ Execute
when timer starts ticking. when timer starts ticking.
.TP .TP
.BI \-n " notifycmd" .BI \-n " notifycmd"
If Execute
.IR empty , .I notifycmd
do nothing. If if not compiled with
.IR libnotify , .IR "-DNOTIFY".
use the default notification. If neither, it will use the command specified.
.TP .TP
.BI \-v .BI \-v
Prints version information to stderr, then exits. Prints version information to stderr, then exits.
.SH TIMER .SH TIMER
4 pomodoro timer 4 pomodoro timer (
.RB ( "25 min." ) .B 25 min.
with subsequent rests in between ) with subsequent rests in between (
.RB ( "5 min." ) .B 5 min.
and ) and followed by a long rest (
followed by a long rest .B 15 min.
.RB ( "15 min." ) ) in an infinite loop.
.B in an infinite loop
.SH EXAMPLES .SH EXAMPLES
Use system notify_send and play a music without libnotify: Use system notify_send and play a music without libnotify:
.IP
.RS spt -e 'aplay alarm.wav' -n 'notify-send'
.B spt -e 'aplay alarm.wav' -n 'notify-send' .SH AUTHORS
.RE Ivan Tham <pickfire@riseup.net>
.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!