Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Improve USAGE file and improve disposition of table width for report
- Loading branch information
Showing
2 changed files
with
74 additions
and
21 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,13 +1,51 @@ | ||
|
||
RTT is a tool for tracking time. It's primary extend is to be used from command line. | ||
===================================================================================== | ||
|
||
Usage: | ||
|
||
rtt start <task-name> | ||
rtt pause | ||
rtt stop | ||
rtt user <nickname> | ||
rtt client <client-name> | ||
rtt project <project-name> | ||
rtt rename <new-name-current-task> | ||
rtt list | ||
rtt report <filename>.pdf | ||
- rtt start <task-name> | rtt <task-name> | ||
|
||
Starts a new task (or existing task with that name) for the current project/client/user. | ||
|
||
- rtt pause | ||
|
||
Pauses the current task. | ||
|
||
- rtt resume | ||
|
||
Resumes the last paused task. | ||
|
||
- rtt stop | ||
|
||
Stops the current task. | ||
|
||
- rtt user <nickname> | ||
|
||
Changes the current user. If there is no user with the nickname specified it ask for user information interactivly. | ||
|
||
- rtt client <client-name> | ||
|
||
Sets the current client with with name specified (creates one client if there no client stored with that name). | ||
|
||
- rtt project <project-name> | ||
|
||
Sets the current project with the specified name. | ||
|
||
- rtt rename <new-name-current-task> | ||
|
||
Rename current task | ||
|
||
- CLIENT=some_client rtt list | CLIENT=some_client PROJECT=some_project rtt list | PROJECT=some_project rtt list | ||
|
||
List all tasks created for the filters provided. | ||
|
||
- rtt report <filename> | ||
|
||
Generates a report to be stored on on the path specified. | ||
|
||
- rtt configure (client|project|user|task) | ||
|
||
Allows to change properties of current objects. | ||
|
||
Enjoy! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters