From 91f02a4866ba4d8c0569c6c61bd86842bbd62dc7 Mon Sep 17 00:00:00 2001 From: Thomas Lauf Date: Sat, 23 Jun 2018 16:21:28 +0200 Subject: [PATCH] Add SYNOPSIS section --- doc/man/timew-cancel.1.in | 3 +++ doc/man/timew-config.1.in | 11 +++++++++++ doc/man/timew-continue.1.in | 12 ++++++++++++ doc/man/timew-day.1.in | 9 +++++++++ doc/man/timew-delete.1.in | 5 +++++ doc/man/timew-diagnostics.1.in | 3 +++ doc/man/timew-export.1.in | 8 ++++++++ doc/man/timew-extensions.1.in | 3 +++ doc/man/timew-fill.1.in | 5 +++++ doc/man/timew-gaps.1.in | 9 +++++++++ doc/man/timew-get.1.in | 5 +++++ doc/man/timew-help.1.in | 14 ++++++++++++++ doc/man/timew-join.1.in | 4 ++++ doc/man/timew-lengthen.1.in | 6 ++++++ doc/man/timew-month.1.in | 9 +++++++++ doc/man/timew-move.1.in | 4 ++++ doc/man/timew-report.1.in | 13 +++++++++++++ doc/man/timew-resize.1.in | 6 ++++++ doc/man/timew-shorten.1.in | 6 ++++++ doc/man/timew-show.1.in | 3 +++ doc/man/timew-split.1.in | 5 +++++ doc/man/timew-start.1.in | 9 +++++++++ doc/man/timew-stop.1.in | 9 +++++++++ doc/man/timew-summary.1.in | 9 +++++++++ doc/man/timew-tag.1.in | 9 +++++++++ doc/man/timew-tags.1.in | 6 ++++++ doc/man/timew-track.1.in | 8 ++++++++ doc/man/timew-untag.1.in | 9 +++++++++ doc/man/timew-week.1.in | 9 +++++++++ 29 files changed, 211 insertions(+) diff --git a/doc/man/timew-cancel.1.in b/doc/man/timew-cancel.1.in index cd2d076b..7c77db6d 100644 --- a/doc/man/timew-cancel.1.in +++ b/doc/man/timew-cancel.1.in @@ -3,6 +3,9 @@ .SH NAME timew-cancel \- cancel time tracking +.SH SYNOPSIS +.B timew cancel + .TP .B timew cancel If there is an open interval, it is abandoned. diff --git a/doc/man/timew-config.1.in b/doc/man/timew-config.1.in index dcb88902..bf609b19 100644 --- a/doc/man/timew-config.1.in +++ b/doc/man/timew-config.1.in @@ -3,6 +3,17 @@ .SH NAME timew-config \- get and set Timewarrior configuration +.SH SYNOPSIS +.B timew config +[ +.I +{ +.I +| +.B '' +} +] + .TP .B timew config [ [ | '']] Allows setting and removing configuration values, as an alternative to directly diff --git a/doc/man/timew-continue.1.in b/doc/man/timew-continue.1.in index ac9fc069..5f93d96a 100644 --- a/doc/man/timew-continue.1.in +++ b/doc/man/timew-continue.1.in @@ -3,6 +3,18 @@ .SH NAME timew-continue \- resume tracking of existing interval +.SH SYNOPSIS +.B timew continue +[ +.I +] [ +{ +.I +| +.I +} +] + .TP .B timew continue [@] [|] Resumes tracking of closed intervals. For example: diff --git a/doc/man/timew-day.1.in b/doc/man/timew-day.1.in index 35caba64..1b896425 100644 --- a/doc/man/timew-day.1.in +++ b/doc/man/timew-day.1.in @@ -3,6 +3,15 @@ .SH NAME timew-day \- display day chart +.SH SYNOPSIS +.B timew day +[ +.I +] [ +.I +.B ... +] + .TP .B timew day [] [ ...] The day command shows a chart depicting a single day (today by default), with diff --git a/doc/man/timew-delete.1.in b/doc/man/timew-delete.1.in index 70fff20d..857b95f5 100644 --- a/doc/man/timew-delete.1.in +++ b/doc/man/timew-delete.1.in @@ -3,6 +3,11 @@ .SH NAME timew-delete \- delete intervals +.SH SYNOPSIS +.B timew delete +.I +.B ... + .TP .B timew delete @ [@ ...] Deletes an interval. Using the 'summary' command, and specifying the ':ids' hint diff --git a/doc/man/timew-diagnostics.1.in b/doc/man/timew-diagnostics.1.in index ddde375e..5883fe5b 100644 --- a/doc/man/timew-diagnostics.1.in +++ b/doc/man/timew-diagnostics.1.in @@ -3,6 +3,9 @@ .SH NAME timew-diagnostics \- show diagnostic information +.SH SYNOPSIS +.B timew diagnostics + .TP .B timew diagnostics This command shows details about your version of Timewarrior, your platform, how diff --git a/doc/man/timew-export.1.in b/doc/man/timew-export.1.in index 2e1ef9e4..123b79f9 100644 --- a/doc/man/timew-export.1.in +++ b/doc/man/timew-export.1.in @@ -3,6 +3,14 @@ .SH NAME timew-export \- export tracked time in JSON +.SH SYNOPSIS +.B timew export +[ +.I +] [ +.I ... +] + .TP .B timew export [] [ ...] Exports all the tracked time in JSON format. Supports filtering. For example: diff --git a/doc/man/timew-extensions.1.in b/doc/man/timew-extensions.1.in index 7be52e2c..436aaff0 100644 --- a/doc/man/timew-extensions.1.in +++ b/doc/man/timew-extensions.1.in @@ -3,6 +3,9 @@ .SH NAME timew-extension \- list available extensions +.SH SYNOPSIS +.B timew extensions + .TP .B timew extensions Displays the directory containing the extension programs and a table showing diff --git a/doc/man/timew-fill.1.in b/doc/man/timew-fill.1.in index 4b3bd4f3..6e84f1b7 100644 --- a/doc/man/timew-fill.1.in +++ b/doc/man/timew-fill.1.in @@ -3,6 +3,11 @@ .SH NAME timew-fill \- adjust intervals to fill in surrounding gaps +.SH SYNOPSIS +.B timew fill +.I +.B ... + .TP .B timew fill @ [@ ...] diff --git a/doc/man/timew-gaps.1.in b/doc/man/timew-gaps.1.in index 1764a397..cb37beb8 100644 --- a/doc/man/timew-gaps.1.in +++ b/doc/man/timew-gaps.1.in @@ -3,6 +3,15 @@ .SH NAME timew-gaps \- display time tracking gaps +.SH SYNOPSIS +.B timew gaps +[ +.I +] [ +.I +.B ... +] + .TP .B timew gaps [] [ ...] Displays a summary of time that is neither tracked nor excluded from tracking. diff --git a/doc/man/timew-get.1.in b/doc/man/timew-get.1.in index 0dbd14f8..71f1e80b 100644 --- a/doc/man/timew-get.1.in +++ b/doc/man/timew-get.1.in @@ -3,6 +3,11 @@ .SH NAME timew-get \- display DOM values +.SH SYNOPSIS +.B timew get +.I +.B ... + .TP .B timew get [ ...] Validates the DOM reference, then obtains the value and displays it. For example: diff --git a/doc/man/timew-help.1.in b/doc/man/timew-help.1.in index 28830b43..5834f824 100644 --- a/doc/man/timew-help.1.in +++ b/doc/man/timew-help.1.in @@ -3,6 +3,20 @@ .SH NAME timew-help \- display help +.SH SYNOPSIS +.B timew help +{ +.I +| +.B interval +| +.B hints +| +.B date +| +.B duration +} + .TP .B timew help [ | interval | hints | date | duration] The help command shows detailed descriptions and examples of commands, diff --git a/doc/man/timew-join.1.in b/doc/man/timew-join.1.in index efae76d4..7e10d28b 100644 --- a/doc/man/timew-join.1.in +++ b/doc/man/timew-join.1.in @@ -3,6 +3,10 @@ .SH NAME timew-join \- join intervals +.SH SYNOPSIS +.B timew join +.I + .TP .B timew join @ @ Joins two intervals, by using the earlier of the two start times, and the later diff --git a/doc/man/timew-lengthen.1.in b/doc/man/timew-lengthen.1.in index 96ac1f99..f0ed5740 100644 --- a/doc/man/timew-lengthen.1.in +++ b/doc/man/timew-lengthen.1.in @@ -3,6 +3,12 @@ .SH NAME timew-lengthen \- lengthen intervals +.SH SYNOPSIS +.B timew lengthen +.I +.B ... +.I + .TP .B timew lengthen @ [@ ...] The 'lengthen' command is used to defer the end date of a closed interval. diff --git a/doc/man/timew-month.1.in b/doc/man/timew-month.1.in index 9303787b..93621556 100644 --- a/doc/man/timew-month.1.in +++ b/doc/man/timew-month.1.in @@ -3,6 +3,15 @@ .SH NAME timew-month \- display month chart +.SH SYNOPSIS +.B timew month +[ +.I +] [ +.I +.B ... +] + .TP .B timew month [] [ ...] The month command shows a chart depicting a single month (current month by diff --git a/doc/man/timew-move.1.in b/doc/man/timew-move.1.in index 72f8bfdb..77456291 100644 --- a/doc/man/timew-move.1.in +++ b/doc/man/timew-move.1.in @@ -3,6 +3,10 @@ .SH NAME timew-move \- change interval start-time +.SH SYNOPSIS +.B timew move +.I + .TP .B timew move @ The 'move' command is used to reposition an interval at a new start time. diff --git a/doc/man/timew-report.1.in b/doc/man/timew-report.1.in index 297ae18c..1ca0b328 100644 --- a/doc/man/timew-report.1.in +++ b/doc/man/timew-report.1.in @@ -3,6 +3,19 @@ .SH NAME timew-report \- run an extension report +.SH SYNOPSIS +.B timew +[ +.B report +] +.I +[ +.I +] [ +.I +.B ... +] + .TP .B timew [report] [] [ ...] Runs an extension report, and supports filtering data. diff --git a/doc/man/timew-resize.1.in b/doc/man/timew-resize.1.in index 1a9844fa..928db613 100644 --- a/doc/man/timew-resize.1.in +++ b/doc/man/timew-resize.1.in @@ -3,6 +3,12 @@ .SH NAME timew-resize \- set interval duration +.SH SYNOPSIS +.B timew resize +.I +.B ... +.I + .TP .B timew resize @ [@ ...] The 'resize' command is used to change the duration of a closed interval. diff --git a/doc/man/timew-shorten.1.in b/doc/man/timew-shorten.1.in index baaca9bc..b0ecbdfa 100644 --- a/doc/man/timew-shorten.1.in +++ b/doc/man/timew-shorten.1.in @@ -3,6 +3,12 @@ .SH NAME timew-shorten \- shorten intervals +.SH SYNOPSIS +.B timew shorten +.I +.B ... +.I + .TP .B timew shorten @ [@ ...] The 'shorten' command is used to advance the end date of a closed interval. diff --git a/doc/man/timew-show.1.in b/doc/man/timew-show.1.in index e9427218..b87562bf 100644 --- a/doc/man/timew-show.1.in +++ b/doc/man/timew-show.1.in @@ -3,6 +3,9 @@ .SH NAME timew-show \- display configuration +.SH SYNOPSIS +.B timew show + .TP .B timew show Displays the effective configuration in hierarchical form. diff --git a/doc/man/timew-split.1.in b/doc/man/timew-split.1.in index 8df1e00c..b1bf80be 100644 --- a/doc/man/timew-split.1.in +++ b/doc/man/timew-split.1.in @@ -3,6 +3,11 @@ .SH NAME timew-split \- split intervals +.SH SYNOPSIS +.B timew split +.I +.B ... + .TP .B timew split @ [@ ...] Š…plits an interval into two equally sized adjacent intervals, having the same diff --git a/doc/man/timew-start.1.in b/doc/man/timew-start.1.in index 29777e0f..6964f897 100644 --- a/doc/man/timew-start.1.in +++ b/doc/man/timew-start.1.in @@ -3,6 +3,15 @@ .SH NAME timew-start \- start time tracking +.SH SYNOPSIS +.B timew start +[ +.I +] [ +.I +.B ... +] + .TP .B timew start [] [ ...] Begins tracking using the current time with any specified set of tags. diff --git a/doc/man/timew-stop.1.in b/doc/man/timew-stop.1.in index 7687b40e..207aab82 100644 --- a/doc/man/timew-stop.1.in +++ b/doc/man/timew-stop.1.in @@ -3,6 +3,15 @@ .SH NAME timew-stop \- stop time tracking +.SH SYNOPSIS +.B timew stop +[ +.I +] [ +.I +.B ... +] + .TP .B timew stop [ ...] Stops tracking time. If tags are specified, then they are no longer tracked. diff --git a/doc/man/timew-summary.1.in b/doc/man/timew-summary.1.in index fd471888..987b3120 100644 --- a/doc/man/timew-summary.1.in +++ b/doc/man/timew-summary.1.in @@ -3,6 +3,15 @@ .SH NAME timew-summary \- display a time-tracking summary +.SH SYNOPSIS +.B timew summary +[ +.I +] [ +.I +.B ... +] + .TP .B timew summary [] [ ...] Displays a report summarizing tracked and untracked time for the current day by diff --git a/doc/man/timew-tag.1.in b/doc/man/timew-tag.1.in index e9b004a1..1f78dcac 100644 --- a/doc/man/timew-tag.1.in +++ b/doc/man/timew-tag.1.in @@ -3,6 +3,15 @@ .SH NAME timew-tag \- add tags to intervals +.SH SYNOPSIS +.B timew tag +[ +.I +.B ... +] +.I +.B ... + .TP .B timew tag [@ ...] ... The 'tag' command is used to add a tag to an interval. Using the 'summary' diff --git a/doc/man/timew-tags.1.in b/doc/man/timew-tags.1.in index 96a99cd6..2ec9ed0c 100644 --- a/doc/man/timew-tags.1.in +++ b/doc/man/timew-tags.1.in @@ -3,6 +3,12 @@ .SH NAME timew-tags \- display a list of tags +.SH SYNOPSIS +.B timew tags +[ +.I +] + .TP .B timew tags [] [ ...] Displays all the tags that have been used by default. When a filter is specified, diff --git a/doc/man/timew-track.1.in b/doc/man/timew-track.1.in index d58c3840..00f10977 100644 --- a/doc/man/timew-track.1.in +++ b/doc/man/timew-track.1.in @@ -3,6 +3,14 @@ .SH NAME timew-track \- add intervals to the database +.SH SYNOPSIS +.B timew track +.I +[ +.I +.B ... +] + .TP .B timew track [ ...] The track command is used to add tracked time in the past. Perhaps you forgot diff --git a/doc/man/timew-untag.1.in b/doc/man/timew-untag.1.in index 9738e16b..0a8b4f04 100644 --- a/doc/man/timew-untag.1.in +++ b/doc/man/timew-untag.1.in @@ -3,6 +3,15 @@ .SH NAME timew-untag \- remove tags from intervals +.SH SYNOPSIS +.B timew untag +[ +.I +.B ... +] +.I +.B ... + .TP .B timew untag [@ ...] ... The 'untag' command is used to remove a tag from an interval. Using the 'summary' diff --git a/doc/man/timew-week.1.in b/doc/man/timew-week.1.in index 1e562916..273c4bbf 100644 --- a/doc/man/timew-week.1.in +++ b/doc/man/timew-week.1.in @@ -3,6 +3,15 @@ .SH NAME timew-week \- display week chart +.SH SYNOPSIS +.B timew week +[ +.I +] [ +.I +.B ... +] + .TP .B timew week [] [ ...] The week command shows a chart depicting a single week (current week by