Docs: Updated man page with new report settings

This commit is contained in:
Paul Beckingham 2016-05-21 15:47:06 -05:00
parent aa61490461
commit 2dd50d5f9a

View file

@ -296,44 +296,65 @@ Useful for troubleshooting, but not for general use.
Default value is 'off'. Default value is 'off'.
.TP .TP
.B reports.day.24hours = off .B reports.<type>.24h = off
.br .br
Determines whether the day report shows all 24 hours in a day, or is limited 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'.
.TP .TP
.B reports.day.spacing = 1 .B reports.<type>.spacing = 1
.br .br
Specifies how many spaces are inserted between the hours in the day report Specifies how many spaces are inserted between the hours in the <type> report
exclusions. A value of '0' give a move compact report. Default value is '1'. exclusions. A value of '0' give a move compact report. Default value is '1'.
Type is one of 'month', 'week', 'day'.
.TP .TP
.B reports.day.style = compact .B reports.<type>.style = compact
.br .br
The 'compact' style puts the hour markers inside the exclusion blocks. The 'compact' style puts the hour markers inside the exclusion blocks.
Type is one of 'month', 'week', 'day'.
.TP .TP
.B reports.month.24hours = off .B reports.<type>.summary = on
.br
Determines whether the day report shows all 24 hours in a day, or is limited
to only hours where data is tracked. Default value is 'off'.
.TP
.B reports.month.spacing = 1
.br
Specifies how many spaces are inserted between the hours in the day report
exclusions. A value of '0' give a move compact report. Default value is '1'.
.TP
.B reports.month.summary = on
.br .br
Determines whether the hours summary is shown. Default value is 'on'. Determines whether the hours summary is shown. Default value is 'on'.
Type is one of 'month', 'week', 'day'.
.TP .TP
.B reports.month.lines = 1 .B reports.<type>.lines = 1
.br .br
Determines how many lines are used to render each day on the month report. Determines how many lines are used to render each day on the <type> report.
Default value is '1'. Default value is '1'.
Type is one of 'month', 'week', 'day'.
.TP
.B reports.<type>.month = yes
.br
Determines whether the current month is shown at left margin.
Default value is 'yes'.
Type is one of 'month', 'week', 'day'.
.TP
.B reports.<type>.week = yes
.br
Determines whether the current week number is shown at left margin.
Default value is 'yes'.
Type is one of 'month', 'week', 'day'.
.TP
.B reports.<type>.day = yes
.br
Determines whether the current day of the month is shown at left margin.
Default value is 'yes'.
Type is one of 'month', 'week', 'day'.
.TP
.B reports.<type>.weekday = yes
.br
Determines whether the current weekday is shown at left margin.
Default value is 'yes'.
Type is one of 'month', 'week', 'day'.
.TP .TP
.B verbose = yes .B verbose = yes