mirror of
https://github.com/GothenburgBitFactory/timewarrior.git
synced 2025-06-26 10:54:28 +02:00
Add man page for command 'annotate'
This commit is contained in:
parent
58e7cec118
commit
3e867fbde3
1 changed files with 49 additions and 0 deletions
49
doc/man/timew-annotate.1.in
Normal file
49
doc/man/timew-annotate.1.in
Normal file
|
@ -0,0 +1,49 @@
|
|||
.TH timew-annotate 1 2018-02-03 "${PACKAGE_STRING}" "User Manuals"
|
||||
.
|
||||
.SH NAME
|
||||
timew-annotate \- add an annotation to intervals
|
||||
.
|
||||
.SH SYNOPSIS
|
||||
.B timew annotate
|
||||
[
|
||||
.I <id>
|
||||
.B ...
|
||||
]
|
||||
.I <annotation>
|
||||
.B ...
|
||||
.
|
||||
.SH DESCRIPTION
|
||||
The 'annotate' command is used to add an annotation 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 annotate.
|
||||
.
|
||||
.SH EXAMPLES
|
||||
For example, show the IDs:
|
||||
.
|
||||
$ timew summary :week :ids
|
||||
.
|
||||
Then having selected '@2' as the interval you wish to annotate:
|
||||
.
|
||||
$ timew annotate @2 'Lorem ipsum...'
|
||||
.
|
||||
Note that you can annotate multiple intervals with the same annotation:
|
||||
.
|
||||
$ timew annotate @2 @10 @23 'Lorem ipsum dolor sit amet...'
|
||||
.
|
||||
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
|
||||
.
|
||||
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
|
||||
.
|
||||
will result in interval @1 having only 'dolor' as its annotation.
|
||||
.
|
||||
.SH "SEE ALSO"
|
||||
.BR timew-tag (1)
|
Loading…
Add table
Add a link
Reference in a new issue