1TIMEW-CHART(1)                   User Manuals                   TIMEW-CHART(1)
2
3
4

NAME

6       timew-chart - display chart report
7

SYNOPSIS

9       timew day [<range>] [<tag>...]
10       timew month [<range>] [<tag>...]
11       timew week [<range>] [<tag>...]
12

DESCRIPTION

14       A chart summarizes the tracked and untracked time with colored blocks
15       drawn on a timeline. It accepts date ranges and tags for filtering.
16       There are three types: day, week, and month with their respective
17       commands. The reports.<type>.range configuration setting overrides the
18       default date range. One can override the global default date range with
19       the reports.range configuration. For more details, and precise times,
20       use the 'summary' report.
21
22       month
23           The month command shows a chart depicting a single month (current
24           month by default). The default date range shown is :month.
25
26       week
27           The week command shows a chart depicting a single week (current
28           week by default). The default date range shown is :week.
29
30       day
31           The day command shows a chart depicting a single day (today by
32           default). The default date range shown is :day.
33

CONFIGURATION

35       <type> is one of month, week, day.
36
37       reports.<type>.cell
38           Determines how many minutes are represented by a single character
39           cell, for the charts. The value must be greater than '0'. A value
40           of '15' means that an hour is represented by 60/15, or 4 character
41           cells. Suitable values are the divisors of 60 (30, 20, 15, 12,
42           ...). Default value is '15'.
43
44       reports.<type>.day
45           Determines whether the current day of the month is shown at left
46           margin. Default value is 'yes'.
47
48       reports.<type>.holidays
49           Determines whether relevant holidays are shown beneath the report.
50           Default value is 'yes'.
51
52       reports.<type>.hours
53           Determines how the <type> report shows all the hours in a day
54           ('all'), or is limited to only hours when data is tracked ('auto').
55           Default value is 'all'.
56
57       reports.<type>.lines
58           Determines how many lines are used to render each day on the <type>
59           report. Default value is '1'.
60
61       reports.<type>.month
62           Determines whether the current month is shown at left margin.
63           Default value is 'yes'.
64
65       reports.<type>.range
66           For reports that show a range of data, this setting will override
67           the default value. The value should be a range hint, see
68           timew-hints(7).
69
70       reports.<type>.spacing
71           Specifies how many spaces are inserted between the hours in the
72           <type> report exclusions. A value of '0' yields a more compact
73           report. Default value is '1'.
74
75       reports.<type>.axis
76           The value 'internal' puts the hour markers (timeline at the top)
77           inside the exclusion blocks, 'external' puts the hour markers in a
78           separate line; additional values might be defined in the future.
79           Default is 'internal' for the day report and 'external' for other
80           reports.
81
82       reports.<type>.summary
83           Determines whether the hours summary is shown. Default value is
84           'on'.
85
86       reports.<type>.totals
87           Determines whether the time totals are shown for each day on the
88           report. Default value is 'on'.
89
90       reports.<type>.week
91           Determines whether the current week number is shown at left margin.
92           Default value is 'yes'.
93
94       reports.<type>.weekday
95           Determines whether the current weekday is shown at left margin.
96           Default value is 'yes'.
97
98       tags.<tag>.color
99           Assigns a specific foreground and background color to a tag,
100           instead of the default color palette determined by your current
101           theme. Examples of valid colors include 'white', 'gray8', 'black on
102           yellow', and 'rgb345'.
103

HINTS

105       :blank
106           The ':blank' hint causes only the excluded time to be shown, with
107           no tracked time. This can be used to see the exclusions.
108
109       :ids
110           The ':ids' hint causes the intervals to be displayed with their ids
111

EXAMPLES

113       Charts accept date ranges and tags for filtering, or shortcut hints:
114
115           $ timew month 1st - today
116           $ timew week FOO BAR
117           $ timew day :week
118

SEE ALSO

120       timew-day(1), timew-month(1), timew-summary(1), timew-week(1)
121
122
123
124timew 1.6.0                       2023-09-18                    TIMEW-CHART(1)
Impressum