Add EXAMPLES section

2025-07-07 20:06:39 +02:00 · 2018-06-24 10:39:09 +02:00 · 2018-06-24 10:39:09 +02:00 · f53c6c4412
commit f53c6c4412
parent 81056986ab
19 changed files with 38 additions and 0 deletions
--- 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)
--- 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
--- 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
--- 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
--- 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
--- 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
--- 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
--- 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
--- 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
--- 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
--- 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
--- 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
--- 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
--- 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
--- 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'
--- 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
--- 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
--- 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'
--- 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