timr 0.3.0 → 0.4.0

data/man/timr-report.1.ronn

@@ -0,0 +1,193 @@
+timr-report(1) -- Export Tasks and Tracks.
+===
+
+## SYNOPSIS
+
+timr report [<options>]
+
+## DESCRIPTION
+
+This command is designed to print a list of Tasks or Tracks to STDOUT and to export Tasks and Tracks as CSV files. While this command is similar to timr-log(1), the main focus is exporting Tasks/Tracks as CSV file for further processing.
+
+## OPTIONS
+
+* -d, --day <date>:
+	A single day from 00:00 to 23:59. See timr-ftime(7).
+
+* -m, --month <[YYYY-]MM>:
+	A single month from 01 to 31.
+
+* -y, --year [<YYYY>]:
+	A single year from 01-01 to 12-31.
+
+* -a, --all:
+	Export all.
+
+* --tasks :
+	Export Tasks (default)
+
+* --tracks:
+	Export Tracks
+
+* --csv <path>:
+	Export as CSV file. Use `--csv -` to use STDOUT.
+
+* --force :
+	Force overwrite file.
+
+* -h, --help:
+	Displays the help page.
+
+## EXAMPLES
+
+```
+timr report
+timr report --day 2017-01-02
+timr report --day 2017-01-02 --csv timr_report_20170102.csv
+timr report --day 2017-01-02 --csv timr_report_20170102.csv --tracks
+timr report --month 2017-01 --csv timr_report_201701.csv
+timr report --year 2017 --csv timr_report_2017.csv
+timr report --all --csv timr_report_all.csv
+```
+
+## TASK TABLE COLUMNS
+
+* START:
+	Task Start Date
+
+* END:
+	Task End Date
+
+* DUR:
+	Total Task Duration
+
+* UNB:
+	Unbilled Task Duration
+
+* TASK:
+	Task ID and Name.
+
+## TRACK TABLE COLUMNS
+
+* START:
+	Task Start Date
+
+* END:
+	Task End Date
+
+* DUR:
+	Task Duration
+
+* TASK:
+	Task ID
+
+* TRACK:
+	Track ID and Name.
+
+## TASK CSV COLUMNS
+
+* ROW_NO:
+	Sequential CSV file row number.
+
+* TASK_ID:
+	Task ID
+
+* TASK_FOREIGN_ID:
+	Foreign Task ID
+
+* TASK_NAME:
+	Task Name
+
+* TASK_BEGIN_DATETIME:
+	Begin DateTime of the first Track.
+
+* TASK_END_DATETIME:
+	End DateTime of the last Track.
+
+* TASK_DURATION_HUMAN:
+	Task Duration in human format. See timr-ftime(7).
+
+* TASK_DURATION_SECONDS:
+	Task Duration in seconds.
+
+* TASK_ESTIMATION_HUMAN
+
+* TASK_ESTIMATION_SECONDS
+
+* TASK_REMAINING_TIME_HUMAN
+
+* TASK_REMAINING_TIME_SECONDS
+
+* TASK_BILLED_DURATION_HUMAN:
+	Billed Task Duration in human format. See timr-ftime(7).
+
+* TASK_BILLED_DURATION_SECONDS:
+	Billed Task Duration in seconds.
+
+* TASK_UNBILLED_DURATION_HUMAN:
+	Unbilled Task Duration in human format. See timr-ftime(7).
+
+* TASK_UNBILLED_DURATION_SECONDS:
+	Unbilled Task Duration in seconds.
+
+* TASK_TRACK_COUNT:
+	Task Track count.
+
+* TASK_BILLED_TRACK_COUNT:
+	Task Billed Track count.
+
+* TASK_UNBILLED_TRACK_COUNT:
+	Task Unbilled Track count.
+
+## TRACK CSV COLUMNS
+
+* ROW_NO:
+	Sequential CSV file row number.
+
+* TASK_ID:
+	Task ID
+
+* TASK_NAME:
+	Task Name
+
+* TRACK_ID:
+	Track ID
+
+* TRACK_TITLE:
+	Track Title
+
+* TRACK_BEGIN_DATETIME:
+	Begin DateTime
+
+* TRACK_END_DATETIME:
+	End DateTime
+
+* TRACK_DURATION_HUMAN:
+	Track Duration in human format. See timr-ftime(7).
+
+* TRACK_DURATION_SECONDS:
+	Track Duration in seconds.
+
+* TRACK_BILLED_DURATION_HUMAN:
+	Billed Track Duration in human format. See timr-ftime(7).
+
+* TRACK_BILLED_DURATION_SECONDS:
+	Billed Track Duration in seconds.
+
+* TRACK_UNBILLED_DURATION_HUMAN:
+	Unbilled Track Duration in human format. See timr-ftime(7).
+
+* TRACK_UNBILLED_DURATION_SECONDS:
+	Unbilled Track Duration in seconds.
+
+* TRACK_IS_BILLED
+
+The last row in CSV files is always the total sum.
+
+## API REFERENCE
+
+<https://timr.fox21.at/api/TheFox/Timr/Command/ReportCommand.html>
+
+## SEE ALSO
+
+timr-log(1), timr-ftime(7)

data/man/timr-start.1

@@ -0,0 +1,100 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "TIMR\-START" "1" "April 2017" "FOX21.at" "Timr Manual"
+.
+.SH "NAME"
+\fBtimr\-start\fR \- Start a new Task/Track\.
+.
+.SH "SYNOPSIS"
+timr start [\fIoptions\fR] [\fIid\fR|\fItask_id\fR [\fItrack_id\fR]]
+.
+.SH "DESCRIPTION"
+Always removes all Tracks from the Stack and creates a new Track\. If there is another current running Task this Task will be stopped and removed from the Stack\.
+.
+.P
+Without any options this command always creates a new Task and starts a new Track for this Task\. When providing a Task ID (SHA1 hex) of an existing Task, this Task will be continued\. When also providing a Track ID (SHA1 hex) the same Track message will be taken to create a new Track for the Task\.
+.
+.SH "TASK OPTIONS"
+.
+.TP
+\-\-id \fIstr\fR
+Your ID to identify the Task\. Not just to use the internal Task ID as \fItask_id\fR but also if you like to use your own ID\. For example, when you want to sync Timr with JIRA and use the JIRA IDs to identify Timr Tasks instead of the Timr internal IDs\. This can be any string, but MUST NOT include spaces\. Use this String for \fItask_id\fR\. This ID is also called \'Foreign ID\' by Timr (internal)\.
+.
+.TP
+\-n, \-\-name \fIstr\fR
+The name of the new Task\. When providing a \fItask_id\fR this option will be ignored\.
+.
+.TP
+\-\-description \fIstr\fR
+Longer description of the new Task\. This should descibe the Task in general\. Provide details by using \fB\-\-message\fR option\. When providing a \fItask_id\fR this option will be ignored\.
+.
+.TP
+\-e, \-\-est, \-\-estimation \fItime\fR
+Task Estimation\. See timr\-ftime(7)\.
+.
+.TP
+\-r, \-\-hourly\-rate \fIfloat\fR
+Set the Hourly Rate\.
+.
+.TP
+\-\-fr, \-\-flat\-rate, \-\-flat
+Has Task a Flat Rate?
+.
+.SH "TRACK OPTIONS"
+.
+.TP
+\-m, \-\-message \fImessage\fR
+Details about what you have done\. This overwrites the \fItrack_id\fR argument\.
+.
+.TP
+\-\-edit
+Edit Track Message when providing a \fItrack_id\fR\. The EDITOR environment variable must be set\.
+.
+.TP
+\-d, \-\-date \fIdate\fR
+Track Start Date\. Default: today\. See timr\-ftime(7)\.
+.
+.TP
+\-t, \-\-time \fItime\fR
+Track Start Time\. This is useful when you forgot to run the Start command\. Default: now\. See timr\-ftime(7)\.
+.
+.SH "GENERAL OPTIONS"
+.
+.TP
+\-h, \-\-help
+Displays the help page\.
+.
+.SH "ARGUMENTS"
+\fItask_id\fR \- Task ID as SHA1 hex string\. It can be the full 40 characters or only the first 6\. If not specified a new Task will be created\.
+.
+.P
+\fItrack_id\fR \- Track ID as SHA1 hex string\. It can be the full 40 characters or only the first 6\. If specified a new Track with the same message will be created\.
+.
+.SH "EXAMPLES"
+.
+.nf
+
+timr start
+timr start \-\-name my_task1
+timr start \-\-name \'Model 101\' \e
+    \-\-description \'Construct series 101\.\'
+timr start \-\-name my_task3 \e
+    \-\-date 2017\-01\-02 \-\-time 15:30 \e
+    \-\-message \'Hello World\'
+timr start \-\-name my_task4 \-\-message \'Hello World\'
+timr start \-\-name my_task5 \-\-estimation 2h
+timr start \-\-message \'Hello World\' abcd12
+timr start \-\-time 10:30 \-\-message \'Hello World\' abcd12
+timr start \-\-id T800
+.
+.fi
+.
+.SH "API REFERENCE"
+\fIhttps://timr\.fox21\.at/api/TheFox/Timr/Command/StartCommand\.html\fR
+.
+.SH "SEE ALSO"
+timr\-stop(1), timr\-push(1), timr\-ftime(7)
+.
+.SH "TIMR"
+This is part of timr(1)\.

data/man/timr-start.1.ronn

@@ -0,0 +1,82 @@
+timr-start(1) -- Start a new Task/Track.
+===
+
+## SYNOPSIS
+
+timr start [<options>] [<id>|<task_id> [<track_id>]]
+
+## DESCRIPTION
+
+Always removes all Tracks from the Stack and creates a new Track. If there is another current running Task this Task will be stopped and removed from the Stack.
+
+Without any options this command always creates a new Task and starts a new Track for this Task. When providing a Task ID (SHA1 hex) of an existing Task, this Task will be continued. When also providing a Track ID (SHA1 hex) the same Track message will be taken to create a new Track for the Task.
+
+## TASK OPTIONS
+
+* --id <str>:
+	Your ID to identify the Task. Not just to use the internal Task ID as <task_id> but also if you like to use your own ID. For example, when you want to sync Timr with JIRA and use the JIRA IDs to identify Timr Tasks instead of the Timr internal IDs. This can be any string, but MUST NOT include spaces. Use this String for <task_id>. This ID is also called 'Foreign ID' by Timr (internal).
+
+* -n, --name <str>:
+	The name of the new Task. When providing a <task_id> this option will be ignored.
+
+* --description <str>:
+	Longer description of the new Task. This should descibe the Task in general. Provide details by using `--message` option. When providing a <task_id> this option will be ignored.
+
+* -e, --est, --estimation <time>:
+	Task Estimation. See timr-ftime(7).
+
+* -r, --hourly-rate <float>:
+	Set the Hourly Rate.
+
+* --fr, --flat-rate, --flat:
+	Has Task a Flat Rate?
+
+## TRACK OPTIONS
+
+* -m, --message <message>:
+	Details about what you have done. This overwrites the <track_id> argument.
+
+* --edit:
+	Edit Track Message when providing a <track_id>. The EDITOR environment variable must be set.
+
+* -d, --date <date>:
+	Track Start Date. Default: today. See timr-ftime(7).
+
+* -t, --time <time>:
+	Track Start Time. This is useful when you forgot to run the Start command. Default: now. See timr-ftime(7).
+
+## GENERAL OPTIONS
+
+* -h, --help:
+	Displays the help page.
+
+## ARGUMENTS
+
+<task_id> - Task ID as SHA1 hex string. It can be the full 40 characters or only the first 6. If not specified a new Task will be created.
+
+<track_id> - Track ID as SHA1 hex string. It can be the full 40 characters or only the first 6. If specified a new Track with the same message will be created.
+
+## EXAMPLES
+
+```
+timr start
+timr start --name my_task1
+timr start --name 'Model 101' \
+	--description 'Construct series 101.'
+timr start --name my_task3 \
+	--date 2017-01-02 --time 15:30 \
+	--message 'Hello World'
+timr start --name my_task4 --message 'Hello World'
+timr start --name my_task5 --estimation 2h
+timr start --message 'Hello World' abcd12
+timr start --time 10:30 --message 'Hello World' abcd12
+timr start --id T800
+```
+
+## API REFERENCE
+
+<https://timr.fox21.at/api/TheFox/Timr/Command/StartCommand.html>
+
+## SEE ALSO
+
+timr-stop(1), timr-push(1), timr-ftime(7)

data/man/timr-status.1

@@ -0,0 +1,53 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "TIMR\-STATUS" "1" "April 2017" "FOX21.at" "Timr Manual"
+.
+.SH "NAME"
+\fBtimr\-status\fR \- Show the current Stack\.
+.
+.SH "SYNOPSIS"
+timr status [\fIoptions\fR]
+.
+.SH "DESCRIPTION"
+Displays the Stack as a list and the status of each Track\.
+.
+.P
+To see more details about a specific Task see timr\-task(1), or a specific Track timr\-track(1)\.
+.
+.SH "OPTIONS"
+.
+.TP
+\-v, \-\-verbose
+Show more columns in table view\.
+.
+.TP
+\-f, \-\-full
+Show full status\.
+.
+.TP
+\-r, \-\-reverse
+Reverse the list\.
+.
+.TP
+\-h, \-\-help
+Displays the help page\.
+.
+.SH "EXAMPLES"
+.
+.nf
+
+timr status
+timr status \-\-full
+timr status \-\-full \-\-reverse
+.
+.fi
+.
+.SH "API REFERENCE"
+\fIhttps://timr\.fox21\.at/api/TheFox/Timr/Command/StatusCommand\.html\fR
+.
+.SH "SEE ALSO"
+timr\-task(1), timr\-track(1)
+.
+.SH "TIMR"
+This is part of timr(1)\.

data/man/timr-status.1.ronn

@@ -0,0 +1,42 @@
+timr-status(1) -- Show the current Stack.
+===
+
+## SYNOPSIS
+
+timr status [<options>]
+
+## DESCRIPTION
+
+Displays the Stack as a list and the status of each Track.
+
+To see more details about a specific Task see timr-task(1), or a specific Track timr-track(1).
+
+## OPTIONS
+
+* -v, --verbose:
+	Show more columns in table view.
+
+* -f, --full:
+	Show full status.
+
+* -r, --reverse:
+	Reverse the list.
+
+* -h, --help:
+	Displays the help page.
+
+## EXAMPLES
+
+```
+timr status
+timr status --full
+timr status --full --reverse
+```
+
+## API REFERENCE
+
+<https://timr.fox21.at/api/TheFox/Timr/Command/StatusCommand.html>
+
+## SEE ALSO
+
+timr-task(1), timr-track(1)