GothenburgBitFactory/timewarrior
1
0
Fork 0
mirror of https://github.com/GothenburgBitFactory/timewarrior.git synced 2025-07-07 20:06:39 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Update EXAMPLES section

Browse source
This commit is contained in:
Thomas Lauf 2019-02-21 23:46:16 +01:00
parent fc49a4003a
commit 1c85721876
24 changed files with 213 additions and 170 deletions
Download patch file Download diff file Expand all files Collapse all files

33
doc/man/timew-annotate.1.in
View file

@ -19,30 +19,31 @@ Using the right ID, you can identify an interval to annotate.
.
.SH EXAMPLES
For example, show the IDs:
.
$ timew summary :week :ids
.
.RS
$ timew summary :week :ids
.RE
Then having selected '@2' as the interval you wish to annotate:
.
$ timew annotate @2 'Lorem ipsum...'
.
.RS
$ timew annotate @2 'Lorem ipsum...'
.RE
Note that you can annotate multiple intervals with the same annotation:
.
$ timew annotate @2 @10 @23 'Lorem ipsum dolor sit amet...'
.
.RS
$ timew annotate @2 @10 @23 'Lorem ipsum dolor sit amet...'
.RE
If there is active time tracking, you can omit the ID when you want to add annotations to the current open interval:
.
$ timew start foo
$ timew annotate bar
.
.RS
$ timew start foo
.br
$ timew annotate bar
.RE
This results in the current interval having annotations 'foo' and 'bar'.
.
SH BUGS
Currently the annotation command picks the last token from the command line and uses it as annotation.
I.e. using no quotes in an annotation command like
.
$ timew annotate @1 lorem ipsum dolor
.
.RS
$ timew annotate @1 lorem ipsum dolor
.RE
will result in interval @1 having only 'dolor' as its annotation.
.
.SH "SEE ALSO"

25
doc/man/timew-cancel.1.in
View file

@ -10,23 +10,32 @@ timew-cancel \- cancel time tracking
If there is an open interval, it is abandoned.
.
.SH EXAMPLES
.TP Cancel with active time tracking
.
.TP
.B Cancel with active time tracking
.RS
.br
$ timew start
.br
...
.br
$ timew cancel
.
.br
Canceled active time tracking.
.RE
.
This deletes the open interval.
.
Cancel with no active time tracking
.
.TP
.B Cancel with no active time tracking
.RS
.br
...
.br
$ timew stop
.br
$ timew cancel
.br
There is no active time tracking.
.
.RE
Cancel has no effect, only a warning is printed.
.
.SH "SEE ALSO"

29
doc/man/timew-config.1.in
View file

@ -19,25 +19,30 @@ Allows setting and removing configuration values, as an alternative to directly
.
.SH EXAMPLES
For example:
.
$ timew config verbose yes
$ timew config verbose ''
$ timew config verbose
.
.RS
$ timew config verbose yes
.br
$ timew config verbose ''
.br
$ timew config verbose
.RE
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
.
.RS
$ timew config verbose '' :yes
.RE
If no arguments are provided, all configuration settings are shown:
.
$ timew config
verbose = yes
...
.RS
$ timew config
.br
verbose = yes
.br
...
.RE
.
.SH "SEE ALSO"
.BR timew-hints (1),

12
doc/man/timew-continue.1.in
View file

@ -20,11 +20,13 @@ Resumes tracking of closed intervals.
.
.SH EXAMPLES
For example:
.
$ timew track 9am - 10am tag1 tag2
$ timew track 11am - 1pm tag3
$ timew continue @2
.
.RS
$ timew track 9am - 10am tag1 tag2
.br
$ timew track 11am - 1pm tag3
.br
$ timew continue @2
.RE
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.

11
doc/man/timew-delete.1.in
View file

@ -15,12 +15,13 @@ Using the right ID, you can identify an interval to delete.
.
.SH EXAMPLES
For example, show the IDs:
.
$ timew summary :week :ids
.
.RS
$ timew summary :week :ids
.RE
Then having selected '@2' as the interval you wish to delete:
.
$ timew delete @2
.RS
$ timew delete @2
.RE
.
.SH "SEE ALSO"
.BR timew-cancel

6
doc/man/timew-export.1.in
View file

@ -17,6 +17,6 @@ Supports filtering.
.
.SH EXAMPLES
For example:
.
$ timew export from 2016-01-01 for 3wks tag1
.
.RS
$ timew export from 2016-01-01 for 3wks tag1
.RE

17
doc/man/timew-fill.1.in
View file

@ -15,16 +15,17 @@ Using the right ID, you can identify an interval to fill.
.
.SH EXAMPLES
For example, show the IDs:
.
$ timew summary :week :ids
.
.RS
$ timew summary :week :ids
.RE
Then having selected '@2' as the interval you wish to fill:
.
$ timew fill @2
.
.RS
$ timew fill @2
.RE
Note that you can fill multiple intervals:
.
$ timew fill @2 @10 @23
.RS
$ timew fill @2 @10 @23
.RE
.
.SH "SEE ALSO"
.BR timew-hints (1)

8
doc/man/timew-get.1.in
View file

@ -13,10 +13,10 @@ Validates the DOM reference, then obtains the value and displays it.
.
.SH EXAMPLES
For example:
.
$ timew get dom.active
1
.
.RS
$ timew get dom.active
1
.RE
It is an error to reference an interval or tag that does not exist.
.
.SH "SEE ALSO"

24
doc/man/timew-help.1.in
View file

@ -22,12 +22,18 @@ The help command shows detailed descriptions and examples of commands, interval
.
.SH EXAMPLES
For example:
.
$ timew help
$ timew help start
$ timew help hints
$ timew help interval
$ timew help date
$ timew help duration
$ timew help dom
.
.RS
$ timew help
.br
$ timew help start
.br
$ timew help hints
.br
$ timew help interval
.br
$ timew help date
.br
$ timew help duration
.br
$ timew help dom
.RE

11
doc/man/timew-join.1.in
View file

@ -14,12 +14,13 @@ Using the correct IDs, you can identify an intervals to join.
.
.SH EXAMPLES
For example, show the IDs:
.
$ timew summary :week :ids
.
.RS
$ timew summary :week :ids
.RE
Then having selected '@1' and '@2' as the intervals you wish to join:
.
$ timew join @1 @2
.RS
$ timew join @1 @2
.RE
.
.SH "SEE ALSO"
.BR timew-lengthen (1),

17
doc/man/timew-lengthen.1.in
View file

@ -16,16 +16,17 @@ Using the right ID, you can identify an interval to lengthen.
.
.SH EXAMPLES
For example, show the IDs:
.
$ timew summary :week :ids
.
.RS
$ timew summary :week :ids
.RE
Then having selected '@2' as the interval you wish to lengthen:
.
$ timew lengthen @2 10mins
.
.RS
$ timew lengthen @2 10mins
.RE
Note that you can lengthen multiple intervals,:
.
$ timew lengthen @2 @10 @23 1hour
.RS
$ timew lengthen @2 @10 @23 1hour
.RE
.
.SH "SEE ALSO"
.BR timew-modify (1),

11
doc/man/timew-modify.1.in
View file

@ -19,13 +19,14 @@ Using the right ID, you can identify an interval to modify.
.
.SH EXAMPLES
For example, show the IDs:
.
$ timew summary :week :ids
.
.RS
$ timew summary :week :ids
.RE
.PP
Then having selected '@3' as the interval you wish to modify:
.
$ timew modify end @3 "${PACKAGE_DATE}"T17:00:00
.RS
$ timew modify end @3 "${PACKAGE_DATE}"T17:00:00
.RE
.
.SH "SEE ALSO"
.BR timew-lengthen (1),

11
doc/man/timew-move.1.in
View file

@ -14,12 +14,13 @@ Using the right ID, you can identify an interval to move.
.
.SH EXAMPLES
For example, show the IDs:
.
$ timew summary :week :ids
.
.RS
$ timew summary :week :ids
.RE
Then having selected '@2' as the interval you wish to move:
.
$ timew move @2 9am
.RS
$ timew move @2 9am
.RE
.
.SH "SEE ALSO"
.BR timew-lengthen (1),

9
doc/man/timew-report.1.in
View file

@ -19,8 +19,9 @@ timew-report \- run an extension report
.SH DESCRIPTION
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
.
.RS
$ timew report foo :week
.br
$ timew foo :week
.RE
This does however assume there is a 'foo' extension installed.

17
doc/man/timew-resize.1.in
View file

@ -16,16 +16,17 @@ Using the right ID, you can identify an interval to resize.
.
.SH EXAMPLES
For example, show the IDs:
.
$ timew summary :week :ids
.
.RS
$ timew summary :week :ids
.RE
Then having selected '@3' as the interval you wish to resize:
.
$ timew resize @3 15mins
.
.RS
$ timew resize @3 15mins
.RE
Note that you can resize multiple intervals,:
.
$ timew resize @3 @1 @13 1hour
.RS
$ timew resize @3 @1 @13 1hour
.RE
.
.SH "SEE ALSO"
.BR timew-lengthen (1),

18
doc/man/timew-shorten.1.in
View file

@ -16,16 +16,18 @@ Using the right ID, you can identify an interval to shorten.
.
.SH EXAMPLES
For example, show the IDs:
.
$ timew summary :week :ids
.
.RS
$ timew summary :week :ids
.RE
.br
Then having selected '@2' as the interval you wish to shorten:
.
$ timew shorten @2 10mins
.
.RS
$ timew shorten @2 10mins
.RE
Note that you can shorten multiple intervals,:
.
$ timew shorten @2 @10 @23 1hour
.RS
$ timew shorten @2 @10 @23 1hour
.RE
.
.SH "SEE ALSO"
.BR timew-lengthen (1),

11
doc/man/timew-split.1.in
View file

@ -15,12 +15,13 @@ Using the right ID, you can identify an interval to split.
.
.SH EXAMPLES
For example, show the IDs:
.
$ timew summary :week :ids
.
.RS
$ timew summary :week :ids
.RE
Then having selected '@2' as the interval you wish to split:
.
$ timew split @2
.RS
$ timew split @2
.RE
.
.SH "SEE ALSO"
.BR timew-join (1),

12
doc/man/timew-start.1.in
View file

@ -18,13 +18,13 @@ If a tag contains multiple words, therefore containing spaces, use quotes to sur
.
.SH EXAMPLES
For example, this command specifies two tags ('weekend' and 'Home & Garden'), the second of which requires quotes.
.
$ timew start weekend 'Home & Garden'
.
.RS
$ timew start weekend 'Home & Garden'
.RE
An optional date may be specified to indicate the intended start of the tracked time:
.
$ timew start 8am weekend 'Home & Garden'
.
.RS
$ timew start 8am weekend 'Home & Garden'
.RE
If there is a previous open interval, it will be closed at the given start time.
.
Quotes are harmless if used unnecessarily.

17
doc/man/timew-stop.1.in
View file

@ -19,15 +19,18 @@ If no tags are specified, all tracking stops.
.
.SH EXAMPLES
For example:
.
$ timew start tag1 tag2
...
$ timew stop tag1
.
.RS
$ timew start tag1 tag2
.br
...
.br
$ timew stop tag1
.RE
Initially time is tracked for both 'tag1' and 'tag2', then 'tag1' tracking is stopped, leaving tag2 active.
To stop all tracking:
.
$ timew stop
.RS
$ timew stop
.RE
.
.SH "SEE ALSO"
.BR timew-cancel (1),

12
doc/man/timew-summary.1.in
View file

@ -15,11 +15,13 @@ timew-summary \- display a time-tracking summary
.SH DESCRIPTION
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
.
.RS
$ timew summary monday - today
.br
$ timew summary :week
.br
$ timew summary :month
.RE
The ':ids' hint adds an 'ID' column to the summary report output for interval modification.
.
.SH CONFIGURATION

27
doc/man/timew-tag.1.in
View file

@ -19,22 +19,23 @@ Using the right ID, you can identify an interval to tag.
.
.SH EXAMPLES
For example, show the IDs:
.
$ timew summary :week :ids
.
.RS
$ timew summary :week :ids
.RE
Then having selected '@2' as the interval you wish to tag:
.
$ timew tag @2 'New Tag'
.
.RS
$ timew tag @2 'New Tag'
.RE
Note that you can tag multiple intervals, with multiple tags:
.
$ timew tag @2 @10 @23 'Tag One' tag2 tag3
.
.RS
$ timew tag @2 @10 @23 'Tag One' tag2 tag3
.RE
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
.
.RS
$ timew start foo
.br
$ timew tag bar
.RE
This results in the current interval having tags 'foo' and 'bar'.
.
.SH "SEE ALSO"

9
doc/man/timew-track.1.in
View file

@ -17,10 +17,11 @@ Perhaps you forgot to record time, or are just filling in old entries.
.
.SH EXAMPLES
For example:
.
$ timew track :yesterday 'Training Course'
$ timew track 9am - 11am 'Staff Meeting'
.
.RS
$ timew track :yesterday 'Training Course'
.br
$ timew track 9am - 11am 'Staff Meeting'
.RE
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.
.

9
doc/man/timew-undo.1.in
View file

@ -16,7 +16,8 @@ The 'undo' command itself cannot be undone!
.SH EXAMPLES
Undo an interval modification:
.
$ timew split @1
$ timew undo
.
.RS
$ timew split @1
.br
$ timew undo
.RE

27
doc/man/timew-untag.1.in
View file

@ -19,22 +19,23 @@ Using the right ID, you can identify an interval to untag.
.
.SH EXAMPLES
For example, show the IDs:
.
$ timew summary :week :ids
.
.RS
$ timew summary :week :ids
.RE
Then having selected '@2' as the interval you wish to untag:
.
$ timew untag @2 'Old Tag'
.
.RS
$ timew untag @2 'Old Tag'
.RE
Note that you can untag multiple intervals, with multiple tags:
.
$ timew untag @2 @10 @23 'Old Tag' tag2 tag3
.
.RS
$ timew untag @2 @10 @23 'Old Tag' tag2 tag3
.RE
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
.
.RS
$ timew start foo bar
.br
$ timew untag bar
.RE
This results in the current interval having tag 'foo' but not 'bar'.
.
.SH "SEE ALSO"