Docs: Added reports.gaps.range description

This commit is contained in:
Paul Beckingham 2016-05-28 14:45:23 -04:00
parent 6b2b7b19e3
commit d52d92f4b8

View file

@ -99,6 +99,10 @@ each extention and its status. See also 'diagnostics'.
.TP .TP
.B timew gaps [<interval>] [<tag> ...] .B timew gaps [<interval>] [<tag> ...]
Displays a summary of time that is neither tracked, nor excluded from tracking. Displays a summary of time that is neither tracked, nor excluded from tracking.
The 'reports.gaps.range' configuration setting overrides the default date range.
The default date range shown is ':day'.
See also 'summary'. See also 'summary'.
.TP .TP
@ -263,6 +267,10 @@ forms of feedback, for purposes of automation. The supported hints are:
:color Force color on, even if not connected to a TTY :color Force color on, even if not connected to a TTY
:nocolor Force color off, even if connected to a TTY :nocolor Force color off, even if connected to a TTY
:blank Leaves tracked time out of a report :blank Leaves tracked time out of a report
:fill Expand time to fill surrounding available gap
Only functions when exclusions are provided
Range hints provide convenient shortcuts to date ranges:
:yesterday The 24 hours of the previous day :yesterday The 24 hours of the previous day
:day The 24 hours of the current day :day The 24 hours of the current day
@ -272,8 +280,6 @@ forms of feedback, for purposes of automation. The supported hints are:
:year This year :year This year
:lastweek Last week :lastweek Last week
:fill Expand time to fill surrounding available gap
Only functions when exclusions are provided
.SH CONFIGURATION FILE AND OVERRIDE OPTIONS .SH CONFIGURATION FILE AND OVERRIDE OPTIONS
Timewarrior stores its configuration in a file in the user's home directory: Timewarrior stores its configuration in a file in the user's home directory:
@ -303,6 +309,13 @@ Determines whether the <type> report shows all 24 hours in a day, or is limited
to only hours where data is tracked. Default value is 'off'. to only hours where data is tracked. Default value is 'off'.
Type is one of 'month', 'week', 'day'. Type is one of 'month', 'week', 'day'.
.TP
.B reports.<type>.range = <range hint>
.br
For reports that show a range of data, this setting will override the default
value. The value should be a range hint, see 'hints'
Type is one of 'gaps', 'day', 'week', 'month'.
.TP .TP
.B reports.<type>.spacing = 1 .B reports.<type>.spacing = 1
.br .br