From 94ac7bd58a0f636d1d5d6fcfa550f033e99e280d Mon Sep 17 00:00:00 2001 From: Thomas Lauf Date: Fri, 15 Feb 2019 14:07:03 +0100 Subject: [PATCH] Extract documentation aboug hints into separate man page Signed-off-by: Thomas Lauf --- doc/man/timew-hints.7.in | 47 ++++++++++++++++++++++++++++++++++++++++ doc/man/timew.1.in | 47 ---------------------------------------- 2 files changed, 47 insertions(+), 47 deletions(-) create mode 100644 doc/man/timew-hints.7.in diff --git a/doc/man/timew-hints.7.in b/doc/man/timew-hints.7.in new file mode 100644 index 00000000..3d675133 --- /dev/null +++ b/doc/man/timew-hints.7.in @@ -0,0 +1,47 @@ +.SH HINTS +Timewarrior supports hints, which are single-word command line features that start with a colon like this: +. + :week +.br +Hints serve several purposes. +This example is a shortcut for the date range that defines the current week. +.br +Other hints, such as: +. + :quiet +.br +Are ways to control the behavior of Timewarrior, in this case eliminating all forms of feedback, for purposes of automation. +.br +The supported hints are: +. + :quiet Turns off all feedback. For automation + :debug Runs in debug mode, shows many runtime details + :yes Overrides confirmation by answering 'yes' to the questions +. + :color Force color on, even if not connected to a TTY + :nocolor Force color off, even if connected to a TTY + :blank Leaves tracked time out of a report + :fill Expand time to fill surrounding available gap + :adjust Automatically correct overlaps + :ids Displays interval ID numbers in the summary report +.br +Range hints provide convenient shortcuts to date ranges: +. + :yesterday The 24 hours of the previous day + :day The 24 hours of the current day + :week This week + :month This month + :quarter This quarter + :year This year + :lastweek Last week + :lastmonth Last month + :lastquarter Last quarter + :lastyear Last year + :monday Previous monday + :tuesday Previous tuesday + :wednesday Previous wednesday + :thursday Previous thursday + :friday Previous friday + :saturday Previous saturday + :sunday Previous sunday +. diff --git a/doc/man/timew.1.in b/doc/man/timew.1.in index d6fcc888..67085c4f 100644 --- a/doc/man/timew.1.in +++ b/doc/man/timew.1.in @@ -202,53 +202,6 @@ Examples are: .br An interval is said to be 'closed' if there is both a start and end, and 'open' if there is no end date. . -.SH HINTS -Timewarrior supports hints, which are single-word command line features that start with a colon like this: -. - :week -.br -Hints serve several purposes. -This example is a shortcut for the date range that defines the current week. -.br -Other hints, such as: -. - :quiet -.br -Are ways to control the behavior of Timewarrior, in this case eliminating all forms of feedback, for purposes of automation. -.br -The supported hints are: -. - :quiet Turns off all feedback. For automation - :debug Runs in debug mode, shows many runtime details - :yes Overrides confirmation by answering 'yes' to the questions -. - :color Force color on, even if not connected to a TTY - :nocolor Force color off, even if connected to a TTY - :blank Leaves tracked time out of a report - :fill Expand time to fill surrounding available gap - :adjust Automatically correct overlaps - :ids Displays interval ID numbers in the summary report -.br -Range hints provide convenient shortcuts to date ranges: -. - :yesterday The 24 hours of the previous day - :day The 24 hours of the current day - :week This week - :month This month - :quarter This quarter - :year This year - :lastweek Last week - :lastmonth Last month - :lastquarter Last quarter - :lastyear Last year - :monday Previous monday - :tuesday Previous tuesday - :wednesday Previous wednesday - :thursday Previous thursday - :friday Previous friday - :saturday Previous saturday - :sunday Previous sunday -. .SH DATES Timewarrior supports the following date formats based on ISO-8601: .