90 lines
2.0 KiB
Groff
90 lines
2.0 KiB
Groff
.\" Generated by scdoc 1.11.2
|
|
.\" Complete documentation for this program is not available as a GNU info page
|
|
.ie \n(.g .ds Aq \(aq
|
|
.el .ds Aq '
|
|
.nh
|
|
.ad l
|
|
.\" Begin generated content:
|
|
.TH "pomo" "1" "2022-05-30"
|
|
.P
|
|
.SH NAME
|
|
.P
|
|
\fBPomo\fR is a simple CLI for using the Pomodoro Technique.\&
|
|
.P
|
|
.SH SYNOPSIS
|
|
.P
|
|
\fBpomo\fR [OPTIONS] COMMAND [arg.\&.\&.\&]
|
|
.P
|
|
.SH DESCRIPTION
|
|
.P
|
|
\fBpomo\fR helps you track what you did, how long it took you to do it,
|
|
and how much effort you expect it to take.\&
|
|
.P
|
|
The Pomodoro Technique is simple and effective:
|
|
.P
|
|
.RS 4
|
|
\fB\fR Decide on a task you want to accomplish
|
|
\fB\fR Break the task into timed intervals (pomodoros), [approx.\& 25 min]
|
|
\fB\fR After each pomodoro take a short break [approx.\& 3 - 5 min]
|
|
\fB\fR Once all pomodoros are completed take a longer break [approx 15 - 20 min]
|
|
\fB\fR Repeat
|
|
.P
|
|
.RE
|
|
.SH SUBCOMMANDS
|
|
.P
|
|
See --help for the complete command usage
|
|
.P
|
|
.nf
|
|
.RS 4
|
|
start, s start a new task
|
|
init initialize the sqlite database
|
|
config, cf display the current configuration
|
|
create, c create a new task without starting
|
|
begin, b begin requested pomodoro
|
|
list, l list historical tasks
|
|
delete, d delete a stored task
|
|
status, st output the current status
|
|
|
|
.fi
|
|
.RE
|
|
.P
|
|
.SH CONFIGURATION
|
|
.P
|
|
Pomo has a configuration file that is stored in \fB~/.\&config/pomo/config.\&json\fR.\&
|
|
.P
|
|
.nf
|
|
.RS 4
|
|
{
|
|
"colors": null,
|
|
"dateTimeFmt": "2006-01-02 15:04",
|
|
"publish": false,
|
|
"publishJson": false,
|
|
"publishSocketPath": ""
|
|
}
|
|
.fi
|
|
.RE
|
|
.P
|
|
.SH EXAMPLES
|
|
.P
|
|
.SS GETTING STARTED
|
|
.P
|
|
.nf
|
|
.RS 4
|
|
# ensure your database has been initialized
|
|
pomo init
|
|
# run a new pomodoro
|
|
pomo start -t my-project "write some code"
|
|
# once finished view previously completed pomodoros
|
|
pomo list
|
|
.fi
|
|
.RE
|
|
.P
|
|
.SH SEE ALSO
|
|
.P
|
|
See the pomo source repository on Github at https://github.\&com/kevinschoon/pomo for complete documentation.\&
|
|
.P
|
|
.SH AUTHORS
|
|
.P
|
|
Written by Kevin Schoon <me@kevinschoon.\&com> with help from the open source
|
|
community.\&
|