Skip to content
Permalink
Browse files

Update EXAMPLES section

  • Loading branch information...
lauft committed Feb 21, 2019
1 parent fc49a40 commit 1c85721876c35463f76b736fefbf70c00d126b70
@@ -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"
@@ -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.

This deletes the open interval.
.
Cancel with no active time tracking
.RE
.
This deletes the open interval.
.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"
@@ -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),
@@ -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.
@@ -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
@@ -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
@@ -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)
@@ -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"
@@ -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
@@ -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),
@@ -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),
@@ -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),
@@ -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),
@@ -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.
@@ -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),
Oops, something went wrong.

0 comments on commit 1c85721

Please sign in to comment.
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.