mirror of
https://github.com/GothenburgBitFactory/timewarrior.git
synced 2025-07-07 20:06:39 +02:00
Docs: Added help command and hint descriptions
This commit is contained in:
parent
b799d36ff0
commit
a2fa358ecf
1 changed files with 30 additions and 2 deletions
|
@ -45,6 +45,15 @@ Exports all the tracked time in JSON format. See also 'import'.
|
||||||
Displays the directory containing the extension programs, and a table showing
|
Displays the directory containing the extension programs, and a table showing
|
||||||
each extention and its status. See also 'diagnostics'.
|
each extention and its status. See also 'diagnostics'.
|
||||||
|
|
||||||
|
.TP
|
||||||
|
.B timew help [<command> | hints]
|
||||||
|
The help command shows detailed descriptions and examples of commands and the
|
||||||
|
supported hints. For example:
|
||||||
|
|
||||||
|
$ timew help
|
||||||
|
$ timew help start
|
||||||
|
$ timew help hints
|
||||||
|
|
||||||
.TP
|
.TP
|
||||||
.B timew log [<message>]
|
.B timew log [<message>]
|
||||||
Writes the info <message> to the Timewarrior log file. If <message> is ommitted,
|
Writes the info <message> to the Timewarrior log file. If <message> is ommitted,
|
||||||
|
@ -82,12 +91,31 @@ See also 'continue', 'start', 'track'.
|
||||||
Displays all the tags that have been used.
|
Displays all the tags that have been used.
|
||||||
|
|
||||||
.SH HINTS
|
.SH HINTS
|
||||||
Hints are words on the command line that influence Timewarrior behavior. Many
|
Timewarrior supports hints, which are single-word command line features that
|
||||||
commands make use of hints. Supported hints are:
|
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:
|
||||||
|
|
||||||
|
: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:
|
||||||
|
|
||||||
:quiet Turns off all feedback. For automation
|
:quiet Turns off all feedback. For automation
|
||||||
:debug Runs in debug mode, shows many runtime details
|
:debug Runs in debug mode, shows many runtime details
|
||||||
|
|
||||||
|
:day The 24-hours of the current day
|
||||||
|
:week This week
|
||||||
|
:month This month
|
||||||
|
:quarter This quarter
|
||||||
|
:year This year
|
||||||
|
|
||||||
|
:fill Expand time to fill surrounding available gap
|
||||||
|
Only functions when exclusions are provided
|
||||||
|
|
||||||
.SH CONFIGURATION FILE AND OVERRIDE OPTIONS
|
.SH CONFIGURATION FILE AND OVERRIDE OPTIONS
|
||||||
Timewarrior stores its configuration in a file in the user's home directory:
|
Timewarrior stores its configuration in a file in the user's home directory:
|
||||||
~/.timewarrior/timewarrior.cfg.
|
~/.timewarrior/timewarrior.cfg.
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue