diff --git a/doc/man/timew.1.in b/doc/man/timew.1.in index 251cf2e0..839011f4 100644 --- a/doc/man/timew.1.in +++ b/doc/man/timew.1.in @@ -1,45 +1,45 @@ .TH timew 1 2018-02-03 "${PACKAGE_STRING}" "User Manuals" - +. .SH NAME timew \- A command line time tracker. - +. .SH SYNOPSIS .B timew [ ...] - +. .SH DESCRIPTION -Timewarrior is a command line time tracker. It allows you to easily track your -time and generate summary reports. - -This is a reference, not a tutorial. If you are looking for a tutorial, check -the online documentation here: - +Timewarrior is a command line time tracker. +It allows you to easily track your time and generate summary reports. +. +This is a reference, not a tutorial. +If you are looking for a tutorial, check the online documentation here: +. https://taskwarrior.org/docs/timewarrior - +. .SH SUBCOMMANDS - -Timewarrior supports many commands. Alphabetically: - +. +Timewarrior supports many commands. +Alphabetically: +. .TP .B timew .br -When run without arguments, the default command is run, which indicates whether -there is any active tracking, and if so, shows a summary, then exits with a code -0. If there is no active time tracking, exit code is 1. +When run without arguments, the default command is run, which indicates whether there is any active tracking, and if so, shows a summary, then exits with a code 0. +If there is no active time tracking, exit code is 1. See also 'get'. - +. .SH INTERVAL -An interval defines a block of time that is tracked. The syntax for specifying -an interval is flexible, and may be one of: - +An interval defines a block of time that is tracked. +The syntax for specifying an interval is flexible, and may be one of: +. [from] [from] to/- [from] for before/after ago [for] - +. Examples are: - +. from 9:00 from 9am - 11am from 9:00:00 to 11:00 @@ -48,37 +48,36 @@ Examples are: 2h before 11:00 2h ago for 2h - -An interval is said to be 'closed' if there is both a start and end, and 'open' -if there is no end date. - +. +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: - +Timewarrior supports hints, which are single-word command line features that start with a colon like this: +. :week - -Hints serve several purposes. This example is a shortcut for the date range -that defines the current week. Other hints, such as: - +. +Hints serve several purposes. +This example is a shortcut for the date range that defines the current week. +Other hints, such as: +. :quiet - -Are ways to control the behavior of Timewarrior, in this case eliminating all -forms of feedback, for purposes of automation. The supported hints are: - +. +Are ways to control the behavior of Timewarrior, in this case eliminating all forms of feedback, for purposes of automation. +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 - +. 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 @@ -96,35 +95,35 @@ Range hints provide convenient shortcuts to date ranges: :friday Previous friday :saturday Previous saturday :sunday Previous sunday - +. .SH DATES Timewarrior supports the following date formats based on ISO-8601: - +. [T ] Extended date, optional extended time [T