mirror of
https://github.com/GothenburgBitFactory/timewarrior.git
synced 2025-06-26 10:54:28 +02:00
Document report hints with the respective commands
Signed-off-by: Thomas Lauf <thomas.lauf@tngtech.com>
This commit is contained in:
parent
d925553116
commit
59a1d7fd11
4 changed files with 23 additions and 16 deletions
|
@ -1,3 +1,4 @@
|
|||
- #678 Document report hints with the respective commands
|
||||
- #677 Extension names starting with 'timew' cause problems
|
||||
(thanks to ftambara)
|
||||
- #661 Make display of ids and annotations the default in summary report for new users
|
||||
|
|
|
@ -29,6 +29,16 @@ The default date range shown is *:week*.
|
|||
The day command shows a chart depicting a single day (today by default).
|
||||
The default date range shown is *:day*.
|
||||
|
||||
== HINTS
|
||||
Apart from range hints (see **timew-hints**(7)), the chart reports adhere to the following hints:
|
||||
|
||||
**:blank**::
|
||||
The ':blank' hint causes only the excluded time to be shown, with no tracked time.
|
||||
This can be used to display the exclusions.
|
||||
|
||||
**:ids**::
|
||||
The ':ids' hint causes the intervals to be displayed with their IDs
|
||||
|
||||
== CONFIGURATION
|
||||
_<type>_ is one of **month**, **week**, **day**.
|
||||
|
||||
|
@ -61,8 +71,7 @@ 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).
|
||||
The value has to be a range hint (without the prefix colon), see **timew-hints**(7).
|
||||
|
||||
**reports.**__<type>__**.spacing**::
|
||||
Specifies how many spaces are inserted between the hours in the <type> report exclusions.
|
||||
|
@ -93,15 +102,6 @@ Default value is 'yes'.
|
|||
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
|
||||
Charts accept date ranges and/or tags, or ids for filtering:
|
||||
|
||||
|
@ -112,4 +112,4 @@ Charts accept date ranges and/or tags, or ids for filtering:
|
|||
See **timew-ranges**(7) and **timew-hints**(7) on the different ways to provide date ranges.
|
||||
|
||||
== SEE ALSO
|
||||
**timew-summary**(1),
|
||||
**timew-summary**(1)
|
||||
|
|
|
@ -14,6 +14,12 @@ The 'reports.gaps.range' configuration setting overrides the default date range.
|
|||
The ':blank' hint causes only the excluded time to be shown, with no tracked time.
|
||||
The default date range shown is ':day'.
|
||||
|
||||
== HINTS
|
||||
Apart from range hints (see **timew-hints**(7)), the gaps report adheres to the following hints:
|
||||
|
||||
**:blank**::
|
||||
Show only the time that is excluded from tracking, without showing any tracked time.
|
||||
|
||||
== CONFIGURATION
|
||||
**reports.gaps.range**::
|
||||
For reports that show a range of data, this setting will override the default value.
|
||||
|
|
|
@ -10,10 +10,10 @@ timew-summary - display a time-tracking summary
|
|||
|
||||
== DESCRIPTION
|
||||
Displays a table summarizing tracked time, by default for the current day.
|
||||
Accepts date ranges (or range hints) and tags, or ids for filtering.
|
||||
Accepts date ranges (or range hints) and tags, or IDs for filtering.
|
||||
|
||||
When ids are given, date ranges are ignored.
|
||||
Specifying both, tags and ids, is an error.
|
||||
When IDs are given, date ranges are ignored.
|
||||
Specifying both, tags and IDs, is an error.
|
||||
|
||||
== HINTS
|
||||
Apart from range hints (see **timew-hints**(7)), the summary report adheres to the following hints:
|
||||
|
@ -33,7 +33,7 @@ Can be used on the command line to override the configured setting.
|
|||
|
||||
**:ids**::
|
||||
**:no-ids**::
|
||||
Toggle the display of ids in the summary report.
|
||||
Toggle the display of IDs in the summary report.
|
||||
Can be used on the command line to override the configured setting.
|
||||
The ':ids' hint adds an 'ID' column to the summary table.
|
||||
Those ids can be used for interval modification.
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue