From 54468edcad1bd6dbf22cb3bb6bb26148c01aaa73 Mon Sep 17 00:00:00 2001 From: Thomas Lauf Date: Sat, 23 Jun 2018 17:46:42 +0200 Subject: [PATCH] Replace empty lines with null requests --- doc/man/timew-cancel.1.in | 7 ++++--- doc/man/timew-config.1.in | 21 +++++++++++---------- doc/man/timew-continue.1.in | 13 +++++++------ doc/man/timew-day.1.in | 19 ++++++++++--------- doc/man/timew-delete.1.in | 15 ++++++++------- doc/man/timew-diagnostics.1.in | 7 ++++--- doc/man/timew-export.1.in | 9 +++++---- doc/man/timew-extensions.1.in | 7 ++++--- doc/man/timew-fill.1.in | 21 +++++++++++---------- doc/man/timew-gaps.1.in | 13 +++++++------ doc/man/timew-get.1.in | 11 ++++++----- doc/man/timew-help.1.in | 9 +++++---- doc/man/timew-join.1.in | 15 ++++++++------- doc/man/timew-lengthen.1.in | 19 ++++++++++--------- doc/man/timew-month.1.in | 19 ++++++++++--------- doc/man/timew-move.1.in | 15 ++++++++------- doc/man/timew-report.1.in | 11 ++++++----- doc/man/timew-resize.1.in | 19 ++++++++++--------- doc/man/timew-shorten.1.in | 19 ++++++++++--------- doc/man/timew-show.1.in | 7 ++++--- doc/man/timew-split.1.in | 15 ++++++++------- doc/man/timew-start.1.in | 17 +++++++++-------- doc/man/timew-stop.1.in | 15 ++++++++------- doc/man/timew-summary.1.in | 13 +++++++------ doc/man/timew-tag.1.in | 25 +++++++++++++------------ doc/man/timew-tags.1.in | 7 ++++--- doc/man/timew-track.1.in | 11 ++++++----- doc/man/timew-untag.1.in | 25 +++++++++++++------------ doc/man/timew-week.1.in | 19 ++++++++++--------- 29 files changed, 226 insertions(+), 197 deletions(-) diff --git a/doc/man/timew-cancel.1.in b/doc/man/timew-cancel.1.in index a7df3ba2..d05c1a2a 100644 --- a/doc/man/timew-cancel.1.in +++ b/doc/man/timew-cancel.1.in @@ -1,12 +1,13 @@ .TH timew-cancel 1 2018-02-03 "${PACKAGE_STRING}" "User Manuals" - +. .SH NAME timew-cancel \- cancel time tracking - +. .SH SYNOPSIS .B timew cancel - +. .SH DESCRIPTION .B timew cancel If there is an open interval, it is abandoned. See also 'stop'. +. diff --git a/doc/man/timew-config.1.in b/doc/man/timew-config.1.in index abd5a579..d00eb01a 100644 --- a/doc/man/timew-config.1.in +++ b/doc/man/timew-config.1.in @@ -1,8 +1,8 @@ .TH timew-config 1 2018-02-03 "${PACKAGE_STRING}" "User Manuals" - +. .SH NAME timew-config \- get and set Timewarrior configuration - +. .SH SYNOPSIS .B timew config [ @@ -13,30 +13,31 @@ timew-config \- get and set Timewarrior configuration .B '' } ] - +. .SH DESCRIPTION .B timew config [ [ | '']] Allows setting and removing configuration values, as an alternative to directly editing your ~/.timewarrior/timewarrior.cfg file. For example: - +. $ timew config verbose yes $ timew config verbose '' $ timew config verbose - +. The first command sets 'verbose' to 'yes'. The second sets it to a blank value which overrides the default value. The third example deletes the 'verbose' setting. - +. When modifying configuration in this way, interactive confirmation will be sought. To override this confirmation, use the ':yes' hint, which means you intend to answer 'yes' to the confirmation questions: - +. $ timew config verbose '' :yes - +. If no arguments are provided, all configuration settings are shown: - +. $ timew config verbose = yes ... - +. See also 'hints', 'show'. +. diff --git a/doc/man/timew-continue.1.in b/doc/man/timew-continue.1.in index 6ffd861d..1590a2fe 100644 --- a/doc/man/timew-continue.1.in +++ b/doc/man/timew-continue.1.in @@ -1,8 +1,8 @@ .TH timew-continue 1 2018-02-03 "${PACKAGE_STRING}" "User Manuals" - +. .SH NAME timew-continue \- resume tracking of existing interval - +. .SH SYNOPSIS .B timew continue [ @@ -14,19 +14,20 @@ timew-continue \- resume tracking of existing interval .I } ] - +. .SH DESCRIPTION .B timew continue [@] [|] Resumes tracking of closed intervals. For example: - +. $ timew track 9am - 10am tag1 tag2 $ timew track 11am - 1pm tag3 $ timew continue @2 - +. The 'continue' command creates a new interval, starting now, and using the tags 'tag1' and 'tag2'. Using the 'summary' command and specifying the ':ids' hint shows interval IDs. This command is a convenient way to resume work without re-entering the tags. - +. See also 'start', 'stop'. +. diff --git a/doc/man/timew-day.1.in b/doc/man/timew-day.1.in index e8b81881..438f9e4f 100644 --- a/doc/man/timew-day.1.in +++ b/doc/man/timew-day.1.in @@ -1,8 +1,8 @@ .TH timew-day 1 2018-02-03 "${PACKAGE_STRING}" "User Manuals" - +. .SH NAME timew-day \- display day chart - +. .SH SYNOPSIS .B timew day [ @@ -11,25 +11,26 @@ timew-day \- display day chart .I .B ... ] - +. .SH DESCRIPTION .B timew day [] [ ...] The day command shows a chart depicting a single day (today by default), with colored blocks drawn on a timeline. The chart summarizes the tracked and untracked time. - +. Charts accept date ranges and tags for filtering, or shortcut hints: - +. $ timew day monday - today $ timew day :week $ timew day :month - +. The 'reports.day.range' configuration setting overrides the default date range. The default date range shown is ':day'. - +. The ':blank' hint causes only the excluded time to be shown, with no tracked time. This can be used to see the exclusions. - +. For more details, and precise times, use the 'summary' report. - +. See also 'week', 'month', 'summary'. +. diff --git a/doc/man/timew-delete.1.in b/doc/man/timew-delete.1.in index 3914b465..8961cd0d 100644 --- a/doc/man/timew-delete.1.in +++ b/doc/man/timew-delete.1.in @@ -1,23 +1,24 @@ .TH timew-delete 1 2018-02-03 "${PACKAGE_STRING}" "User Manuals" - +. .SH NAME timew-delete \- delete intervals - +. .SH SYNOPSIS .B timew delete .I .B ... - +. .SH DESCRIPTION .B timew delete @ [@ ...] 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. For example, show the IDs: - +. $ timew summary :week :ids - +. Then having selected '@2' as the interval you wish to delete: - +. $ timew delete @2 - +. See also 'cancel'. +. diff --git a/doc/man/timew-diagnostics.1.in b/doc/man/timew-diagnostics.1.in index fd5c13c6..a247a9ad 100644 --- a/doc/man/timew-diagnostics.1.in +++ b/doc/man/timew-diagnostics.1.in @@ -1,14 +1,15 @@ .TH timew-diagnostics 1 2018-02-03 "${PACKAGE_STRING}" "User Manuals" - +. .SH NAME timew-diagnostics \- show diagnostic information - +. .SH SYNOPSIS .B timew diagnostics - +. .SH DESCRIPTION .B timew diagnostics This command shows details about your version of Timewarrior, your platform, how it was built, compiler features, configuration, file access, extensions and more. The purpose of this command is to help diagnose configuration problems and provide supplemental information when reporting a problem. See also 'extensions'. +. diff --git a/doc/man/timew-export.1.in b/doc/man/timew-export.1.in index 04cd45e3..0c7f8bc2 100644 --- a/doc/man/timew-export.1.in +++ b/doc/man/timew-export.1.in @@ -1,8 +1,8 @@ .TH timew-export 1 2018-02-03 "${PACKAGE_STRING}" "User Manuals" - +. .SH NAME timew-export \- export tracked time in JSON - +. .SH SYNOPSIS .B timew export [ @@ -10,9 +10,10 @@ timew-export \- export tracked time in JSON ] [ .I ... ] - +. .SH DESCRIPTION .B timew export [] [ ...] Exports all the tracked time in JSON format. Supports filtering. For example: - +. $ timew export from 2016-01-01 for 3wks tag1 +. diff --git a/doc/man/timew-extensions.1.in b/doc/man/timew-extensions.1.in index 0126bc99..807ff3ae 100644 --- a/doc/man/timew-extensions.1.in +++ b/doc/man/timew-extensions.1.in @@ -1,12 +1,13 @@ .TH timew-extensions 1 2018-02-03 "${PACKAGE_STRING}" "User Manuals" - +. .SH NAME timew-extension \- list available extensions - +. .SH SYNOPSIS .B timew extensions - +. .SH DESCRIPTION .B timew extensions Displays the directory containing the extension programs and a table showing each extension and its status. See also 'diagnostics'. +. diff --git a/doc/man/timew-fill.1.in b/doc/man/timew-fill.1.in index 9469b956..75e5973c 100644 --- a/doc/man/timew-fill.1.in +++ b/doc/man/timew-fill.1.in @@ -1,29 +1,30 @@ .TH timew-fill 1 2018-02-03 "${PACKAGE_STRING}" "User Manuals" - +. .SH NAME timew-fill \- adjust intervals to fill in surrounding gaps - +. .SH SYNOPSIS .B timew fill .I .B ... - +. .SH DESCRIPTION .B timew fill @ [@ ...] - +. 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. For example, show the IDs: - +. $ timew summary :week :ids - +. Then having selected '@2' as the interval you wish to fill: - +. $ timew fill @2 - +. Note that you can fill multiple intervals: - +. $ timew fill @2 @10 @23 - +. See also 'hints'. +. diff --git a/doc/man/timew-gaps.1.in b/doc/man/timew-gaps.1.in index 7b5e1418..58ac5973 100644 --- a/doc/man/timew-gaps.1.in +++ b/doc/man/timew-gaps.1.in @@ -1,8 +1,8 @@ .TH timew-gaps 1 2018-02-03 "${PACKAGE_STRING}" "User Manuals" - +. .SH NAME timew-gaps \- display time tracking gaps - +. .SH SYNOPSIS .B timew gaps [ @@ -11,17 +11,18 @@ timew-gaps \- display time tracking gaps .I .B ... ] - +. .SH DESCRIPTION .B timew gaps [] [ ...] Displays a summary of time that is neither tracked nor excluded from tracking. - +. The 'reports.gaps.range' configuration setting overrides the default date range. The ':blank' hint causes only the excluded time to be shown, with no tracked time. The default date range shown is ':day'. - +. The ':blank' hint causes only the excluded time to be shown, with no tracked time. - +. See also 'summary'. +. diff --git a/doc/man/timew-get.1.in b/doc/man/timew-get.1.in index 9432a5bd..79f7f4ad 100644 --- a/doc/man/timew-get.1.in +++ b/doc/man/timew-get.1.in @@ -1,19 +1,20 @@ .TH timew-get 1 2018-02-03 "${PACKAGE_STRING}" "User Manuals" - +. .SH NAME timew-get \- display DOM values - +. .SH SYNOPSIS .B timew get .I .B ... - +. .SH DESCRIPTION .B timew get [ ...] Validates the DOM reference, then obtains the value and displays it. For example: - +. $ timew get dom.active 1 - +. It is an error to reference an interval or tag that does not exist. See also 'DOM'. +. diff --git a/doc/man/timew-help.1.in b/doc/man/timew-help.1.in index 2f25efc4..9161e8f7 100644 --- a/doc/man/timew-help.1.in +++ b/doc/man/timew-help.1.in @@ -1,8 +1,8 @@ .TH timew-help 1 2018-02-03 "${PACKAGE_STRING}" "User Manuals" - +. .SH NAME timew-help \- display help - +. .SH SYNOPSIS .B timew help { @@ -16,13 +16,13 @@ timew-help \- display help | .B duration } - +. .SH DESCRIPTION .B timew help [ | interval | hints | date | duration] The help command shows detailed descriptions and examples of commands, interval syntax, supported hints, date and duration formats and DOM references. For example: - +. $ timew help $ timew help start $ timew help hints @@ -30,3 +30,4 @@ For example: $ timew help date $ timew help duration $ timew help dom +. diff --git a/doc/man/timew-join.1.in b/doc/man/timew-join.1.in index 03b4893b..9352a38e 100644 --- a/doc/man/timew-join.1.in +++ b/doc/man/timew-join.1.in @@ -1,23 +1,24 @@ .TH timew-join 1 2018-02-03 "${PACKAGE_STRING}" "User Manuals" - +. .SH NAME timew-join \- join intervals - +. .SH SYNOPSIS .B timew join .I - +. .SH DESCRIPTION .B timew join @ @ 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. For example, show the IDs: - +. $ timew summary :week :ids - +. Then having selected '@1' and '@2' as the intervals you wish to join: - +. $ timew join @1 @2 - +. See also 'split', 'lengthen', 'shorten', 'resize'. +. diff --git a/doc/man/timew-lengthen.1.in b/doc/man/timew-lengthen.1.in index 67ed4ec2..5506016c 100644 --- a/doc/man/timew-lengthen.1.in +++ b/doc/man/timew-lengthen.1.in @@ -1,29 +1,30 @@ .TH timew-lengthen 1 2018-02-03 "${PACKAGE_STRING}" "User Manuals" - +. .SH NAME timew-lengthen \- lengthen intervals - +. .SH SYNOPSIS .B timew lengthen .I .B ... .I - +. .SH DESCRIPTION .B timew lengthen @ [@ ...] 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. For example, show the IDs: - +. $ timew summary :week :ids - +. Then having selected '@2' as the interval you wish to lengthen: - +. $ timew lengthen @2 10mins - +. Note that you can lengthen multiple intervals,: - +. $ timew lengthen @2 @10 @23 1hour - +. See also 'summary', 'tag', 'untag', 'shorten', 'resize'. +. diff --git a/doc/man/timew-month.1.in b/doc/man/timew-month.1.in index 321ad088..ba562581 100644 --- a/doc/man/timew-month.1.in +++ b/doc/man/timew-month.1.in @@ -1,8 +1,8 @@ .TH timew-month 1 2018-02-03 "${PACKAGE_STRING}" "User Manuals" - +. .SH NAME timew-month \- display month chart - +. .SH SYNOPSIS .B timew month [ @@ -11,24 +11,25 @@ timew-month \- display month chart .I .B ... ] - +. .SH DESCRIPTION .B timew month [] [ ...] The month command shows a chart depicting a single month (current month by default), with colored blocks drawn on a timeline. The chart summarizes the tracked and untracked time. - +. Accepts date ranges and tags for filtering, or shortcut hints: - +. $ timew month 1st - today $ timew month :week - +. The 'reports.month.range' configuration setting overrides the default date range. The default date range shown is ':month'. - +. The ':blank' hint causes only the excluded time to be shown, with no tracked time. - +. For more details, and precise times, use the 'summary' report. - +. See also 'day', 'week', 'summary'. +. diff --git a/doc/man/timew-move.1.in b/doc/man/timew-move.1.in index c8676e69..8a534a23 100644 --- a/doc/man/timew-move.1.in +++ b/doc/man/timew-move.1.in @@ -1,23 +1,24 @@ .TH timew-move 1 2018-02-03 "${PACKAGE_STRING}" "User Manuals" - +. .SH NAME timew-move \- change interval start-time - +. .SH SYNOPSIS .B timew move .I - +. .SH DESCRIPTION .B timew move @ 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. For example, show the IDs: - +. $ timew summary :week :ids - +. Then having selected '@2' as the interval you wish to move: - +. $ timew move @2 9am - +. See also 'summary', 'tag', 'untag', 'lengthen', 'shorten', 'resize'. +. diff --git a/doc/man/timew-report.1.in b/doc/man/timew-report.1.in index cbc5ffee..7b8d75b3 100644 --- a/doc/man/timew-report.1.in +++ b/doc/man/timew-report.1.in @@ -1,8 +1,8 @@ .TH timew-report 1 2018-02-03 "${PACKAGE_STRING}" "User Manuals" - +. .SH NAME timew-report \- run an extension report - +. .SH SYNOPSIS .B timew [ @@ -15,14 +15,15 @@ timew-report \- run an extension report .I .B ... ] - +. .SH DESCRIPTION .B timew [report] [] [ ...] Runs an extension report, and supports filtering data. The 'report' command itself is optional, which means that these two commands are equivalent: - +. $ timew report foo :week $ timew foo :week - +. This does however assume there is a 'foo' extension installed. +. diff --git a/doc/man/timew-resize.1.in b/doc/man/timew-resize.1.in index 6be659fa..63378de4 100644 --- a/doc/man/timew-resize.1.in +++ b/doc/man/timew-resize.1.in @@ -1,29 +1,30 @@ .TH timew-resize 1 2018-02-03 "${PACKAGE_STRING}" "User Manuals" - +. .SH NAME timew-resize \- set interval duration - +. .SH SYNOPSIS .B timew resize .I .B ... .I - +. .SH DESCRIPTION .B timew resize @ [@ ...] 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. For example, show the IDs: - +. $ timew summary :week :ids - +. Then having selected '@3' as the interval you wish to resize: - +. $ timew resize @3 15mins - +. Note that you can resize multiple intervals,: - +. $ timew resize @3 @1 @13 1hour - +. See also 'summary', 'tag', 'untag', 'lengthen', 'shorten'. +. diff --git a/doc/man/timew-shorten.1.in b/doc/man/timew-shorten.1.in index f800064a..b41ce77f 100644 --- a/doc/man/timew-shorten.1.in +++ b/doc/man/timew-shorten.1.in @@ -1,29 +1,30 @@ .TH timew-shorten 1 2018-02-03 "${PACKAGE_STRING}" "User Manuals" - +. .SH NAME timew-shorten \- shorten intervals - +. .SH SYNOPSIS .B timew shorten .I .B ... .I - +. .SH DESCRIPTION .B timew shorten @ [@ ...] 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. For example, show the IDs: - +. $ timew summary :week :ids - +. Then having selected '@2' as the interval you wish to shorten: - +. $ timew shorten @2 10mins - +. Note that you can shorten multiple intervals,: - +. $ timew shorten @2 @10 @23 1hour - +. See also 'summary', 'tag', 'untag', 'lengthen', 'resize'. +. diff --git a/doc/man/timew-show.1.in b/doc/man/timew-show.1.in index 746603bb..540c75ca 100644 --- a/doc/man/timew-show.1.in +++ b/doc/man/timew-show.1.in @@ -1,12 +1,13 @@ .TH timew-show 1 2018-02-03 "${PACKAGE_STRING}" "User Manuals" - +. .SH NAME timew-show \- display configuration - +. .SH SYNOPSIS .B timew show - +. .SH DESCRIPTION .B timew show Displays the effective configuration in hierarchical form. See also 'config'. +. diff --git a/doc/man/timew-split.1.in b/doc/man/timew-split.1.in index 24485af3..61d5cdaa 100644 --- a/doc/man/timew-split.1.in +++ b/doc/man/timew-split.1.in @@ -1,24 +1,25 @@ .TH timew-split 1 2018-02-03 "${PACKAGE_STRING}" "User Manuals" - +. .SH NAME timew-split \- split intervals - +. .SH SYNOPSIS .B timew split .I .B ... - +. .SH DESCRIPTION .B timew split @ [@ ...] Š…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. For example, show the IDs: - +. $ timew summary :week :ids - +. Then having selected '@2' as the interval you wish to split: - +. $ timew split @2 - +. See also 'join', 'lengthen', 'shorten'. +. diff --git a/doc/man/timew-start.1.in b/doc/man/timew-start.1.in index 79780985..58c65bf8 100644 --- a/doc/man/timew-start.1.in +++ b/doc/man/timew-start.1.in @@ -1,8 +1,8 @@ .TH timew-start 1 2018-02-03 "${PACKAGE_STRING}" "User Manuals" - +. .SH NAME timew-start \- start time tracking - +. .SH SYNOPSIS .B timew start [ @@ -11,21 +11,22 @@ timew-start \- start time tracking .I .B ... ] - +. .SH DESCRIPTION .B timew start [] [ ...] 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. For example, this command specifies two tags ('weekend' and 'Home & Garden'), the second of which requires quotes. - +. $ timew start weekend 'Home & Garden' - +. An optional date may be specified to indicate the intended start of the tracked time: - +. $ timew start 8am weekend 'Home & Garden' - +. If there is a previous open interval, it will be closed at the given start time. - +. Quotes are harmless if used unnecessarily. See also 'continue', 'stop', 'track'. +. diff --git a/doc/man/timew-stop.1.in b/doc/man/timew-stop.1.in index e253fe9d..b36740bd 100644 --- a/doc/man/timew-stop.1.in +++ b/doc/man/timew-stop.1.in @@ -1,8 +1,8 @@ .TH timew-stop 1 2018-02-03 "${PACKAGE_STRING}" "User Manuals" - +. .SH NAME timew-stop \- stop time tracking - +. .SH SYNOPSIS .B timew stop [ @@ -11,19 +11,20 @@ timew-stop \- stop time tracking .I .B ... ] - +. .SH DESCRIPTION .B timew stop [ ...] Stops tracking time. If tags are specified, then they are no longer tracked. If no tags are specified, all tracking stops. For example: - +. $ timew start tag1 tag2 ... $ timew stop tag1 - +. Initially time is tracked for both 'tag1' and 'tag2', then 'tag1' tracking is stopped, leaving tag2 active. To stop all tracking: - +. $ timew stop - +. See also 'cancel', 'continue', 'start', 'track'. +. diff --git a/doc/man/timew-summary.1.in b/doc/man/timew-summary.1.in index 8b5158f2..6f1b0f93 100644 --- a/doc/man/timew-summary.1.in +++ b/doc/man/timew-summary.1.in @@ -1,8 +1,8 @@ .TH timew-summary 1 2018-02-03 "${PACKAGE_STRING}" "User Manuals" - +. .SH NAME timew-summary \- display a time-tracking summary - +. .SH SYNOPSIS .B timew summary [ @@ -11,17 +11,18 @@ timew-summary \- display a time-tracking summary .I .B ... ] - +. .SH DESCRIPTION .B timew summary [] [ ...] Displays a report summarizing tracked and untracked time for the current day by default. Accepts date ranges and tags for filtering, or shortcut hints: - +. $ timew summary monday - today $ timew summary :week $ timew summary :month - +. The ':ids' hint adds an 'ID' column to the summary report output for interval modification. - +. See also 'day', 'week', 'month', 'shorten', 'lengthen', 'tag', 'untag'. +. diff --git a/doc/man/timew-tag.1.in b/doc/man/timew-tag.1.in index 1a72c14c..7d5c16a3 100644 --- a/doc/man/timew-tag.1.in +++ b/doc/man/timew-tag.1.in @@ -1,8 +1,8 @@ .TH timew-tag 1 2018-02-03 "${PACKAGE_STRING}" "User Manuals" - +. .SH NAME timew-tag \- add tags to intervals - +. .SH SYNOPSIS .B timew tag [ @@ -11,28 +11,29 @@ timew-tag \- add tags to intervals ] .I .B ... - +. .SH DESCRIPTION .B timew tag [@ ...] ... 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. For example, show the IDs: - +. $ timew summary :week :ids - +. Then having selected '@2' as the interval you wish to tag: - +. $ timew tag @2 'New Tag' - +. Note that you can tag multiple intervals, with multiple tags: - +. $ timew tag @2 @10 @23 'Tag One' tag2 tag3 - +. If there is active time tracking, you can omit the ID when you want to add tags to the current open interval: - +. $ timew start foo $ timew tag bar - +. This results in the current interval having tags 'foo' and 'bar'. - +. See also 'summary', 'shorten', 'lengthen', 'untag'. +. diff --git a/doc/man/timew-tags.1.in b/doc/man/timew-tags.1.in index b788558e..42a8658f 100644 --- a/doc/man/timew-tags.1.in +++ b/doc/man/timew-tags.1.in @@ -1,15 +1,16 @@ .TH timew-tags 1 2018-02-03 "${PACKAGE_STRING}" "User Manuals" - +. .SH NAME timew-tags \- display a list of tags - +. .SH SYNOPSIS .B timew tags [ .I ] - +. .SH DESCRIPTION .B timew tags [] [ ...] Displays all the tags that have been used by default. When a filter is specified, shows only the tags that were used during that time. +. diff --git a/doc/man/timew-track.1.in b/doc/man/timew-track.1.in index 53ba60b1..ac5260bc 100644 --- a/doc/man/timew-track.1.in +++ b/doc/man/timew-track.1.in @@ -1,8 +1,8 @@ .TH timew-track 1 2018-02-03 "${PACKAGE_STRING}" "User Manuals" - +. .SH NAME timew-track \- add intervals to the database - +. .SH SYNOPSIS .B timew track .I @@ -10,15 +10,16 @@ timew-track \- add intervals to the database .I .B ... ] - +. .SH DESCRIPTION .B timew track [ ...] 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. For example: - +. $ timew track :yesterday 'Training Course' $ timew track 9am - 11am 'Staff Meeting' - +. Note that the track command expects a closed interval (start and end time), when recording. If a closed interval is not provided, the 'track' command behaves the same as the 'start' command. +. diff --git a/doc/man/timew-untag.1.in b/doc/man/timew-untag.1.in index cc2c32e4..f7763e1c 100644 --- a/doc/man/timew-untag.1.in +++ b/doc/man/timew-untag.1.in @@ -1,8 +1,8 @@ .TH timew-untag 1 2018-02-03 "${PACKAGE_STRING}" "User Manuals" - +. .SH NAME timew-untag \- remove tags from intervals - +. .SH SYNOPSIS .B timew untag [ @@ -11,28 +11,29 @@ timew-untag \- remove tags from intervals ] .I .B ... - +. .SH DESCRIPTION .B timew untag [@ ...] ... 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. For example, show the IDs: - +. $ timew summary :week :ids - +. Then having selected '@2' as the interval you wish to untag: - +. $ timew untag @2 'Old Tag' - +. Note that you can untag multiple intervals, with multiple tags: - +. $ timew untag @2 @10 @23 'Old Tag' tag2 tag3 - +. If there is active time tracking, you can omit the ID when you want to remove tags from the current open interval: - +. $ timew start foo bar $ timew untag bar - +. This results in the current interval having tag 'foo' but not 'bar'. - +. See also 'summary', 'shorten', 'lengthen', 'tag'. +. diff --git a/doc/man/timew-week.1.in b/doc/man/timew-week.1.in index 4e7b7ec0..4fd75a65 100644 --- a/doc/man/timew-week.1.in +++ b/doc/man/timew-week.1.in @@ -1,8 +1,8 @@ .TH timew-week 1 2018-02-03 "${PACKAGE_STRING}" "User Manuals" - +. .SH NAME timew-week \- display week chart - +. .SH SYNOPSIS .B timew week [ @@ -11,24 +11,25 @@ timew-week \- display week chart .I .B ... ] - +. .SH DESCRIPTION .B timew week [] [ ...] The week command shows a chart depicting a single week (current week by default), with colored blocks drawn on a timeline. The chart summarizes the tracked and untracked time. - +. Accepts date ranges and tags for filtering, or shortcut hints: - +. $ timew week $ timew week monday - today - +. The 'reports.week.range' configuration setting overrides the default date range. The default date range shown is ':week'. - +. The ':blank' hint causes only the excluded time to be shown, with no tracked time. - +. For more details, and precise times, use the 'summary' report. - +. See also 'day', 'month', 'summary'. +.