Tribblix: manual page: timew-chart.1

TIMEW-CHART(1) User Manuals TIMEW-CHART(1)

NAME

timew-chart - display chart report

SYNOPSIS

timew day [<range>] [<tag>...]
timew month [<range>] [<tag>...]
timew week [<range>] [<tag>...]

DESCRIPTION

A chart summarizes the tracked and untracked time with colored blocks
drawn on a timeline. It accepts date ranges and tags for filtering.
There are three types: day, week, and month with their respective
commands. The reports.<type>.range configuration setting overrides
the default date range. One can override the global default date
range with the reports.range configuration. For more details, and
precise times, use the 'summary' report.

month
The month command shows a chart depicting a single month (current
month by default). The default date range shown is :month.

week
The week command shows a chart depicting a single week (current
week by default). The default date range shown is :week.

day
The day command shows a chart depicting a single day (today by
default). The default date range shown is :day.

CONFIGURATION

<type> is one of month, week, day.

reports.<type>.cell
Determines how many minutes are represented by a single character
cell, for the charts. The value must be greater than '0'. A
value of '15' means that an hour is represented by 60/15, or 4
character cells. Suitable values are the divisors of 60 (30, 20,
15, 12, ...). Default value is '15'.

reports.<type>.day
Determines whether the current day of the month is shown at left
margin. Default value is 'yes'.

reports.<type>.holidays
Determines whether relevant holidays are shown beneath the
report. Default value is 'yes'.

reports.<type>.hours
Determines how the <type> report shows all the hours in a day
('all'), or is limited to only hours when data is tracked
('auto'). Default value is 'all'.

reports.<type>.lines
Determines how many lines are used to render each day on the
<type> report. Default value is '1'.

reports.<type>.month
Determines whether the current month is shown at left margin.
Default value is 'yes'.

reports.<type>.range
For reports that show a range of data, this setting will override
the default value. The value should be a range hint, see
timew-hints(7).

reports.<type>.spacing
Specifies how many spaces are inserted between the hours in the
<type> report exclusions. A value of '0' yields a more compact
report. Default value is '1'.

reports.<type>.axis
The value 'internal' puts the hour markers (timeline at the top)
inside the exclusion blocks, 'external' puts the hour markers in
a separate line; additional values might be defined in the
future. Default is 'internal' for the day report and 'external'
for other reports.

reports.<type>.summary
Determines whether the hours summary is shown. Default value is
'on'.

reports.<type>.totals
Determines whether the time totals are shown for each day on the
report. Default value is 'on'.

reports.<type>.week
Determines whether the current week number is shown at left
margin. Default value is 'yes'.

reports.<type>.weekday
Determines whether the current weekday is shown at left margin.
Default value is 'yes'.

tags.<tag>.color
Assigns a specific foreground and background color to a tag,
instead of the default color palette determined by your current
theme. Examples of valid colors include 'white', 'gray8', 'black
on yellow', and 'rgb345'.

HINTS

:blank
The ':blank' hint causes only the excluded time to be shown, with
no tracked time. This can be used to see the exclusions.

:ids
The ':ids' hint causes the intervals to be displayed with their
ids

EXAMPLES