Skip to content

Commit

Permalink
Consolidate chart documentation into timew-chart.1
Browse files Browse the repository at this point in the history
  • Loading branch information
@lauft
lauft committed Feb 21, 2019
1 parent 73bdb81 commit 661e9f6
Show file tree
Hide file tree
Showing 6 changed files with 188 additions and 226 deletions.
1 change: 1 addition & 0 deletions doc/CMakeLists.txt
View file
Expand Up @@ -8,6 +8,7 @@ add_subdirectory (themes)
configure_file (man/timew.1.in man/timew.1) configure_file (man/timew.1.in man/timew.1)
configure_file (man/timew-annotate.1.in man/timew-annotate.1) configure_file (man/timew-annotate.1.in man/timew-annotate.1)
configure_file (man/timew-cancel.1.in man/timew-cancel.1) configure_file (man/timew-cancel.1.in man/timew-cancel.1)
configure_file (man/timew-chart.1.in man/timew-chart.1)
configure_file (man/timew-config.1.in man/timew-config.1) configure_file (man/timew-config.1.in man/timew-config.1)
configure_file (man/timew-continue.1.in man/timew-continue.1) configure_file (man/timew-continue.1.in man/timew-continue.1)
configure_file (man/timew-day.1.in man/timew-day.1) configure_file (man/timew-day.1.in man/timew-day.1)
Expand Down
183 changes: 183 additions & 0 deletions doc/man/timew-chart.1.in
View file
@@ -0,0 +1,183 @@
.TH timew-chart 1 "${PACKAGE_DATE}" "${PACKAGE_STRING}" "User Manuals"
.
.SH NAME
timew-chart \- display chart report
.
.SH SYNOPSIS
.B timew day
[
.I <range>
] [
.I <tag>
.B ...
]
.br
.B timew month
[
.I <range>
] [
.I <tag>
.B ...
]
.br
.B timew week
[
.I <range>
] [
.I <tag>
.B ...
]
.
.SH 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:
.BR day ", " week ", and " month
with their respective commands.
The
.BI reports. <type> .range
configuration setting overrides the default date range.
For more details, and precise times, use the 'summary' report.

.TP
.B month
The month command shows a chart depicting a single month (current month by default).
The default date range shown is
.BR :month .
.
.TP
.B week
The week command shows a chart depicting a single week (current week by default).
The default date range shown is
.BR :week .
.
.TP
.B day
The day command shows a chart depicting a single day (today by default).
The default date range shown is
.BR :day .
.
.SH CONFIGURATION
.IR <type> " is one of"
.BR month ", " week ", " day "."
.TP
.BI reports. <type> .cell
.RS
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, ...).
.br
Default value is '15'.
.RE
.TP
.BI reports. <type> .day
.RS
Determines whether the current day of the month is shown at left margin.
.br
Default value is 'yes'.
.RE
.TP
.BI reports. <type> .holidays
.RS
Determines whether relevant holidays are shown beneath the report.
.br
Default value is 'yes'.
.RE
.TP
.BI reports. <type> .hours
.RS
Determines how the <type> report shows all the hours in a day ('all'), or is limited to only hours where data is tracked ('auto').
.br
Default value is 'all'.
.RE
.TP
.BI reports. <type> .lines
.RS
Determines how many lines are used to render each day on the <type> report.
.br
Default value is '1'.
.RE
.TP
.BI reports. <type> .month
.RS
Determines whether the current month is shown at left margin.
.br
Default value is 'yes'.
.RE
.TP
.BI reports. <type> .range
.RS
For reports that show a range of data, this setting will override the default value.
The value should be a range hint, see
.BR timew-hints (7).
.RE
.TP
.BI reports. <type> .spacing
.RS
Specifies how many spaces are inserted between the hours in the <type> report exclusions.
A value of '0' yields a more compact report.
.br
Default value is '1'.
.RE
.TP
.BI reports. <type> .axis
.RS
The value 'internal' puts the hour markers (time line at the top) inside the exclusion blocks, 'external' puts the hour markers in a separate line; additional values might be defined in the future.
.br
Default is 'internal' for the day report and 'external' for other reports.
.br
.RE
.TP
.BI reports. <type> .summary
.RS
Determines whether the hours summary is shown.
.br
Default value is 'on'.
.RE
.TP
.BI reports. <type> .totals
.RS
Determines whether the time totals are shown for each day on the report.
.br
Default value is 'on'.
.RE
.TP
.BI reports. <type> .week
.RS
Determines whether the current week number is shown at left margin.
.br
Default value is 'yes'.
.RE
.TP
.BI reports. <type> .weekday
.RS
Determines whether the current weekday is shown at left margin.
.br
Default value is 'yes'.
.RE
.
.SH HINTS
.TP
.B :blank
The ':blank' hint causes only the excluded time to be shown, with no tracked time.
This can be used to see the exclusions.
.TP
.B :ids
The ':ids' hint causes the intervals to be displayed with their ids
.
.SH EXAMPLES
Charts accept date ranges and tags for filtering, or shortcut hints:
.RS
$ timew month 1st - today
.br
$ timew week FOO BAR
.br
$ timew day :week
.RE
.
.SH "SEE ALSO"
.BR timew-day (1),
.BR timew-month (1),
.BR timew-summary (1),
.BR timew-week (1)
123 changes: 1 addition & 122 deletions doc/man/timew-config.7.in
View file
Expand Up @@ -25,7 +25,7 @@ rc.verbose=0
.PP .PP
Note that hints can also do this (:quiet). Note that hints can also do this (:quiet).
. .
.SH "GENERAL CONFIGURATION" .SH CONFIGURATION
.TP .TP
.B confirmation .B confirmation
.RS .RS
Expand Down Expand Up @@ -60,124 +60,3 @@ The debug output prefix string.
.br .br
Default value is '>>'. Default value is '>>'.
.RE .RE
.SH "CHART CONFIGURATION"
.TP
.B reports.<type>.cell
.RS
Determines how many minutes are represented by a single character cell, for the charts.
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, ...).
The value must be greater than '0'.
.br
Default value is '15'.
.br
Type is one of 'month', 'week', 'day'.
.RE
.TP
.B reports.<type>.day
.RS
Determines whether the current day of the month is shown at left margin.
.br
Default value is 'yes'.
.br
Type is one of 'month', 'week', 'day'.
.RE
.TP
.B reports.<type>.holidays
.RS
Determines whether relevant holidays are shown beneath the report.
.br
Default value is 'yes'.
.br
Type is one of 'month', 'week', 'day', 'summary'.
.RE
.TP
.B reports.<type>.hours
.RS
Determines how the <type> report shows all the hours in a day ('all'), or is limited to only hours where data is tracked ('auto').
.br
Default value is 'all'.
.br
Type is one of 'month', 'week', 'day'.
.RE
.TP
.B reports.<type>.lines
.RS
Determines how many lines are used to render each day on the <type> report.
.br
Default value is '1'.
.br
Type is one of 'month', 'week', 'day'.
.RE
.TP
.B reports.<type>.month
.RS
Determines whether the current month is shown at left margin.
.br
Default value is 'yes'.
.br
Type is one of 'month', 'week', 'day'.
.RE
.TP
.B reports.<type>.range
.RS
For reports that show a range of data, this setting will override the default value.
The value should be a range hint, see
.BR timew-hints (7).
.br
Type is one of 'gaps', 'day', 'week', 'month'.
.RE
.TP
.B reports.<type>.spacing
.RS
Specifies how many spaces are inserted between the hours in the <type> report exclusions.
A value of '0' yields a more compact report.
.br
Default value is '1'.
.br
Type is one of 'month', 'week', 'day'.
.RE
.TP
.B reports.<type>.axis
.RS
The value 'internal' puts the hour markers (time line at the top) inside the exclusion blocks, 'external' puts the hour markers in a separate line; additional values might be defined in the future.
.br
Default is 'internal' for the day report and 'external' for other reports.
.br
.RE
.TP
.B reports.<type>.summary
.RS
Determines whether the hours summary is shown.
.br
Default value is 'on'.
.br
Type is one of 'month', 'week', 'day'.
.RE
.TP
.B reports.<type>.totals
.RS
Determines whether the time totals are shown for each day on the report.
.br
Default value is 'on'.
.br
Type is one of 'month', 'week', 'day'.
.RE
.TP
.B reports.<type>.week
.RS
Determines whether the current week number is shown at left margin.
.br
Default value is 'yes'.
.br
Type is one of 'month', 'week', 'day'.
.RE
.TP
.B reports.<type>.weekday
.RS
Determines whether the current weekday is shown at left margin.
.br
Default value is 'yes'.
.br
Type is one of 'month', 'week', 'day'.
.RE
37 changes: 1 addition & 36 deletions doc/man/timew-day.1.in
View file
@@ -1,36 +1 @@
.TH timew-day 1 "${PACKAGE_DATE}" "${PACKAGE_STRING}" "User Manuals" .so man1/timew-chart.1
.
.SH NAME
timew-day \- display day chart
.
.SH SYNOPSIS
.B timew day
[
.I <range>
] [
.I <tag>
.B ...
]
.
.SH DESCRIPTION
The day command shows a chart depicting a single day (today by default), with colored blocks drawn on a timeline.
The chart summarizes the tracked and untracked time.
.
Charts accept date ranges and tags for filtering, or shortcut hints:
.
$ timew day monday - today
$ timew day :week
$ timew day :month
.
The 'reports.day.range' configuration setting overrides the default date range.
The default date range shown is ':day'.
.
The ':blank' hint causes only the excluded time to be shown, with no tracked time.
This can be used to see the exclusions.
.
For more details, and precise times, use the 'summary' report.
.
.SH "SEE ALSO"
.BR timew-month (1),
.BR timew-summary (1),
.BR timew-week (1)

0 comments on commit 661e9f6

Please sign in to comment.