From d397fa4f7ab549eeefee563b1164815aeab5fe44 Mon Sep 17 00:00:00 2001 From: Paul Beckingham Date: Fri, 20 May 2016 22:32:49 -0500 Subject: [PATCH] Docs: Added summary help, and day, month and week examples --- doc/man/timew.1.in | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/doc/man/timew.1.in b/doc/man/timew.1.in index 11173f6a..21652091 100644 --- a/doc/man/timew.1.in +++ b/doc/man/timew.1.in @@ -70,6 +70,12 @@ 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. +Accepts date ranges and tags for filtering, or shortcut hints: + + $ timew day monday - today + $ timew day :week + $ timew day :month + For more details, and precise times, use the 'summary' report. See also 'week', 'month', 'summary'. @@ -111,6 +117,11 @@ 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 + For more details, and precise times, use the 'summary' report. See also 'day', 'week', 'summary'. @@ -163,6 +174,18 @@ stopped, leaving tag2 active. To stop all tracking: See also 'cancel', 'continue', 'start', 'track'. +.TP +.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 + +See also 'day', 'week', 'month'. + .TP .B timew tags Displays all the tags that have been used. @@ -185,6 +208,11 @@ 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 + For more details, and precise times, use the 'summary' report. See also 'day', 'month', 'summary'.