Skip to content

Commit 6236144

Browse files
kevinschoonkevinschoon
committed
add man page
1 parent 1b32119 commit 6236144

File tree

4 files changed

+169
-1
lines changed

4 files changed

+169
-1
lines changed

‎Makefile‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,11 @@ test:
2929
install:
3030
go install ./cmd/...
3131

32+
man/pomo.1: man/pomo.1.scd
33+
scdoc < $< > $@
34+
35+
manpages: man/pomo.1
36+
3237
docs: www/data/readme.json
3338
cd www && hugo -d ../docs
3439

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ pomo start -t my-project "write some codes"
4949

5050
## Configuration
5151

52-
Pomo has a few configuration options which can be read from a JSON file in Pomo's state directory `~/.pomo/config.json`.
52+
Pomo has a few configuration options which can be read from a JSON file in Pomo's config directory `~/.config/pomo/config.json`.
5353

5454
### colors
5555

‎man/pomo.1‎

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
.\" Generated by scdoc 1.11.2
2+
.\" Complete documentation for this program is not available as a GNU info page
3+
.ie \n(.g .ds Aq \(aq
4+
.el .ds Aq '
5+
.nh
6+
.ad l
7+
.\" Begin generated content:
8+
.TH "pomo" "1" "2022-05-30"
9+
.P
10+
.SH NAME
11+
.P
12+
\fBPomo\fR is a simple CLI for using the Pomodoro Technique.\&
13+
.P
14+
.SH SYNOPSIS
15+
.P
16+
\fBpomo\fR [OPTIONS] COMMAND [arg.\&.\&.\&]
17+
.P
18+
.SH DESCRIPTION
19+
.P
20+
\fBpomo\fR helps you track what you did, how long it took you to do it,
21+
and how much effort you expect it to take.\&
22+
.P
23+
The Pomodoro Technique is simple and effective:
24+
.P
25+
.RS 4
26+
\fB\fR Decide on a task you want to accomplish
27+
\fB\fR Break the task into timed intervals (pomodoros), [approx.\& 25 min]
28+
\fB\fR After each pomodoro take a short break [approx.\& 3 - 5 min]
29+
\fB\fR Once all pomodoros are completed take a longer break [approx 15 - 20 min]
30+
\fB\fR Repeat
31+
.P
32+
.RE
33+
.SH SUBCOMMANDS
34+
.P
35+
See --help for the complete command usage
36+
.P
37+
.nf
38+
.RS 4
39+
start, s start a new task
40+
init initialize the sqlite database
41+
config, cf display the current configuration
42+
create, c create a new task without starting
43+
begin, b begin requested pomodoro
44+
list, l list historical tasks
45+
delete, d delete a stored task
46+
status, st output the current status
47+
48+
.fi
49+
.RE
50+
.P
51+
.SH CONFIGURATION
52+
.P
53+
Pomo has a configuration file that is stored in \fB~/.\&config/pomo/config.\&json\fR.\&
54+
.P
55+
.nf
56+
.RS 4
57+
{
58+
"colors": null,
59+
"dateTimeFmt": "2006-01-02 15:04",
60+
"publish": false,
61+
"publishJson": false,
62+
"publishSocketPath": ""
63+
}
64+
.fi
65+
.RE
66+
.P
67+
.SH EXAMPLES
68+
.P
69+
.SS GETTING STARTED
70+
.P
71+
.nf
72+
.RS 4
73+
# ensure your database has been initialized
74+
pomo init
75+
# run a new pomodoro
76+
pomo start -t my-project "write some code"
77+
# once finished view previously completed pomodoros
78+
pomo list
79+
.fi
80+
.RE
81+
.P
82+
.SH SEE ALSO
83+
.P
84+
See the pomo source repository on Github at https://github.\&com/kevinschoon/pomo for complete documentation.\&
85+
.P
86+
.SH AUTHORS
87+
.P
88+
Written by Kevin Schoon <me@kevinschoon.\&com> with help from the open source
89+
community.\&

‎man/pomo.1.scd‎

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
pomo(1)
2+
3+
# NAME
4+
5+
*Pomo* is a simple CLI for using the Pomodoro Technique.
6+
7+
# SYNOPSIS
8+
9+
*pomo* [OPTIONS] COMMAND [arg...]
10+
11+
# DESCRIPTION
12+
13+
*pomo* helps you track what you did, how long it took you to do it,
14+
and how much effort you expect it to take.
15+
16+
The Pomodoro Technique is simple and effective:
17+
18+
** Decide on a task you want to accomplish
19+
** Break the task into timed intervals (pomodoros), [approx. 25 min]
20+
** After each pomodoro take a short break [approx. 3 - 5 min]
21+
** Once all pomodoros are completed take a longer break [approx 15 - 20 min]
22+
** Repeat
23+
24+
# SUBCOMMANDS
25+
26+
See --help for the complete command usage
27+
28+
```
29+
start, s start a new task
30+
init initialize the sqlite database
31+
config, cf display the current configuration
32+
create, c create a new task without starting
33+
begin, b begin requested pomodoro
34+
list, l list historical tasks
35+
delete, d delete a stored task
36+
status, st output the current status
37+
38+
```
39+
40+
# CONFIGURATION
41+
42+
Pomo has a configuration file that is stored in *~/.config/pomo/config.json*.
43+
44+
```
45+
{
46+
"colors": null,
47+
"dateTimeFmt": "2006-01-02 15:04",
48+
"publish": false,
49+
"publishJson": false,
50+
"publishSocketPath": ""
51+
}
52+
```
53+
54+
# EXAMPLES
55+
56+
## GETTING STARTED
57+
58+
```
59+
# ensure your database has been initialized
60+
pomo init
61+
# run a new pomodoro
62+
pomo start -t my-project "write some code"
63+
# once finished view previously completed pomodoros
64+
pomo list
65+
```
66+
67+
# SEE ALSO
68+
69+
See the pomo source repository on Github at https://github.com/kevinschoon/pomo for complete documentation.
70+
71+
# AUTHORS
72+
73+
Written by Kevin Schoon <me@kevinschoon.com> with help from the open source
74+
community.

0 commit comments

Comments
 (0)