mirror of
https://github.com/GothenburgBitFactory/timewarrior.git
synced 2025-07-07 20:06:39 +02:00
Extract commands into individual man pages
This commit is contained in:
Thomas Lauf
parent
fcd49c2a02
commit
7dd16c4950
30 changed files with 406 additions and 435 deletions
4
doc/man/timew-cancel.1.in
Normal file
4
doc/man/timew-cancel.1.in
Normal file
|
|
@ -0,0 +1,4 @@
|
||||||
|
.TP
|
||||||
|
.B timew cancel
|
||||||
|
If there is an open interval, it is abandoned.
|
||||||
|
See also 'stop'.
|
||||||
26
doc/man/timew-config.1.in
Normal file
26
doc/man/timew-config.1.in
Normal file
|
|
@ -0,0 +1,26 @@
|
||||||
|
.TP
|
||||||
|
.B timew config [<name> [<value> | '']]
|
||||||
|
Allows setting and removing configuration values, as an alternative to directly
|
||||||
|
editing your ~/.timewarrior/timewarrior.cfg file. For example:
|
||||||
|
|
||||||
|
$ timew config verbose yes
|
||||||
|
$ timew config verbose ''
|
||||||
|
$ timew config verbose
|
||||||
|
|
||||||
|
The first command sets 'verbose' to 'yes'. The second sets it to a blank value
|
||||||
|
which overrides the default value. The third example deletes the 'verbose'
|
||||||
|
setting.
|
||||||
|
|
||||||
|
When modifying configuration in this way, interactive confirmation will be
|
||||||
|
sought. To override this confirmation, use the ':yes' hint, which means you
|
||||||
|
intend to answer 'yes' to the confirmation questions:
|
||||||
|
|
||||||
|
$ timew config verbose '' :yes
|
||||||
|
|
||||||
|
If no arguments are provided, all configuration settings are shown:
|
||||||
|
|
||||||
|
$ timew config
|
||||||
|
verbose = yes
|
||||||
|
...
|
||||||
|
|
||||||
|
See also 'hints', 'show'.
|
||||||
15
doc/man/timew-continue.1.in
Normal file
15
doc/man/timew-continue.1.in
Normal file
|
|
@ -0,0 +1,15 @@
|
||||||
|
.TP
|
||||||
|
.B timew continue [@<id>] [<date>|<interval>]
|
||||||
|
Resumes tracking of closed intervals. For example:
|
||||||
|
|
||||||
|
$ timew track 9am - 10am tag1 tag2
|
||||||
|
$ timew track 11am - 1pm tag3
|
||||||
|
$ timew continue @2
|
||||||
|
|
||||||
|
The 'continue' command creates a new interval, starting now, and using the
|
||||||
|
tags 'tag1' and 'tag2'.
|
||||||
|
Using the 'summary' command and specifying the ':ids' hint shows interval IDs.
|
||||||
|
This command is a convenient way to resume work without re-entering the
|
||||||
|
tags.
|
||||||
|
|
||||||
|
See also 'start', 'stop'.
|
||||||
21
doc/man/timew-day.1.in
Normal file
21
doc/man/timew-day.1.in
Normal file
|
|
@ -0,0 +1,21 @@
|
||||||
|
.TP
|
||||||
|
.B timew day [<interval>] [<tag> ...]
|
||||||
|
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.
|
||||||
|
|
||||||
|
See also 'week', 'month', 'summary'.
|
||||||
13
doc/man/timew-delete.1.in
Normal file
13
doc/man/timew-delete.1.in
Normal file
|
|
@ -0,0 +1,13 @@
|
||||||
|
.TP
|
||||||
|
.B timew delete @<id> [@<id> ...]
|
||||||
|
Deletes an interval. Using the 'summary' command, and specifying the ':ids' hint
|
||||||
|
shows interval IDs. Using the right ID, you can identify an interval to delete.
|
||||||
|
For example, show the IDs:
|
||||||
|
|
||||||
|
$ timew summary :week :ids
|
||||||
|
|
||||||
|
Then having selected '@2' as the interval you wish to delete:
|
||||||
|
|
||||||
|
$ timew delete @2
|
||||||
|
|
||||||
|
See also 'cancel'.
|
||||||
6
doc/man/timew-diagnostics.1.in
Normal file
6
doc/man/timew-diagnostics.1.in
Normal file
|
|
@ -0,0 +1,6 @@
|
||||||
|
.TP
|
||||||
|
.B timew diagnostics
|
||||||
|
This command shows details about your version of Timewarrior, your platform, how
|
||||||
|
it was built, compiler features, configuration, file access, extensions and more.
|
||||||
|
The purpose of this command is to help diagnose configuration problems and
|
||||||
|
provide supplemental information when reporting a problem. See also 'extensions'.
|
||||||
5
doc/man/timew-export.1.in
Normal file
5
doc/man/timew-export.1.in
Normal file
|
|
@ -0,0 +1,5 @@
|
||||||
|
.TP
|
||||||
|
.B timew export [<interval>] [<tag> ...]
|
||||||
|
Exports all the tracked time in JSON format. Supports filtering. For example:
|
||||||
|
|
||||||
|
$ timew export from 2016-01-01 for 3wks tag1
|
||||||
4
doc/man/timew-extensions.1.in
Normal file
4
doc/man/timew-extensions.1.in
Normal file
|
|
@ -0,0 +1,4 @@
|
||||||
|
.TP
|
||||||
|
.B timew extensions
|
||||||
|
Displays the directory containing the extension programs and a table showing
|
||||||
|
each extension and its status. See also 'diagnostics'.
|
||||||
19
doc/man/timew-fill.1.in
Normal file
19
doc/man/timew-fill.1.in
Normal file
|
|
@ -0,0 +1,19 @@
|
||||||
|
.TP
|
||||||
|
.B timew fill @<id> [@<id> ...]
|
||||||
|
|
||||||
|
The 'fill' command is used to adjust any interval to fill in surrounding gaps.
|
||||||
|
Using the 'summary' command, and specifying the ':ids' hint shows interval IDs.
|
||||||
|
Using the right ID, you can identify an interval to fill. For example, show
|
||||||
|
the IDs:
|
||||||
|
|
||||||
|
$ timew summary :week :ids
|
||||||
|
|
||||||
|
Then having selected '@2' as the interval you wish to fill:
|
||||||
|
|
||||||
|
$ timew fill @2
|
||||||
|
|
||||||
|
Note that you can fill multiple intervals:
|
||||||
|
|
||||||
|
$ timew fill @2 @10 @23
|
||||||
|
|
||||||
|
See also 'hints'.
|
||||||
13
doc/man/timew-gaps.1.in
Normal file
13
doc/man/timew-gaps.1.in
Normal file
|
|
@ -0,0 +1,13 @@
|
||||||
|
.TP
|
||||||
|
.B timew gaps [<interval>] [<tag> ...]
|
||||||
|
Displays a summary of time that is neither tracked nor excluded from tracking.
|
||||||
|
|
||||||
|
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'.
|
||||||
|
|
||||||
|
The ':blank' hint causes only the excluded time to be shown, with no tracked
|
||||||
|
time.
|
||||||
|
|
||||||
|
See also 'summary'.
|
||||||
9
doc/man/timew-get.1.in
Normal file
9
doc/man/timew-get.1.in
Normal file
|
|
@ -0,0 +1,9 @@
|
||||||
|
.TP
|
||||||
|
.B timew get <DOM> [<DOM> ...]
|
||||||
|
Validates the DOM reference, then obtains the value and displays it. For example:
|
||||||
|
|
||||||
|
$ timew get dom.active
|
||||||
|
1
|
||||||
|
|
||||||
|
It is an error to reference an interval or tag that does not exist.
|
||||||
|
See also 'DOM'.
|
||||||
13
doc/man/timew-help.1.in
Normal file
13
doc/man/timew-help.1.in
Normal file
|
|
@ -0,0 +1,13 @@
|
||||||
|
.TP
|
||||||
|
.B timew help [<command> | interval | hints | date | duration]
|
||||||
|
The help command shows detailed descriptions and examples of commands,
|
||||||
|
interval syntax, supported hints, date and duration formats and DOM references.
|
||||||
|
For example:
|
||||||
|
|
||||||
|
$ timew help
|
||||||
|
$ timew help start
|
||||||
|
$ timew help hints
|
||||||
|
$ timew help interval
|
||||||
|
$ timew help date
|
||||||
|
$ timew help duration
|
||||||
|
$ timew help dom
|
||||||
14
doc/man/timew-join.1.in
Normal file
14
doc/man/timew-join.1.in
Normal file
|
|
@ -0,0 +1,14 @@
|
||||||
|
.TP
|
||||||
|
.B timew join @<id> @<id>
|
||||||
|
Joins two intervals, by using the earlier of the two start times, and the later
|
||||||
|
of the two end times, and the combined set of tags. Using the 'summary' command,
|
||||||
|
and specifying the ':ids' hint shows interval IDs. Using the correct IDs, you
|
||||||
|
can identify an intervals to join. For example, show the IDs:
|
||||||
|
|
||||||
|
$ timew summary :week :ids
|
||||||
|
|
||||||
|
Then having selected '@1' and '@2' as the intervals you wish to join:
|
||||||
|
|
||||||
|
$ timew join @1 @2
|
||||||
|
|
||||||
|
See also 'split', 'lengthen', 'shorten', 'resize'.
|
||||||
18
doc/man/timew-lengthen.1.in
Normal file
18
doc/man/timew-lengthen.1.in
Normal file
|
|
@ -0,0 +1,18 @@
|
||||||
|
.TP
|
||||||
|
.B timew lengthen @<id> [@<id> ...] <duration>
|
||||||
|
The 'lengthen' command is used to defer the end date of a closed interval.
|
||||||
|
Using the 'summary' command, and specifying the ':ids' hint shows interval IDs.
|
||||||
|
Using the right ID, you can identify an interval to lengthen. For example, show
|
||||||
|
the IDs:
|
||||||
|
|
||||||
|
$ timew summary :week :ids
|
||||||
|
|
||||||
|
Then having selected '@2' as the interval you wish to lengthen:
|
||||||
|
|
||||||
|
$ timew lengthen @2 10mins
|
||||||
|
|
||||||
|
Note that you can lengthen multiple intervals,:
|
||||||
|
|
||||||
|
$ timew lengthen @2 @10 @23 1hour
|
||||||
|
|
||||||
|
See also 'summary', 'tag', 'untag', 'shorten', 'resize'.
|
||||||
20
doc/man/timew-month.1.in
Normal file
20
doc/man/timew-month.1.in
Normal file
|
|
@ -0,0 +1,20 @@
|
||||||
|
.TP
|
||||||
|
.B timew month [<interval>] [<tag> ...]
|
||||||
|
The month command shows a chart depicting a single month (current month by
|
||||||
|
default), with colored blocks drawn on a timeline. The chart summarizes the
|
||||||
|
tracked and untracked time.
|
||||||
|
|
||||||
|
Accepts date ranges and tags for filtering, or shortcut hints:
|
||||||
|
|
||||||
|
$ timew month 1st - today
|
||||||
|
$ timew month :week
|
||||||
|
|
||||||
|
The 'reports.month.range' configuration setting overrides the default date range.
|
||||||
|
The default date range shown is ':month'.
|
||||||
|
|
||||||
|
The ':blank' hint causes only the excluded time to be shown, with no tracked
|
||||||
|
time.
|
||||||
|
|
||||||
|
For more details, and precise times, use the 'summary' report.
|
||||||
|
|
||||||
|
See also 'day', 'week', 'summary'.
|
||||||
14
doc/man/timew-move.1.in
Normal file
14
doc/man/timew-move.1.in
Normal file
|
|
@ -0,0 +1,14 @@
|
||||||
|
.TP
|
||||||
|
.B timew move @<id> <date>
|
||||||
|
The 'move' command is used to reposition an interval at a new start time.
|
||||||
|
Using the 'summary' command, and specifying the ':ids' hint shows interval IDs.
|
||||||
|
Using the right ID, you can identify an interval to move. For example, show
|
||||||
|
the IDs:
|
||||||
|
|
||||||
|
$ timew summary :week :ids
|
||||||
|
|
||||||
|
Then having selected '@2' as the interval you wish to move:
|
||||||
|
|
||||||
|
$ timew move @2 9am
|
||||||
|
|
||||||
|
See also 'summary', 'tag', 'untag', 'lengthen', 'shorten', 'resize'.
|
||||||
10
doc/man/timew-report.1.in
Normal file
10
doc/man/timew-report.1.in
Normal file
|
|
@ -0,0 +1,10 @@
|
||||||
|
.TP
|
||||||
|
.B timew [report] <report> [<interval>] [<tag> ...]
|
||||||
|
Runs an extension report, and supports filtering data.
|
||||||
|
The 'report' command itself is optional, which means that these two commands
|
||||||
|
are equivalent:
|
||||||
|
|
||||||
|
$ timew report foo :week
|
||||||
|
$ timew foo :week
|
||||||
|
|
||||||
|
This does however assume there is a 'foo' extension installed.
|
||||||
18
doc/man/timew-resize.1.in
Normal file
18
doc/man/timew-resize.1.in
Normal file
|
|
@ -0,0 +1,18 @@
|
||||||
|
.TP
|
||||||
|
.B timew resize @<id> [@<id> ...] <duration>
|
||||||
|
The 'resize' command is used to change the duration of a closed interval.
|
||||||
|
Using the 'summary' command, and specifying the ':ids' hint shows interval IDs.
|
||||||
|
Using the right ID, you can identify an interval to resize. For example, show
|
||||||
|
the IDs:
|
||||||
|
|
||||||
|
$ timew summary :week :ids
|
||||||
|
|
||||||
|
Then having selected '@3' as the interval you wish to resize:
|
||||||
|
|
||||||
|
$ timew resize @3 15mins
|
||||||
|
|
||||||
|
Note that you can resize multiple intervals,:
|
||||||
|
|
||||||
|
$ timew resize @3 @1 @13 1hour
|
||||||
|
|
||||||
|
See also 'summary', 'tag', 'untag', 'lengthen', 'shorten'.
|
||||||
18
doc/man/timew-shorten.1.in
Normal file
18
doc/man/timew-shorten.1.in
Normal file
|
|
@ -0,0 +1,18 @@
|
||||||
|
.TP
|
||||||
|
.B timew shorten @<id> [@<id> ...] <duration>
|
||||||
|
The 'shorten' command is used to advance the end date of a closed interval.
|
||||||
|
Using the 'summary' command, and specifying the ':ids' hint shows interval IDs.
|
||||||
|
Using the right ID, you can identify an interval to shorten. For example, show
|
||||||
|
the IDs:
|
||||||
|
|
||||||
|
$ timew summary :week :ids
|
||||||
|
|
||||||
|
Then having selected '@2' as the interval you wish to shorten:
|
||||||
|
|
||||||
|
$ timew shorten @2 10mins
|
||||||
|
|
||||||
|
Note that you can shorten multiple intervals,:
|
||||||
|
|
||||||
|
$ timew shorten @2 @10 @23 1hour
|
||||||
|
|
||||||
|
See also 'summary', 'tag', 'untag', 'lengthen', 'resize'.
|
||||||
4
doc/man/timew-show.1.in
Normal file
4
doc/man/timew-show.1.in
Normal file
|
|
@ -0,0 +1,4 @@
|
||||||
|
.TP
|
||||||
|
.B timew show
|
||||||
|
Displays the effective configuration in hierarchical form.
|
||||||
|
See also 'config'.
|
||||||
14
doc/man/timew-split.1.in
Normal file
14
doc/man/timew-split.1.in
Normal file
|
|
@ -0,0 +1,14 @@
|
||||||
|
.TP
|
||||||
|
.B timew split @<id> [@<id> ...]
|
||||||
|
Ѕplits an interval into two equally sized adjacent intervals, having the same
|
||||||
|
tags. Using the 'summary' command, and specifying the ':ids' hint shows interval
|
||||||
|
IDs. Using the right ID, you can identify an interval to split. For example,
|
||||||
|
show the IDs:
|
||||||
|
|
||||||
|
$ timew summary :week :ids
|
||||||
|
|
||||||
|
Then having selected '@2' as the interval you wish to split:
|
||||||
|
|
||||||
|
$ timew split @2
|
||||||
|
|
||||||
|
See also 'join', 'lengthen', 'shorten'.
|
||||||
17
doc/man/timew-start.1.in
Normal file
17
doc/man/timew-start.1.in
Normal file
|
|
@ -0,0 +1,17 @@
|
||||||
|
.TP
|
||||||
|
.B timew start [<date>] [<tag> ...]
|
||||||
|
Begins tracking using the current time with any specified set of tags.
|
||||||
|
If a tag contains multiple words, therefore containing spaces, use quotes to
|
||||||
|
surround the whole tag. For example, this command specifies two tags ('weekend'
|
||||||
|
and 'Home & Garden'), the second of which requires quotes.
|
||||||
|
|
||||||
|
$ timew start weekend 'Home & Garden'
|
||||||
|
|
||||||
|
An optional date may be specified to indicate the intended start of the tracked
|
||||||
|
time:
|
||||||
|
|
||||||
|
$ timew start 8am weekend 'Home & Garden'
|
||||||
|
|
||||||
|
If there is a previous open interval, it will be closed at the given start time.
|
||||||
|
|
||||||
|
Quotes are harmless if used unnecessarily. See also 'continue', 'stop', 'track'.
|
||||||
15
doc/man/timew-stop.1.in
Normal file
15
doc/man/timew-stop.1.in
Normal file
|
|
@ -0,0 +1,15 @@
|
||||||
|
.TP
|
||||||
|
.B timew stop [<tag> ...]
|
||||||
|
Stops tracking time. If tags are specified, then they are no longer tracked.
|
||||||
|
If no tags are specified, all tracking stops. For example:
|
||||||
|
|
||||||
|
$ timew start tag1 tag2
|
||||||
|
...
|
||||||
|
$ timew stop tag1
|
||||||
|
|
||||||
|
Initially time is tracked for both 'tag1' and 'tag2', then 'tag1' tracking is
|
||||||
|
stopped, leaving tag2 active. To stop all tracking:
|
||||||
|
|
||||||
|
$ timew stop
|
||||||
|
|
||||||
|
See also 'cancel', 'continue', 'start', 'track'.
|
||||||
13
doc/man/timew-summary.1.in
Normal file
13
doc/man/timew-summary.1.in
Normal file
|
|
@ -0,0 +1,13 @@
|
||||||
|
.TP
|
||||||
|
.B timew summary [<interval>] [<tag> ...]
|
||||||
|
Displays a report summarizing tracked and untracked time for the current day by
|
||||||
|
default. Accepts date ranges and tags for filtering, or shortcut hints:
|
||||||
|
|
||||||
|
$ timew summary monday - today
|
||||||
|
$ timew summary :week
|
||||||
|
$ timew summary :month
|
||||||
|
|
||||||
|
The ':ids' hint adds an 'ID' column to the summary report output for interval
|
||||||
|
modification.
|
||||||
|
|
||||||
|
See also 'day', 'week', 'month', 'shorten', 'lengthen', 'tag', 'untag'.
|
||||||
24
doc/man/timew-tag.1.in
Normal file
24
doc/man/timew-tag.1.in
Normal file
|
|
@ -0,0 +1,24 @@
|
||||||
|
.TP
|
||||||
|
.B timew tag [@<id> ...] <tag> ...
|
||||||
|
The 'tag' command is used to add a tag to an interval. Using the 'summary'
|
||||||
|
command, and specifying the ':ids' hint shows interval IDs. Using the right ID,
|
||||||
|
you can identify an interval to tag. For example, show the IDs:
|
||||||
|
|
||||||
|
$ timew summary :week :ids
|
||||||
|
|
||||||
|
Then having selected '@2' as the interval you wish to tag:
|
||||||
|
|
||||||
|
$ timew tag @2 'New Tag'
|
||||||
|
|
||||||
|
Note that you can tag multiple intervals, with multiple tags:
|
||||||
|
|
||||||
|
$ timew tag @2 @10 @23 'Tag One' tag2 tag3
|
||||||
|
|
||||||
|
If there is active time tracking, you can omit the ID when you want to add tags to the current open interval:
|
||||||
|
|
||||||
|
$ timew start foo
|
||||||
|
$ timew tag bar
|
||||||
|
|
||||||
|
This results in the current interval having tags 'foo' and 'bar'.
|
||||||
|
|
||||||
|
See also 'summary', 'shorten', 'lengthen', 'untag'.
|
||||||
4
doc/man/timew-tags.1.in
Normal file
4
doc/man/timew-tags.1.in
Normal file
|
|
@ -0,0 +1,4 @@
|
||||||
|
.TP
|
||||||
|
.B timew tags [<interval>] [<tag> ...]
|
||||||
|
Displays all the tags that have been used by default. When a filter is specified,
|
||||||
|
shows only the tags that were used during that time.
|
||||||
11
doc/man/timew-track.1.in
Normal file
11
doc/man/timew-track.1.in
Normal file
|
|
@ -0,0 +1,11 @@
|
||||||
|
.TP
|
||||||
|
.B timew track <interval> [<tag> ...]
|
||||||
|
The track command is used to add tracked time in the past. Perhaps you forgot
|
||||||
|
to record time, or are just filling in old entries. For example:
|
||||||
|
|
||||||
|
$ timew track :yesterday 'Training Course'
|
||||||
|
$ timew track 9am - 11am 'Staff Meeting'
|
||||||
|
|
||||||
|
Note that the track command expects a closed interval (start and end time), when
|
||||||
|
recording. If a closed interval is not provided, the 'track' command behaves the
|
||||||
|
same as the 'start' command.
|
||||||
24
doc/man/timew-untag.1.in
Normal file
24
doc/man/timew-untag.1.in
Normal file
|
|
@ -0,0 +1,24 @@
|
||||||
|
.TP
|
||||||
|
.B timew untag [@<id> ...] <tag> ...
|
||||||
|
The 'untag' command is used to remove a tag from an interval. Using the 'summary'
|
||||||
|
command, and specifying the ':ids' hint shows interval IDs. Using the right ID,
|
||||||
|
you can identify an interval to untag. For example, show the IDs:
|
||||||
|
|
||||||
|
$ timew summary :week :ids
|
||||||
|
|
||||||
|
Then having selected '@2' as the interval you wish to untag:
|
||||||
|
|
||||||
|
$ timew untag @2 'Old Tag'
|
||||||
|
|
||||||
|
Note that you can untag multiple intervals, with multiple tags:
|
||||||
|
|
||||||
|
$ timew untag @2 @10 @23 'Old Tag' tag2 tag3
|
||||||
|
|
||||||
|
If there is active time tracking, you can omit the ID when you want to remove tags from the current open interval:
|
||||||
|
|
||||||
|
$ timew start foo bar
|
||||||
|
$ timew untag bar
|
||||||
|
|
||||||
|
This results in the current interval having tag 'foo' but not 'bar'.
|
||||||
|
|
||||||
|
See also 'summary', 'shorten', 'lengthen', 'tag'.
|
||||||
20
doc/man/timew-week.1.in
Normal file
20
doc/man/timew-week.1.in
Normal file
|
|
@ -0,0 +1,20 @@
|
||||||
|
.TP
|
||||||
|
.B timew week [<interval>] [<tag> ...]
|
||||||
|
The week command shows a chart depicting a single week (current week by
|
||||||
|
default), with colored blocks drawn on a timeline. The chart summarizes the
|
||||||
|
tracked and untracked time.
|
||||||
|
|
||||||
|
Accepts date ranges and tags for filtering, or shortcut hints:
|
||||||
|
|
||||||
|
$ timew week
|
||||||
|
$ timew week monday - today
|
||||||
|
|
||||||
|
The 'reports.week.range' configuration setting overrides the default date range.
|
||||||
|
The default date range shown is ':week'.
|
||||||
|
|
||||||
|
The ':blank' hint causes only the excluded time to be shown, with no tracked
|
||||||
|
time.
|
||||||
|
|
||||||
|
For more details, and precise times, use the 'summary' report.
|
||||||
|
|
||||||
|
See also 'day', 'month', 'summary'.
|
||||||
|
|
@ -27,441 +27,6 @@ there is any active tracking, and if so, shows a summary, then exits with a code
|
||||||
0. If there is no active time tracking, exit code is 1.
|
0. If there is no active time tracking, exit code is 1.
|
||||||
See also 'get'.
|
See also 'get'.
|
||||||
|
|
||||||
.TP
|
|
||||||
.B timew cancel
|
|
||||||
If there is an open interval, it is abandoned.
|
|
||||||
See also 'stop'.
|
|
||||||
|
|
||||||
.TP
|
|
||||||
.B timew config [<name> [<value> | '']]
|
|
||||||
Allows setting and removing configuration values, as an alternative to directly
|
|
||||||
editing your ~/.timewarrior/timewarrior.cfg file. For example:
|
|
||||||
|
|
||||||
$ timew config verbose yes
|
|
||||||
$ timew config verbose ''
|
|
||||||
$ timew config verbose
|
|
||||||
|
|
||||||
The first command sets 'verbose' to 'yes'. The second sets it to a blank value
|
|
||||||
which overrides the default value. The third example deletes the 'verbose'
|
|
||||||
setting.
|
|
||||||
|
|
||||||
When modifying configuration in this way, interactive confirmation will be
|
|
||||||
sought. To override this confirmation, use the ':yes' hint, which means you
|
|
||||||
intend to answer 'yes' to the confirmation questions:
|
|
||||||
|
|
||||||
$ timew config verbose '' :yes
|
|
||||||
|
|
||||||
If no arguments are provided, all configuration settings are shown:
|
|
||||||
|
|
||||||
$ timew config
|
|
||||||
verbose = yes
|
|
||||||
...
|
|
||||||
|
|
||||||
See also 'hints', 'show'.
|
|
||||||
|
|
||||||
.TP
|
|
||||||
.B timew continue [@<id>] [<date>|<interval>]
|
|
||||||
Resumes tracking of closed intervals. For example:
|
|
||||||
|
|
||||||
$ timew track 9am - 10am tag1 tag2
|
|
||||||
$ timew track 11am - 1pm tag3
|
|
||||||
$ timew continue @2
|
|
||||||
|
|
||||||
The 'continue' command creates a new interval, starting now, and using the
|
|
||||||
tags 'tag1' and 'tag2'.
|
|
||||||
Using the 'summary' command and specifying the ':ids' hint shows interval IDs.
|
|
||||||
This command is a convenient way to resume work without re-entering the
|
|
||||||
tags.
|
|
||||||
|
|
||||||
See also 'start', 'stop'.
|
|
||||||
|
|
||||||
.TP
|
|
||||||
.B timew day [<interval>] [<tag> ...]
|
|
||||||
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.
|
|
||||||
|
|
||||||
See also 'week', 'month', 'summary'.
|
|
||||||
|
|
||||||
.TP
|
|
||||||
.B timew delete @<id> [@<id> ...]
|
|
||||||
Deletes an interval. Using the 'summary' command, and specifying the ':ids' hint
|
|
||||||
shows interval IDs. Using the right ID, you can identify an interval to delete.
|
|
||||||
For example, show the IDs:
|
|
||||||
|
|
||||||
$ timew summary :week :ids
|
|
||||||
|
|
||||||
Then having selected '@2' as the interval you wish to delete:
|
|
||||||
|
|
||||||
$ timew delete @2
|
|
||||||
|
|
||||||
See also 'cancel'.
|
|
||||||
|
|
||||||
.TP
|
|
||||||
.B timew diagnostics
|
|
||||||
This command shows details about your version of Timewarrior, your platform, how
|
|
||||||
it was built, compiler features, configuration, file access, extensions and more.
|
|
||||||
The purpose of this command is to help diagnose configuration problems and
|
|
||||||
provide supplemental information when reporting a problem. See also 'extensions'.
|
|
||||||
|
|
||||||
.TP
|
|
||||||
.B timew export [<interval>] [<tag> ...]
|
|
||||||
Exports all the tracked time in JSON format. Supports filtering. For example:
|
|
||||||
|
|
||||||
$ timew export from 2016-01-01 for 3wks tag1
|
|
||||||
|
|
||||||
.TP
|
|
||||||
.B timew extensions
|
|
||||||
Displays the directory containing the extension programs and a table showing
|
|
||||||
each extension and its status. See also 'diagnostics'.
|
|
||||||
|
|
||||||
.TP
|
|
||||||
.B timew fill @<id> [@<id> ...]
|
|
||||||
|
|
||||||
The 'fill' command is used to adjust any interval to fill in surrounding gaps.
|
|
||||||
Using the 'summary' command, and specifying the ':ids' hint shows interval IDs.
|
|
||||||
Using the right ID, you can identify an interval to fill. For example, show
|
|
||||||
the IDs:
|
|
||||||
|
|
||||||
$ timew summary :week :ids
|
|
||||||
|
|
||||||
Then having selected '@2' as the interval you wish to fill:
|
|
||||||
|
|
||||||
$ timew fill @2
|
|
||||||
|
|
||||||
Note that you can fill multiple intervals:
|
|
||||||
|
|
||||||
$ timew fill @2 @10 @23
|
|
||||||
|
|
||||||
See also 'hints'.
|
|
||||||
|
|
||||||
.TP
|
|
||||||
.B timew gaps [<interval>] [<tag> ...]
|
|
||||||
Displays a summary of time that is neither tracked nor excluded from tracking.
|
|
||||||
|
|
||||||
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'.
|
|
||||||
|
|
||||||
The ':blank' hint causes only the excluded time to be shown, with no tracked
|
|
||||||
time.
|
|
||||||
|
|
||||||
See also 'summary'.
|
|
||||||
|
|
||||||
.TP
|
|
||||||
.B timew get <DOM> [<DOM> ...]
|
|
||||||
Validates the DOM reference, then obtains the value and displays it. For example:
|
|
||||||
|
|
||||||
$ timew get dom.active
|
|
||||||
1
|
|
||||||
|
|
||||||
It is an error to reference an interval or tag that does not exist.
|
|
||||||
See also 'DOM'.
|
|
||||||
|
|
||||||
.TP
|
|
||||||
.B timew help [<command> | interval | hints | date | duration]
|
|
||||||
The help command shows detailed descriptions and examples of commands,
|
|
||||||
interval syntax, supported hints, date and duration formats and DOM references.
|
|
||||||
For example:
|
|
||||||
|
|
||||||
$ timew help
|
|
||||||
$ timew help start
|
|
||||||
$ timew help hints
|
|
||||||
$ timew help interval
|
|
||||||
$ timew help date
|
|
||||||
$ timew help duration
|
|
||||||
$ timew help dom
|
|
||||||
|
|
||||||
.TP
|
|
||||||
.B timew join @<id> @<id>
|
|
||||||
Joins two intervals, by using the earlier of the two start times, and the later
|
|
||||||
of the two end times, and the combined set of tags. Using the 'summary' command,
|
|
||||||
and specifying the ':ids' hint shows interval IDs. Using the correct IDs, you
|
|
||||||
can identify an intervals to join. For example, show the IDs:
|
|
||||||
|
|
||||||
$ timew summary :week :ids
|
|
||||||
|
|
||||||
Then having selected '@1' and '@2' as the intervals you wish to join:
|
|
||||||
|
|
||||||
$ timew join @1 @2
|
|
||||||
|
|
||||||
See also 'split', 'lengthen', 'shorten', 'resize'.
|
|
||||||
|
|
||||||
.TP
|
|
||||||
.B timew lengthen @<id> [@<id> ...] <duration>
|
|
||||||
The 'lengthen' command is used to defer the end date of a closed interval.
|
|
||||||
Using the 'summary' command, and specifying the ':ids' hint shows interval IDs.
|
|
||||||
Using the right ID, you can identify an interval to lengthen. For example, show
|
|
||||||
the IDs:
|
|
||||||
|
|
||||||
$ timew summary :week :ids
|
|
||||||
|
|
||||||
Then having selected '@2' as the interval you wish to lengthen:
|
|
||||||
|
|
||||||
$ timew lengthen @2 10mins
|
|
||||||
|
|
||||||
Note that you can lengthen multiple intervals,:
|
|
||||||
|
|
||||||
$ timew lengthen @2 @10 @23 1hour
|
|
||||||
|
|
||||||
See also 'summary', 'tag', 'untag', 'shorten', 'resize'.
|
|
||||||
|
|
||||||
.TP
|
|
||||||
.B timew month [<interval>] [<tag> ...]
|
|
||||||
The month command shows a chart depicting a single month (current month by
|
|
||||||
default), with colored blocks drawn on a timeline. The chart summarizes the
|
|
||||||
tracked and untracked time.
|
|
||||||
|
|
||||||
Accepts date ranges and tags for filtering, or shortcut hints:
|
|
||||||
|
|
||||||
$ timew month 1st - today
|
|
||||||
$ timew month :week
|
|
||||||
|
|
||||||
The 'reports.month.range' configuration setting overrides the default date range.
|
|
||||||
The default date range shown is ':month'.
|
|
||||||
|
|
||||||
The ':blank' hint causes only the excluded time to be shown, with no tracked
|
|
||||||
time.
|
|
||||||
|
|
||||||
For more details, and precise times, use the 'summary' report.
|
|
||||||
|
|
||||||
See also 'day', 'week', 'summary'.
|
|
||||||
|
|
||||||
.TP
|
|
||||||
.B timew move @<id> <date>
|
|
||||||
The 'move' command is used to reposition an interval at a new start time.
|
|
||||||
Using the 'summary' command, and specifying the ':ids' hint shows interval IDs.
|
|
||||||
Using the right ID, you can identify an interval to move. For example, show
|
|
||||||
the IDs:
|
|
||||||
|
|
||||||
$ timew summary :week :ids
|
|
||||||
|
|
||||||
Then having selected '@2' as the interval you wish to move:
|
|
||||||
|
|
||||||
$ timew move @2 9am
|
|
||||||
|
|
||||||
See also 'summary', 'tag', 'untag', 'lengthen', 'shorten', 'resize'.
|
|
||||||
|
|
||||||
.TP
|
|
||||||
.B timew [report] <report> [<interval>] [<tag> ...]
|
|
||||||
Runs an extension report, and supports filtering data.
|
|
||||||
The 'report' command itself is optional, which means that these two commands
|
|
||||||
are equivalent:
|
|
||||||
|
|
||||||
$ timew report foo :week
|
|
||||||
$ timew foo :week
|
|
||||||
|
|
||||||
This does however assume there is a 'foo' extension installed.
|
|
||||||
|
|
||||||
.TP
|
|
||||||
.B timew resize @<id> [@<id> ...] <duration>
|
|
||||||
The 'resize' command is used to change the duration of a closed interval.
|
|
||||||
Using the 'summary' command, and specifying the ':ids' hint shows interval IDs.
|
|
||||||
Using the right ID, you can identify an interval to resize. For example, show
|
|
||||||
the IDs:
|
|
||||||
|
|
||||||
$ timew summary :week :ids
|
|
||||||
|
|
||||||
Then having selected '@3' as the interval you wish to resize:
|
|
||||||
|
|
||||||
$ timew resize @3 15mins
|
|
||||||
|
|
||||||
Note that you can resize multiple intervals,:
|
|
||||||
|
|
||||||
$ timew resize @3 @1 @13 1hour
|
|
||||||
|
|
||||||
See also 'summary', 'tag', 'untag', 'lengthen', 'shorten'.
|
|
||||||
|
|
||||||
.TP
|
|
||||||
.B timew shorten @<id> [@<id> ...] <duration>
|
|
||||||
The 'shorten' command is used to advance the end date of a closed interval.
|
|
||||||
Using the 'summary' command, and specifying the ':ids' hint shows interval IDs.
|
|
||||||
Using the right ID, you can identify an interval to shorten. For example, show
|
|
||||||
the IDs:
|
|
||||||
|
|
||||||
$ timew summary :week :ids
|
|
||||||
|
|
||||||
Then having selected '@2' as the interval you wish to shorten:
|
|
||||||
|
|
||||||
$ timew shorten @2 10mins
|
|
||||||
|
|
||||||
Note that you can shorten multiple intervals,:
|
|
||||||
|
|
||||||
$ timew shorten @2 @10 @23 1hour
|
|
||||||
|
|
||||||
See also 'summary', 'tag', 'untag', 'lengthen', 'resize'.
|
|
||||||
|
|
||||||
.TP
|
|
||||||
.B timew show
|
|
||||||
Displays the effective configuration in hierarchical form.
|
|
||||||
See also 'config'.
|
|
||||||
|
|
||||||
.TP
|
|
||||||
.B timew split @<id> [@<id> ...]
|
|
||||||
Ѕplits an interval into two equally sized adjacent intervals, having the same
|
|
||||||
tags. Using the 'summary' command, and specifying the ':ids' hint shows interval
|
|
||||||
IDs. Using the right ID, you can identify an interval to split. For example,
|
|
||||||
show the IDs:
|
|
||||||
|
|
||||||
$ timew summary :week :ids
|
|
||||||
|
|
||||||
Then having selected '@2' as the interval you wish to split:
|
|
||||||
|
|
||||||
$ timew split @2
|
|
||||||
|
|
||||||
See also 'join', 'lengthen', 'shorten'.
|
|
||||||
|
|
||||||
.TP
|
|
||||||
.B timew start [<date>] [<tag> ...]
|
|
||||||
Begins tracking using the current time with any specified set of tags.
|
|
||||||
If a tag contains multiple words, therefore containing spaces, use quotes to
|
|
||||||
surround the whole tag. For example, this command specifies two tags ('weekend'
|
|
||||||
and 'Home & Garden'), the second of which requires quotes.
|
|
||||||
|
|
||||||
$ timew start weekend 'Home & Garden'
|
|
||||||
|
|
||||||
An optional date may be specified to indicate the intended start of the tracked
|
|
||||||
time:
|
|
||||||
|
|
||||||
$ timew start 8am weekend 'Home & Garden'
|
|
||||||
|
|
||||||
If there is a previous open interval, it will be closed at the given start time.
|
|
||||||
|
|
||||||
Quotes are harmless if used unnecessarily. See also 'continue', 'stop', 'track'.
|
|
||||||
|
|
||||||
.TP
|
|
||||||
.B timew stop [<tag> ...]
|
|
||||||
Stops tracking time. If tags are specified, then they are no longer tracked.
|
|
||||||
If no tags are specified, all tracking stops. For example:
|
|
||||||
|
|
||||||
$ timew start tag1 tag2
|
|
||||||
...
|
|
||||||
$ timew stop tag1
|
|
||||||
|
|
||||||
Initially time is tracked for both 'tag1' and 'tag2', then 'tag1' tracking is
|
|
||||||
stopped, leaving tag2 active. To stop all tracking:
|
|
||||||
|
|
||||||
$ timew stop
|
|
||||||
|
|
||||||
See also 'cancel', 'continue', 'start', 'track'.
|
|
||||||
|
|
||||||
.TP
|
|
||||||
.B timew summary [<interval>] [<tag> ...]
|
|
||||||
Displays a report summarizing tracked and untracked time for the current day by
|
|
||||||
default. Accepts date ranges and tags for filtering, or shortcut hints:
|
|
||||||
|
|
||||||
$ timew summary monday - today
|
|
||||||
$ timew summary :week
|
|
||||||
$ timew summary :month
|
|
||||||
|
|
||||||
The ':ids' hint adds an 'ID' column to the summary report output for interval
|
|
||||||
modification.
|
|
||||||
|
|
||||||
See also 'day', 'week', 'month', 'shorten', 'lengthen', 'tag', 'untag'.
|
|
||||||
|
|
||||||
.TP
|
|
||||||
.B timew tag [@<id> ...] <tag> ...
|
|
||||||
The 'tag' command is used to add a tag to an interval. Using the 'summary'
|
|
||||||
command, and specifying the ':ids' hint shows interval IDs. Using the right ID,
|
|
||||||
you can identify an interval to tag. For example, show the IDs:
|
|
||||||
|
|
||||||
$ timew summary :week :ids
|
|
||||||
|
|
||||||
Then having selected '@2' as the interval you wish to tag:
|
|
||||||
|
|
||||||
$ timew tag @2 'New Tag'
|
|
||||||
|
|
||||||
Note that you can tag multiple intervals, with multiple tags:
|
|
||||||
|
|
||||||
$ timew tag @2 @10 @23 'Tag One' tag2 tag3
|
|
||||||
|
|
||||||
If there is active time tracking, you can omit the ID when you want to add tags to the current open interval:
|
|
||||||
|
|
||||||
$ timew start foo
|
|
||||||
$ timew tag bar
|
|
||||||
|
|
||||||
This results in the current interval having tags 'foo' and 'bar'.
|
|
||||||
|
|
||||||
See also 'summary', 'shorten', 'lengthen', 'untag'.
|
|
||||||
|
|
||||||
.TP
|
|
||||||
.B timew tags [<interval>] [<tag> ...]
|
|
||||||
Displays all the tags that have been used by default. When a filter is specified,
|
|
||||||
shows only the tags that were used during that time.
|
|
||||||
|
|
||||||
.TP
|
|
||||||
.B timew track <interval> [<tag> ...]
|
|
||||||
The track command is used to add tracked time in the past. Perhaps you forgot
|
|
||||||
to record time, or are just filling in old entries. For example:
|
|
||||||
|
|
||||||
$ timew track :yesterday 'Training Course'
|
|
||||||
$ timew track 9am - 11am 'Staff Meeting'
|
|
||||||
|
|
||||||
Note that the track command expects a closed interval (start and end time), when
|
|
||||||
recording. If a closed interval is not provided, the 'track' command behaves the
|
|
||||||
same as the 'start' command.
|
|
||||||
|
|
||||||
.TP
|
|
||||||
.B timew untag [@<id> ...] <tag> ...
|
|
||||||
The 'untag' command is used to remove a tag from an interval. Using the 'summary'
|
|
||||||
command, and specifying the ':ids' hint shows interval IDs. Using the right ID,
|
|
||||||
you can identify an interval to untag. For example, show the IDs:
|
|
||||||
|
|
||||||
$ timew summary :week :ids
|
|
||||||
|
|
||||||
Then having selected '@2' as the interval you wish to untag:
|
|
||||||
|
|
||||||
$ timew untag @2 'Old Tag'
|
|
||||||
|
|
||||||
Note that you can untag multiple intervals, with multiple tags:
|
|
||||||
|
|
||||||
$ timew untag @2 @10 @23 'Old Tag' tag2 tag3
|
|
||||||
|
|
||||||
If there is active time tracking, you can omit the ID when you want to remove tags from the current open interval:
|
|
||||||
|
|
||||||
$ timew start foo bar
|
|
||||||
$ timew untag bar
|
|
||||||
|
|
||||||
This results in the current interval having tag 'foo' but not 'bar'.
|
|
||||||
|
|
||||||
See also 'summary', 'shorten', 'lengthen', 'tag'.
|
|
||||||
|
|
||||||
.TP
|
|
||||||
.B timew week [<interval>] [<tag> ...]
|
|
||||||
The week command shows a chart depicting a single week (current week by
|
|
||||||
default), with colored blocks drawn on a timeline. The chart summarizes the
|
|
||||||
tracked and untracked time.
|
|
||||||
|
|
||||||
Accepts date ranges and tags for filtering, or shortcut hints:
|
|
||||||
|
|
||||||
$ timew week
|
|
||||||
$ timew week monday - today
|
|
||||||
|
|
||||||
The 'reports.week.range' configuration setting overrides the default date range.
|
|
||||||
The default date range shown is ':week'.
|
|
||||||
|
|
||||||
The ':blank' hint causes only the excluded time to be shown, with no tracked
|
|
||||||
time.
|
|
||||||
|
|
||||||
For more details, and precise times, use the 'summary' report.
|
|
||||||
|
|
||||||
See also 'day', 'month', 'summary'.
|
|
||||||
|
|
||||||
.SH INTERVAL
|
.SH INTERVAL
|
||||||
An interval defines a block of time that is tracked. The syntax for specifying
|
An interval defines a block of time that is tracked. The syntax for specifying
|
||||||
an interval is flexible, and may be one of:
|
an interval is flexible, and may be one of:
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue