From 3e867fbde31fe41523e26b094e1783277a93216f Mon Sep 17 00:00:00 2001 From: Thomas Lauf Date: Tue, 9 Oct 2018 17:01:03 +0200 Subject: [PATCH] Add man page for command 'annotate' --- doc/man/timew-annotate.1.in | 49 +++++++++++++++++++++++++++++++++++++ 1 file changed, 49 insertions(+) create mode 100644 doc/man/timew-annotate.1.in diff --git a/doc/man/timew-annotate.1.in b/doc/man/timew-annotate.1.in new file mode 100644 index 00000000..0f72e7a6 --- /dev/null +++ b/doc/man/timew-annotate.1.in @@ -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 +.B ... +] +.I +.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) \ No newline at end of file