Extract documentation aboug hints into separate man page

Signed-off-by: Thomas Lauf <thomas.lauf@tngtech.com>
This commit is contained in:
Thomas Lauf 2019-02-15 14:07:03 +01:00
parent eeb4645563
commit 94ac7bd58a
2 changed files with 47 additions and 47 deletions

47
doc/man/timew-hints.7.in Normal file
View file

@ -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
.

View file

@ -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:
.