track/track.1

74 lines
1.5 KiB
Groff
Raw Permalink Normal View History

2024-04-15 15:40:32 +00:00
.TH TRACK 1 "15 Apr 2024" "v2024.04.15"
2020-10-11 13:53:53 +00:00
2018-05-29 21:36:02 +00:00
.SH NAME
track \- a minimalistic data tracker
2020-10-11 13:53:53 +00:00
2018-05-29 23:48:31 +00:00
.SH SYNOPSIS
2020-10-11 13:53:53 +00:00
.B track [options] <metric> [<value>]
2018-05-29 23:59:35 +00:00
.P
2020-10-11 13:53:53 +00:00
2018-05-29 21:36:02 +00:00
.SH DESRIPTION
2018-05-29 23:48:31 +00:00
Using the command line,
.B track
allows you to enter one and only one data point on any metric per day. It's
great for tracking your weight or how many cups of coffee you drank.
.B track
logs your data for each given metric to a CSV file. If you track the same
2020-10-11 13:53:53 +00:00
metric twice in the same day, the data is updated. Data need not be numeric.
2018-05-29 23:48:31 +00:00
.SH OPTIONS
2020-10-11 13:53:53 +00:00
Setting the
.B $TRACK_DIR
environment variable will change the default location where the data is stored.
If it is not set the current directory is used.
2018-05-29 23:48:31 +00:00
.TP
.B -a
Show all values of a metric
.TP
.B -n <N>
Show N values of a metric
.TP
.B -x <metric>
Remove metric file
.TP
2020-10-11 13:53:53 +00:00
.B -c
Output in CSV format
.TP
.B -l
List all metrics being tracked
.TP
.B -h
Show the help.
.TP
2018-05-29 23:48:31 +00:00
.B -v
Display current version information.
.TP
.B -d
Debug mode.
2020-10-11 13:53:53 +00:00
.SH EXAMPLES
.TP
.B track weight 150
Log 150lbs for today's weight
.TP
.B track -n 10 calories
Show last 10 days calorie values
.TP
2020-10-11 13:57:39 +00:00
.B track mood "tired and hungry"
Log a multi-word phrase as the value for your current mood
2020-10-11 13:53:53 +00:00
.TP
.B track mood
Show last value logged for mood
.SH LICENSE
GNU General Public License v3.0 or later at
.TP
.B https://www.gnu.org/licenses/gpl-3.0-standalone.html
2018-05-29 23:48:31 +00:00
.SH BUGS
2020-10-11 13:53:53 +00:00
Report issues at the git repository at
.B https://github.com/jamestomasino/track
2018-05-29 23:48:31 +00:00
.SH AUTHOR
2020-10-11 13:53:53 +00:00
James Tomasino <james (at) tomasino (dot) org>