mirror of
https://github.com/GothenburgBitFactory/timewarrior.git
synced 2025-06-26 10:54:28 +02:00
239 lines
No EOL
3.8 KiB
Groff
239 lines
No EOL
3.8 KiB
Groff
.TH timew 1 "${PACKAGE_DATE}" "${PACKAGE_STRING}" "User Manuals"
|
|
.
|
|
.SH NAME
|
|
timew \- A command line time tracker.
|
|
.
|
|
.SH SYNOPSIS
|
|
.BR "timew " [ --version | --help ]
|
|
.br
|
|
.B timew
|
|
.RI [ "<command> " [ <arg> "...]]"
|
|
.
|
|
.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:
|
|
.br
|
|
https://timewarrior.net/docs/
|
|
.br
|
|
When run without arguments or options, 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.
|
|
.
|
|
.SH OPTIONS
|
|
.TP
|
|
.B \-\-version
|
|
.RS
|
|
Displays TimeWarrior version information
|
|
.RE
|
|
.TP
|
|
.B \-\-help
|
|
.RS
|
|
Display TimeWarrior usage information
|
|
.RE
|
|
.
|
|
.SH "TIMEWARRIOR COMMANDS"
|
|
Timewarrior supports many commands.
|
|
Alphabetically:
|
|
.
|
|
.TP
|
|
.BR timew-annotate (1)
|
|
.RS
|
|
Add annotation to intervals
|
|
.RE
|
|
.TP
|
|
.BR timew-cancel (1)
|
|
.RS
|
|
Cancel time tracking
|
|
.RE
|
|
.TP
|
|
.BR timew-config (1)
|
|
.RS
|
|
Get and set Timewarrior configuration
|
|
.RE
|
|
.TP
|
|
.BR timew-continue (1)
|
|
.RS
|
|
Resume tracking of existing interval
|
|
.RE
|
|
.TP
|
|
.BR timew-day (1)
|
|
.RS
|
|
Display day chart
|
|
.RE
|
|
.TP
|
|
.BR timew-delete (1)
|
|
.RS
|
|
Delete intervals
|
|
.RE
|
|
.TP
|
|
.BR timew-diagnostics (1)
|
|
.RS
|
|
Show diagnostic information
|
|
.RE
|
|
.TP
|
|
.BR timew-export (1)
|
|
.RS
|
|
Export tracked time in JSON
|
|
.RE
|
|
.TP
|
|
.BR timew-extensions (1)
|
|
.RS
|
|
List available extensions
|
|
.RE
|
|
.TP
|
|
.BR timew-get (1)
|
|
.RS
|
|
Display DOM values
|
|
.RE
|
|
.TP
|
|
.BR timew-help (1)
|
|
.RS
|
|
Display help
|
|
.RE
|
|
.TP
|
|
.BR timew-join (1)
|
|
.RS
|
|
Join intervals
|
|
.RE
|
|
.TP
|
|
.BR timew-lengthen (1)
|
|
.RS
|
|
Lengthen intervals
|
|
.RE
|
|
.TP
|
|
.BR timew-modify (1)
|
|
.RS
|
|
Change start or end time of an interval
|
|
.RE
|
|
.TP
|
|
.BR timew-month (1)
|
|
.RS
|
|
Display month chart
|
|
.RE
|
|
.TP
|
|
.BR timew-move (1)
|
|
.RS
|
|
Change interval start-time
|
|
.RE
|
|
.TP
|
|
.BR timew-report (1)
|
|
.RS
|
|
Run an extension report
|
|
.RE
|
|
.TP
|
|
.BR timew-resize (1)
|
|
.RS
|
|
Set interval duration
|
|
.RE
|
|
.TP
|
|
.BR timew-shorten (1)
|
|
.RS
|
|
Shorten intervals
|
|
.RE
|
|
.TP
|
|
.BR timew-show (1)
|
|
.RS
|
|
Display configuration
|
|
.RE
|
|
.TP
|
|
.BR timew-split (1)
|
|
.RS
|
|
Split intervals
|
|
.RE
|
|
.TP
|
|
.BR timew-start (1)
|
|
.RS
|
|
Start time tracking
|
|
.RE
|
|
.TP
|
|
.BR timew-stop (1)
|
|
.RS
|
|
Stop time tracking
|
|
.RE
|
|
.TP
|
|
.BR timew-summary (1)
|
|
.RS
|
|
Display a time-tracking summary
|
|
.RE
|
|
.TP
|
|
.BR timew-tag (1)
|
|
.RS
|
|
Add tags to intervals
|
|
.RE
|
|
.TP
|
|
.BR timew-tags (1)
|
|
.RS
|
|
Display a list of tags
|
|
.RE
|
|
.TP
|
|
.BR timew-track (1)
|
|
.RS
|
|
Add intervals to the database
|
|
.RE
|
|
.TP
|
|
.BR timew-undo (1)
|
|
.RS
|
|
Undo Timewarrior commands
|
|
.RE
|
|
.TP
|
|
.BR timew-untag (1)
|
|
.RS
|
|
Remove tags from intervals
|
|
.RE
|
|
.TP
|
|
.BR timew-week (1)
|
|
.RS
|
|
Display week chart
|
|
.RE
|
|
.
|
|
.SH "MORE EXAMPLES"
|
|
.
|
|
For examples please see the online documentation starting at:
|
|
.
|
|
.RS
|
|
<https://timewarrior.net/docs/>
|
|
.RE
|
|
.
|
|
Note that the online documentation can be more detailed and more current than this man page.
|
|
.
|
|
.SH FILES
|
|
.
|
|
.TP
|
|
~/.timewarrior/timewarrior.cfg
|
|
User configuration file.
|
|
.
|
|
.TP
|
|
~/.timewarrior/data/YYYY-MM.data
|
|
Time tracking data files.
|
|
.
|
|
.SH "CREDITS & COPYRIGHTS"
|
|
Copyright (C) 2015 \- 2018 T. Lauf, P. Beckingham, F. Hernandez.
|
|
.br
|
|
Timewarrior is distributed under the MIT license.
|
|
See https://www.opensource.org/licenses/mit-license.php for more information.
|
|
.
|
|
.SH "FURTHER DOCUMENTATION"
|
|
For more information regarding Timewarrior, see the following:
|
|
.
|
|
.TP
|
|
The official site at <https://timewarrior.net>
|
|
.
|
|
.TP
|
|
The official code repository at <https://github.com/GothenburgBitFactory/timewarrior>
|
|
.
|
|
.TP
|
|
You can contact the project by emailing <support@gothenburgbitfactory.org>
|
|
.
|
|
.SH "REPORTING BUGS"
|
|
.TP
|
|
Bugs in Timewarrior may be reported to the issue-tracker at <https://github.com/GothenburgBitFactory/timewarrior/issues>
|
|
.
|
|
.SH "SEE ALSO"
|
|
.BR timew-config (7),
|
|
.BR timew-dates (7),
|
|
.BR timew-dom (7),
|
|
.BR timew-durations (7),
|
|
.BR timew-hints (7),
|
|
.BR timew-ranges (7) |