commit 27cd0c14a312d0b46f2dfcaff94ee0ec02b24e0f (patch)
parent db2f2e727fab83a345494b840272b53fe4ae5d77
Author: Alex Karle <alex@alexkarle.com>
Date: Thu, 3 Mar 2022 22:00:47 -0500
Add man page for today(1)
Hopefully this helps show the intended use cases!
Diffstat:
| A | today.1 | | | 88 | +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
1 file changed, 88 insertions(+), 0 deletions(-)
diff --git a/today.1 b/today.1
@@ -0,0 +1,88 @@
+.Dd March 3, 2022
+.Dt TODAY 1
+.Os
+.Sh NAME
+.Nm today
+.Nd what did you do today?
+.Sh SYNOPSIS
+.Nm
+.Op Fl ein
+.Op Fl l Op Ar NUM
+.Sh DESCRIPTION
+.Nm
+is a tool for quickly documenting a days work at the end of the day.
+It has primitive recall capabilities;
+it's easy to access yesterday's notes,
+but more complex analysis is left to other tools.
+.Pp
+It 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
+edit the most recent day's notes.
+.It Fl i
+initialize the
+.Nm
+repository.
+.It Fl n
+start a new day's entry, indicated by a [YYYY-MM-DD] separator.
+.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 .
+.El
+.Sh FILES
+.Bl -tag -width "$TODAY_DIR/log"
+.It Pa $TODAY_DIR
+Git repository
+.It Pa $TODAY_DIR/log
+Log file
+.El
+.Sh EXAMPLES
+One time setup:
+.Pp
+.Dl today -i
+.Pp
+Jot down what you did today:
+.Bd -literal -offset indent
+$ today -n
+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
