Permalink
Browse files

Basic documentation for tagtime.

  • Loading branch information...
1 parent f428119 commit 69e05c0ed1a05eacb6dbffe44bec4aa1738f6a65 @pjf pjf committed Nov 21, 2012
Showing with 30 additions and 0 deletions.
  1. +30 −0 tagtimed.pl
View
@@ -8,6 +8,36 @@
# watching.pl so that we don't have to restart this daemon when settings
# change. (does it suffice to just re-require it?)
+=head1 NAME
+
+tagtimed - Stochastic tagging of your time!
+
+=head1 SYNPOSIS
+
+ $ tagtimed.pl # Start tagtime
+
+ $ tagtimed.pl -l # Start tagtime if not already running.
+
+ $ tagtimed.pl -s # Start tagtime if not already running, be silent otherwise.
+
+=head1 DESCRIPTION
+
+See L<http://messymatters.com/tagtime/>
+
+You can add the following to your C<.bashrc> or equivalent to make sure TagTime starts
+when you open a shell:
+
+ tagtimed.pl -l -s &
+
+=head1 BUGS
+
+The C<-l> switch must be used on all processes for locks to work correctly.
+
+The C<-l> switch will exit Tagtime if it's already running with another user using the C<-l>
+switch.
+
+=cut
+
{
use strict;
use warnings;

0 comments on commit 69e05c0

Please sign in to comment.