Permalink
Browse files

Adding man page.

  • Loading branch information...
1 parent e6c4789 commit 1ede09251afa2936580f38884fd250cedb1553b6 @knaveofdiamonds committed May 9, 2012
Showing with 66 additions and 0 deletions.
  1. +1 −0 Gemfile
  2. +32 −0 man/pompom.1
  3. +33 −0 man/pompom.1.ronn
View
@@ -13,4 +13,5 @@ group :development do
gem "yard", "~> 0.7"
gem "bundler"
gem "jeweler", "~> 1.8.3"
+ gem "ronn"
end
View
@@ -0,0 +1,32 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "POMPOM" "1" "May 2012" "" ""
+.
+.SH "NAME"
+\fBpompom\fR \- a comand line pomodoro timer
+.
+.SH "SYNOPSIS"
+\fBpompom\fR [\-m \fImessage\fR] [\-l \fIpath\fR] [\-t \fIseconds\fR]
+.
+.SH "DESCRIPTION"
+\fBPompom\fR runs a terminal\-based pomodoro timer, and can log the work you do in each pomodoro\.
+.
+.SH "OPTIONS"
+.
+.IP "\(bu" 4
+\fB\-m\fR, \fB\-\-message\fR: The message you want logged for the work you are doing\. If no message is given, then nothing will be logged
+.
+.IP "\(bu" 4
+\fB\-l\fR, \fB\-\-log\fR: The log location\. By default this will be stored in your home directory at ~/\.pompom/worklog
+.
+.IP "\(bu" 4
+\fB\-t\fR, \fB\-\-time\fR The time in seconds the timer should run for\. By default 1500, (25 minutes)\.
+.
+.IP "" 0
+.
+.P
+Pompom will play a sound at the end of a pomodoro if you have the play utility installed (provided by the sox package, at least on Ubuntu), and a file named ~/\.pompom/sound\.wav
+.
+.SH "COPYRIGHT"
+Pompom is Copyright (C) 2012 Roland Swingler \fIhttp://github\.com/knaveofdiamonds\fR
View
@@ -0,0 +1,33 @@
+pompom(1) -- a comand line pomodoro timer
+=========================================
+
+## SYNOPSIS
+
+`pompom` [-m <message>] [-l <path>] [-t <seconds>]
+
+## DESCRIPTION
+
+**Pompom** runs a terminal-based pomodoro timer, and can log the work
+you do in each pomodoro.
+
+## OPTIONS
+
+ * `-m`, `--message`:
+ The message you want logged for the work you are doing. If
+ no message is given, then nothing will be logged
+
+ * `-l`, `--log`:
+ The log location. By default this will be stored in your
+ home directory at ~/.pompom/worklog
+
+ * `-t`, `--time`
+ The time in seconds the timer should run for. By default
+ 1500, (25 minutes).
+
+Pompom will play a sound at the end of a pomodoro if you have the play
+utility installed (provided by the sox package, at least on Ubuntu),
+and a file named ~/.pompom/sound.wav
+
+## COPYRIGHT
+
+Pompom is Copyright (C) 2012 Roland Swingler <http://github.com/knaveofdiamonds>

0 comments on commit 1ede092

Please sign in to comment.