today.1 (1828B) [raw]
1 .Dd March 3, 2022 2 .Dt TODAY 1 3 .Os 4 .Sh NAME 5 .Nm today 6 .Nd what did you do today? 7 .Sh SYNOPSIS 8 .Nm 9 .Op Fl ehi 10 .Op Fl l Op Ar NUM 11 .Sh DESCRIPTION 12 .Nm 13 is a tool for quickly documenting a day's work at the end of the day. 14 .Nm 15 has primitive recall capabilities; 16 it's easy to access yesterday's notes 17 but more complex analysis is left to other tools 18 like 19 .Xr grep 1 20 and 21 .Xr awk 1 . 22 Similarly, 23 establishing any sort of tagging system is left as an exercise for 24 the reader. 25 .Pp 26 .Nm 27 uses 28 .Xr ed 1 29 for edits. 30 This may add a bit of a learning curve, 31 but the lack of a view of the file provides a distraction free, 32 append-only mindset for recording whatever is top of mind. 33 .Pp 34 The options are as follows: 35 .Bl -tag -width Ds 36 .It Fl e 37 Open the log file in your 38 .Ev $EDITOR 39 .It Fl h 40 Display the help message and exit 41 .It Fl i 42 Initialize the 43 .Nm 44 repository. 45 .It Fl l Op Ar NUM 46 List the last 47 .Ar NUM 48 days-worth of entries, 49 or all if 50 .Ar NUM 51 not given. 52 .El 53 .Sh ENVIRONMENT 54 .Bl -tag -width "$TODAY_DIR/log" 55 .It Ev $TODAY_DIR 56 Override the default repo location, 57 .Pa $HOME/.today . 58 .It Ev $EDITOR 59 Preferred editor for 60 .Fl e 61 flag. 62 .El 63 .Sh FILES 64 .Bl -tag -width "$TODAY_DIR/log" 65 .It Pa $TODAY_DIR 66 Git repository 67 .It Pa $TODAY_DIR/log 68 Log file. 69 Entries are separated by [YYYY-MM-DD] entries. 70 .El 71 .Sh EXAMPLES 72 One time setup: 73 .Pp 74 .Dl $ today -i 75 .Pp 76 Jot down what you did today: 77 .Bd -literal -offset indent 78 $ today 79 ed> a 80 * Learned some mdoc(7) 81 * Rewrote today(1) 82 \&. 83 ed> wq 84 .Ed 85 .Pp 86 View yesterday's tasks: 87 .Bd -literal -offset indent 88 $ today -l 1 89 [2022-03-02] 90 * wrote some code 91 * went for a walk 92 brag: shipped xyz big feature! 93 .Ed 94 .Pp 95 Search for all brag-document worthy items: 96 .Bd -literal -offset indent 97 $ today -l | grep '^brag:' 98 brag: shipped xyz big feature! 99 .Ed 100 .Sh SEE ALSO 101 .Xr ed 1 , 102 .Xr git 1 103 .Sh AUTHORS 104 .An Alex Karle Aq Mt alex@alexkarle.com