mirror of
https://github.com/GothenburgBitFactory/timewarrior.git
synced 2025-06-26 10:54:28 +02:00
103 lines
2.8 KiB
Groff
103 lines
2.8 KiB
Groff
.TH timew 1 2015-11-29 "${PACKAGE_STRING}" "User Manuals"
|
|
|
|
.SH NAME
|
|
timew \- A command line time tracker.
|
|
|
|
.SH SYNOPSIS
|
|
.B timew <command>
|
|
|
|
.SH DESCRIPTION
|
|
Timewarrior is a command line time tracker. It allows you to very easily track
|
|
your time spent on projects, and generate summary reports.
|
|
|
|
.SH SUBCOMMANDS
|
|
|
|
Timewarrior supports many commands.
|
|
|
|
.TP
|
|
.B timew
|
|
When run with no arguments, the default command is run, which indicates whether
|
|
there is any active tracking, and if so, shows a summary.
|
|
|
|
.TP
|
|
.B timew diagnostics
|
|
This command shows details about your version of Timewarrior, platform, how it
|
|
was built, compiler features, configuration, file access, extensions and more.
|
|
The purpose of this command is to help diagnose configuration problems, and
|
|
provide supplemental information when reporting a problem. See also 'extensions'.
|
|
|
|
.TP
|
|
.B timew extensions
|
|
Displays the directory containing the extension programs, and a table showing
|
|
each extention and its status. See also 'diagnostics'.
|
|
|
|
.TP
|
|
.B timew log [<message>]
|
|
Writes the info <message> to the Timewarrior log file. If <message> is ommitted,
|
|
writes a cut marker ('-------- 8< --------') line to the log file.
|
|
|
|
.TP
|
|
.B timew start [<tag> ...]
|
|
Begins tracking using the current time, and the specified optional set of tags.
|
|
If a tag contains multiple words, and therefore contains spaces, use quotes to
|
|
surround the whole tag. For example, this command specifies two tags ('weekend'
|
|
and 'Home & Garden'), the second of which requires quotes.
|
|
|
|
$ timew start weekend 'Home & Garden'
|
|
|
|
Quotes are harmless if used every time. See also 'stop', 'track'.
|
|
|
|
.TP
|
|
.B timew stop
|
|
Stops tracking time. See also 'start', 'track'.
|
|
|
|
.SH CONFIGURATION FILE AND OVERRIDE OPTIONS
|
|
Timewarrior stores its configuration in a file in the user's home directory:
|
|
~/.timewrc.
|
|
|
|
.SH MORE EXAMPLES
|
|
|
|
For examples please see the online documentation starting at:
|
|
|
|
.RS
|
|
<http://taskwarrior.org/???>
|
|
.RE
|
|
|
|
Note that the online documentation can be more detailed and more current than
|
|
this man page.
|
|
|
|
.SH FILES
|
|
|
|
.TP
|
|
~/.timewrc
|
|
User configuration file - see also timewrc(5). Note that this can be
|
|
overridden on the command line or by the TIMEWRC environment variable.
|
|
|
|
.SH "CREDITS & COPYRIGHTS"
|
|
Copyright (C) 2015 \- 2016 P. Beckingham, F. Hernandez.
|
|
|
|
Timewarrior is distributed under the MIT license. See
|
|
http://www.opensource.org/licenses/mit-license.php for more information.
|
|
|
|
.SH SEE ALSO
|
|
.BR timewrc(5)
|
|
|
|
For more information regarding Timewarrior, see the following:
|
|
|
|
.TP
|
|
The official site at
|
|
<http://taskwarrior.org>
|
|
|
|
.TP
|
|
The official code repository at
|
|
<https://git.tasktools.org/scm/tm/timew.git>
|
|
|
|
.TP
|
|
You can contact the project by emailing
|
|
<support@taskwarrior.org>
|
|
|
|
.SH REPORTING BUGS
|
|
.TP
|
|
Bugs in Timewarrior may be reported to the issue-tracker at
|
|
<https://bug.tasktools.org/>
|
|
|