From f53c6c4412547dc65b43184b9b0156b379a99968 Mon Sep 17 00:00:00 2001 From: Thomas Lauf Date: Sun, 24 Jun 2018 10:39:09 +0200 Subject: [PATCH] Add EXAMPLES section --- doc/man/timew-cancel.1.in | 2 ++ doc/man/timew-config.1.in | 2 ++ doc/man/timew-continue.1.in | 2 ++ doc/man/timew-delete.1.in | 2 ++ doc/man/timew-export.1.in | 2 ++ doc/man/timew-fill.1.in | 2 ++ doc/man/timew-get.1.in | 2 ++ doc/man/timew-help.1.in | 2 ++ doc/man/timew-join.1.in | 2 ++ doc/man/timew-lengthen.1.in | 2 ++ doc/man/timew-move.1.in | 2 ++ doc/man/timew-resize.1.in | 2 ++ doc/man/timew-shorten.1.in | 2 ++ doc/man/timew-split.1.in | 2 ++ doc/man/timew-start.1.in | 2 ++ doc/man/timew-stop.1.in | 2 ++ doc/man/timew-tag.1.in | 2 ++ doc/man/timew-track.1.in | 2 ++ doc/man/timew-untag.1.in | 2 ++ 19 files changed, 38 insertions(+) diff --git a/doc/man/timew-cancel.1.in b/doc/man/timew-cancel.1.in index ff162273..2b53fe28 100644 --- a/doc/man/timew-cancel.1.in +++ b/doc/man/timew-cancel.1.in @@ -9,5 +9,7 @@ timew-cancel \- cancel time tracking .SH DESCRIPTION If there is an open interval, it is abandoned. . +.SH EXAMPLES +. .SH "SEE ALSO" .BR timew-stop (1) \ No newline at end of file diff --git a/doc/man/timew-config.1.in b/doc/man/timew-config.1.in index ff8fee63..d3490b1c 100644 --- a/doc/man/timew-config.1.in +++ b/doc/man/timew-config.1.in @@ -16,6 +16,8 @@ timew-config \- get and set Timewarrior configuration . .SH DESCRIPTION Allows setting and removing configuration values, as an alternative to directly editing your ~/.timewarrior/timewarrior.cfg file. +. +.SH EXAMPLES For example: . $ timew config verbose yes diff --git a/doc/man/timew-continue.1.in b/doc/man/timew-continue.1.in index 563c2d72..75a4c0d9 100644 --- a/doc/man/timew-continue.1.in +++ b/doc/man/timew-continue.1.in @@ -17,6 +17,8 @@ timew-continue \- resume tracking of existing interval . .SH DESCRIPTION Resumes tracking of closed intervals. +. +.SH EXAMPLES For example: . $ timew track 9am - 10am tag1 tag2 diff --git a/doc/man/timew-delete.1.in b/doc/man/timew-delete.1.in index 9178fac7..2e59b2f0 100644 --- a/doc/man/timew-delete.1.in +++ b/doc/man/timew-delete.1.in @@ -12,6 +12,8 @@ timew-delete \- delete intervals 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. +. +.SH EXAMPLES For example, show the IDs: . $ timew summary :week :ids diff --git a/doc/man/timew-export.1.in b/doc/man/timew-export.1.in index e978a2f3..c340603c 100644 --- a/doc/man/timew-export.1.in +++ b/doc/man/timew-export.1.in @@ -14,6 +14,8 @@ timew-export \- export tracked time in JSON .SH DESCRIPTION Exports all the tracked time in JSON format. Supports filtering. +. +.SH EXAMPLES For example: . $ timew export from 2016-01-01 for 3wks tag1 diff --git a/doc/man/timew-fill.1.in b/doc/man/timew-fill.1.in index 0dc98a70..89f4cb29 100644 --- a/doc/man/timew-fill.1.in +++ b/doc/man/timew-fill.1.in @@ -12,6 +12,8 @@ timew-fill \- adjust intervals to fill in surrounding gaps 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. +. +.SH EXAMPLES For example, show the IDs: . $ timew summary :week :ids diff --git a/doc/man/timew-get.1.in b/doc/man/timew-get.1.in index 911b895e..b48475f0 100644 --- a/doc/man/timew-get.1.in +++ b/doc/man/timew-get.1.in @@ -10,6 +10,8 @@ timew-get \- display DOM values . .SH DESCRIPTION Validates the DOM reference, then obtains the value and displays it. +. +.SH EXAMPLES For example: . $ timew get dom.active diff --git a/doc/man/timew-help.1.in b/doc/man/timew-help.1.in index 84c5a58a..119a0810 100644 --- a/doc/man/timew-help.1.in +++ b/doc/man/timew-help.1.in @@ -19,6 +19,8 @@ timew-help \- display help . .SH DESCRIPTION The help command shows detailed descriptions and examples of commands, interval syntax, supported hints, date and duration formats and DOM references. +. +.SH EXAMPLES For example: . $ timew help diff --git a/doc/man/timew-join.1.in b/doc/man/timew-join.1.in index 5d73b6af..5c620842 100644 --- a/doc/man/timew-join.1.in +++ b/doc/man/timew-join.1.in @@ -11,6 +11,8 @@ timew-join \- join intervals 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. +. +.SH EXAMPLES For example, show the IDs: . $ timew summary :week :ids diff --git a/doc/man/timew-lengthen.1.in b/doc/man/timew-lengthen.1.in index 3890f478..88ea96dc 100644 --- a/doc/man/timew-lengthen.1.in +++ b/doc/man/timew-lengthen.1.in @@ -13,6 +13,8 @@ timew-lengthen \- lengthen intervals 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. +. +.SH EXAMPLES For example, show the IDs: . $ timew summary :week :ids diff --git a/doc/man/timew-move.1.in b/doc/man/timew-move.1.in index f3f67c25..e2b84dee 100644 --- a/doc/man/timew-move.1.in +++ b/doc/man/timew-move.1.in @@ -11,6 +11,8 @@ timew-move \- change interval start-time 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. +. +.SH EXAMPLES For example, show the IDs: . $ timew summary :week :ids diff --git a/doc/man/timew-resize.1.in b/doc/man/timew-resize.1.in index 6d5999b7..5fe90924 100644 --- a/doc/man/timew-resize.1.in +++ b/doc/man/timew-resize.1.in @@ -13,6 +13,8 @@ timew-resize \- set interval 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. +. +.SH EXAMPLES For example, show the IDs: . $ timew summary :week :ids diff --git a/doc/man/timew-shorten.1.in b/doc/man/timew-shorten.1.in index 9b16759a..2e62ed2b 100644 --- a/doc/man/timew-shorten.1.in +++ b/doc/man/timew-shorten.1.in @@ -13,6 +13,8 @@ timew-shorten \- shorten intervals 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. +. +.SH EXAMPLES For example, show the IDs: . $ timew summary :week :ids diff --git a/doc/man/timew-split.1.in b/doc/man/timew-split.1.in index 57b8b31c..80db693a 100644 --- a/doc/man/timew-split.1.in +++ b/doc/man/timew-split.1.in @@ -12,6 +12,8 @@ timew-split \- split intervals Š…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. +. +.SH EXAMPLES For example, show the IDs: . $ timew summary :week :ids diff --git a/doc/man/timew-start.1.in b/doc/man/timew-start.1.in index 0b9a0d4e..6d3801db 100644 --- a/doc/man/timew-start.1.in +++ b/doc/man/timew-start.1.in @@ -15,6 +15,8 @@ timew-start \- start time tracking .SH DESCRIPTION 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. +. +.SH EXAMPLES For example, this command specifies two tags ('weekend' and 'Home & Garden'), the second of which requires quotes. . $ timew start weekend 'Home & Garden' diff --git a/doc/man/timew-stop.1.in b/doc/man/timew-stop.1.in index f3f8fdf5..0048f1eb 100644 --- a/doc/man/timew-stop.1.in +++ b/doc/man/timew-stop.1.in @@ -16,6 +16,8 @@ timew-stop \- stop time tracking Stops tracking time. If tags are specified, then they are no longer tracked. If no tags are specified, all tracking stops. +. +.SH EXAMPLES For example: . $ timew start tag1 tag2 diff --git a/doc/man/timew-tag.1.in b/doc/man/timew-tag.1.in index 475c712a..76d8d7e0 100644 --- a/doc/man/timew-tag.1.in +++ b/doc/man/timew-tag.1.in @@ -16,6 +16,8 @@ timew-tag \- add tags to intervals 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. +. +.SH EXAMPLES For example, show the IDs: . $ timew summary :week :ids diff --git a/doc/man/timew-track.1.in b/doc/man/timew-track.1.in index d9a254df..3c6e1934 100644 --- a/doc/man/timew-track.1.in +++ b/doc/man/timew-track.1.in @@ -14,6 +14,8 @@ timew-track \- add intervals to the database .SH DESCRIPTION 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. +. +.SH EXAMPLES For example: . $ timew track :yesterday 'Training Course' diff --git a/doc/man/timew-untag.1.in b/doc/man/timew-untag.1.in index c301f9d1..79d4eba6 100644 --- a/doc/man/timew-untag.1.in +++ b/doc/man/timew-untag.1.in @@ -16,6 +16,8 @@ timew-untag \- remove tags from intervals 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. +. +.SH EXAMPLES For example, show the IDs: . $ timew summary :week :ids