.Dd March 3, 2022
.Dt TODAY 1
.Os
.Sh NAME
.Nm today
.Nd what did you do today?
.Sh SYNOPSIS
.Nm
.Op Fl ehi
.Op Fl l Op Ar NUM
.Sh DESCRIPTION
.Nm
is a tool for quickly documenting a day's work at the end of the day.
.Nm
has primitive recall capabilities;
it's easy to access yesterday's notes
but more complex analysis is left to other tools
like
.Xr grep 1
and
.Xr awk 1 .
Similarly,
establishing any sort of tagging system is left as an exercise for
the reader.
.Pp
.Nm
uses
.Xr ed 1
for edits.
This may add a bit of a learning curve,
but the lack of a view of the file provides a distraction free,
append-only mindset for recording whatever is top of mind.
.Pp
The options are as follows:
.Bl -tag -width Ds
.It Fl e
Open the log file in your
.Ev $EDITOR
.It Fl h
Display the help message and exit
.It Fl i
Initialize the
.Nm
repository.
.It Fl l Op Ar NUM
List the last
.Ar NUM
days-worth of entries,
or all if
.Ar NUM
not given.
.El
.Sh ENVIRONMENT
.Bl -tag -width "$TODAY_DIR/log"
.It Ev $TODAY_DIR
Override the default repo location,
.Pa $HOME/.today .
.It Ev $EDITOR
Preferred editor for
.Fl e
flag.
.El
.Sh FILES
.Bl -tag -width "$TODAY_DIR/log"
.It Pa $TODAY_DIR
Git repository
.It Pa $TODAY_DIR/log
Log file.
Entries are separated by [YYYY-MM-DD] entries.
.El
.Sh EXAMPLES
One time setup:
.Pp
.Dl $ today -i
.Pp
Jot down what you did today:
.Bd -literal -offset indent
$ today
ed> a
* Learned some mdoc(7)
* Rewrote today(1)
\&.
ed> wq
.Ed
.Pp
View yesterday's tasks:
.Bd -literal -offset indent
$ today -l 1
[2022-03-02]
* wrote some code
* went for a walk
brag: shipped xyz big feature!
.Ed
.Pp
Search for all brag-document worthy items:
.Bd -literal -offset indent
$ today -l | grep '^brag:'
brag: shipped xyz big feature!
.Ed
.Sh SEE ALSO
.Xr ed 1 ,
.Xr git 1
.Sh AUTHORS
.An Alex Karle Aq Mt alex@alexkarle.com