timr 0.3.0 → 0.4.0

data/man/timr-pause.1

@@ -0,0 +1,56 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "TIMR\-PAUSE" "1" "April 2017" "FOX21.at" "Timr Manual"
+.
+.SH "NAME"
+\fBtimr\-pause\fR \- Pause the current running Track\.
+.
+.SH "SYNOPSIS"
+timr pause [\fIoptions\fR]
+.
+.SH "DESCRIPTION"
+Pause the current running Track\. To continue the current Track (Top Track) run \fBtimr continue\fR\. See also timr\-continue(1)\.
+.
+.SH "TRACK OPTIONS"
+.
+.TP
+\-\-ed, \-\-end\-date \fIdate\fR
+End Date\. See timr\-ftime(7)\.
+.
+.TP
+\-\-et, \-\-end\-time \fItime\fR
+End Time\. See timr\-ftime(7)\.
+.
+.TP
+\-d, \-\-date \fIdate\fR
+\-\-end\-date alias\.
+.
+.TP
+\-t, \-\-time \fItime\fR
+\-\-end\-time alias\.
+.
+.SH "GENERAL OPTIONS"
+.
+.TP
+\-h, \-\-help
+Displays the help page\.
+.
+.SH "EXAMPLES"
+.
+.nf
+
+timr pause
+timr pause \-\-time 10:30
+timr pause \-\-date 2017\-01\-02 \-\-time 10:30
+.
+.fi
+.
+.SH "API REFERENCE"
+\fIhttps://timr\.fox21\.at/api/TheFox/Timr/Command/PauseCommand\.html\fR
+.
+.SH "SEE ALSO"
+timr\-continue(1), timr\-ftime(7)
+.
+.SH "TIMR"
+This is part of timr(1)\.

data/man/timr-pause.1.ronn

@@ -0,0 +1,45 @@
+timr-pause(1) -- Pause the current running Track.
+===
+
+## SYNOPSIS
+
+timr pause [<options>]
+
+## DESCRIPTION
+
+Pause the current running Track. To continue the current Track (Top Track) run `timr continue`. See also timr-continue(1).
+
+## TRACK OPTIONS
+
+* --ed, --end-date <date>:
+	End Date. See timr-ftime(7).
+
+* --et, --end-time <time>:
+	End Time. See timr-ftime(7).
+
+* -d, --date <date>:
+	--end-date alias.
+
+* -t, --time <time>:
+	--end-time alias.
+
+## GENERAL OPTIONS
+
+* -h, --help:
+	Displays the help page.
+
+## EXAMPLES
+
+```
+timr pause
+timr pause --time 10:30
+timr pause --date 2017-01-02 --time 10:30
+```
+
+## API REFERENCE
+
+<https://timr.fox21.at/api/TheFox/Timr/Command/PauseCommand.html>
+
+## SEE ALSO
+
+timr-continue(1), timr-ftime(7)

data/man/timr-pop.1

@@ -0,0 +1,66 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "TIMR\-POP" "1" "April 2017" "FOX21.at" "Timr Manual"
+.
+.SH "NAME"
+\fBtimr\-pop\fR \- Pop current Track from the Stack\.
+.
+.SH "SYNOPSIS"
+timr pop [\fIoptions\fR]
+.
+.SH "DESCRIPTION"
+Stop and pop the current running Track from the Stack\. Also \fBtimr stop\fR removes the current Track from the Stack\.
+.
+.SH "TRACK OPTIONS"
+.
+.TP
+\-\-sd, \-\-start\-date \fIdate\fR
+Start Date for the next underlying Track (continue)\. See timr\-ftime(7)\.
+.
+.TP
+\-\-st, \-\-start\-time \fItime\fR
+Start Time for the next underlying Track (continue)\. See timr\-ftime(7)\.
+.
+.TP
+\-\-ed, \-\-end\-date \fIdate\fR
+End Date for the current running Track (pop)\. See timr\-ftime(7)\.
+.
+.TP
+\-\-et, \-\-end\-time \fItime\fR
+End Time for the current running Track (pop)\. See timr\-ftime(7)\.
+.
+.TP
+\-d, \-\-date \fIdate\fR
+Alias for \fB\-\-end\-date <date> \-\-start\-date <date>\fR\.
+.
+.TP
+\-t, \-\-time \fItime\fR
+Alias for \fB\-\-end\-time <time> \-\-start\-time <time>\fR\.
+.
+.SH "GENERAL OPTIONS"
+.
+.TP
+\-h, \-\-help
+Displays the help page\.
+.
+.SH "EXAMPLES"
+.
+.nf
+
+timr pop
+timr pop \-\-time 11:00
+timr pop \-\-date 2017\-01\-02 \-\-time 11:00
+timr pop \-\-end\-date 2017\-01\-02 \-\-end\-time 17:00 \e
+    \-\-start\-date 2017\-01\-03 \-\-start\-time 10:00
+.
+.fi
+.
+.SH "API REFERENCE"
+\fIhttps://timr\.fox21\.at/api/TheFox/Timr/Command/PopCommand\.html\fR
+.
+.SH "SEE ALSO"
+timr\-push(1), timr\-stop(1), timr\-ftime(7)
+.
+.SH "TIMR"
+This is part of timr(1)\.

data/man/timr-pop.1.ronn

@@ -0,0 +1,53 @@
+timr-pop(1) -- Pop current Track from the Stack.
+===
+
+## SYNOPSIS
+
+timr pop [<options>]
+
+## DESCRIPTION
+
+Stop and pop the current running Track from the Stack. Also `timr stop` removes the current Track from the Stack.
+
+## TRACK OPTIONS
+
+* --sd, --start-date <date>:
+	Start Date for the next underlying Track (continue). See timr-ftime(7).
+
+* --st, --start-time <time>:
+	Start Time for the next underlying Track (continue). See timr-ftime(7).
+
+* --ed, --end-date <date>:
+	End Date for the current running Track (pop). See timr-ftime(7).
+
+* --et, --end-time <time>:
+	End Time for the current running Track (pop). See timr-ftime(7).
+
+* -d, --date <date>:
+	Alias for `--end-date <date> --start-date <date>`.
+
+* -t, --time <time>:
+	Alias for `--end-time <time> --start-time <time>`.
+
+## GENERAL OPTIONS
+
+* -h, --help:
+	Displays the help page.
+
+## EXAMPLES
+
+```
+timr pop
+timr pop --time 11:00
+timr pop --date 2017-01-02 --time 11:00
+timr pop --end-date 2017-01-02 --end-time 17:00 \
+	--start-date 2017-01-03 --start-time 10:00
+```
+
+## API REFERENCE
+
+<https://timr.fox21.at/api/TheFox/Timr/Command/PopCommand.html>
+
+## SEE ALSO
+
+timr-push(1), timr-stop(1), timr-ftime(7)

data/man/timr-push.1

@@ -0,0 +1,25 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "TIMR\-PUSH" "1" "April 2017" "FOX21.at" "Timr Manual"
+.
+.SH "NAME"
+\fBtimr\-push\fR \- Push new Track to the Stack\.
+.
+.SH "SYNOPSIS"
+timr push [\fIoptions\fR] [\fIid\fR|\fItask_id\fR [\fItrack_id\fR]]
+.
+.SH "DESCRIPTION"
+Sometimes you need to work on a Task only temporary\. You want to track the time for this as well\. For example fixing a bug\. When you fixed the bug you want to continue your actual work\. Here comes \fBtimr push\fR and timr\-pop(1) into the game\. It modifies the Stack\. When you push a new Track the below Track will be paused and hold on the Stack\. On pop the current Track (Top Track) will be stopped and the next below will continue\.
+.
+.P
+Options and Arguments are the same as for timr\-start(1)\.
+.
+.SH "API REFERENCE"
+\fIhttps://timr\.fox21\.at/api/TheFox/Timr/Command/PushCommand\.html\fR
+.
+.SH "SEE ALSO"
+timr\-pop(1), timr\-start(1), timr\-stop(1)
+.
+.SH "TIMR"
+This is part of timr(1)\.

data/man/timr-push.1.ronn

@@ -0,0 +1,20 @@
+timr-push(1) -- Push new Track to the Stack.
+===
+
+## SYNOPSIS
+
+timr push [<options>] [<id>|<task_id> [<track_id>]]
+
+## DESCRIPTION
+
+Sometimes you need to work on a Task only temporary. You want to track the time for this as well. For example fixing a bug. When you fixed the bug you want to continue your actual work. Here comes `timr push` and timr-pop(1) into the game. It modifies the Stack. When you push a new Track the below Track will be paused and hold on the Stack. On pop the current Track (Top Track) will be stopped and the next below will continue.
+
+Options and Arguments are the same as for timr-start(1).
+
+## API REFERENCE
+
+<https://timr.fox21.at/api/TheFox/Timr/Command/PushCommand.html>
+
+## SEE ALSO
+
+timr-pop(1), timr-start(1), timr-stop(1)

data/man/timr-report.1

@@ -0,0 +1,228 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "TIMR\-REPORT" "1" "April 2017" "FOX21.at" "Timr Manual"
+.
+.SH "NAME"
+\fBtimr\-report\fR \- Export Tasks and Tracks\.
+.
+.SH "SYNOPSIS"
+timr report [\fIoptions\fR]
+.
+.SH "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\.
+.
+.SH "OPTIONS"
+.
+.TP
+\-d, \-\-day \fIdate\fR
+A single day from 00:00 to 23:59\. See timr\-ftime(7)\.
+.
+.TP
+\-m, \-\-month \fI[YYYY\-]MM\fR
+A single month from 01 to 31\.
+.
+.TP
+\-y, \-\-year [\fIYYYY\fR]
+A single year from 01\-01 to 12\-31\.
+.
+.TP
+\-a, \-\-all
+Export all\.
+.
+.TP
+\-\-tasks
+Export Tasks (default)
+.
+.TP
+\-\-tracks
+Export Tracks
+.
+.TP
+\-\-csv \fIpath\fR
+Export as CSV file\. Use \fB\-\-csv \-\fR to use STDOUT\.
+.
+.TP
+\-\-force
+Force overwrite file\.
+.
+.TP
+\-h, \-\-help
+Displays the help page\.
+.
+.SH "EXAMPLES"
+.
+.nf
+
+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
+.
+.fi
+.
+.SH "TASK TABLE COLUMNS"
+.
+.TP
+START
+Task Start Date
+.
+.TP
+END
+Task End Date
+.
+.TP
+DUR
+Total Task Duration
+.
+.TP
+UNB
+Unbilled Task Duration
+.
+.TP
+TASK
+Task ID and Name\.
+.
+.SH "TRACK TABLE COLUMNS"
+.
+.TP
+START
+Task Start Date
+.
+.TP
+END
+Task End Date
+.
+.TP
+DUR
+Task Duration
+.
+.TP
+TASK
+Task ID
+.
+.TP
+TRACK
+Track ID and Name\.
+.
+.SH "TASK CSV COLUMNS"
+.
+.IP "\(bu" 4
+ROW_NO: Sequential CSV file row number\.
+.
+.IP "\(bu" 4
+TASK_ID: Task ID
+.
+.IP "\(bu" 4
+TASK_FOREIGN_ID: Foreign Task ID
+.
+.IP "\(bu" 4
+TASK_NAME: Task Name
+.
+.IP "\(bu" 4
+TASK_BEGIN_DATETIME: Begin DateTime of the first Track\.
+.
+.IP "\(bu" 4
+TASK_END_DATETIME: End DateTime of the last Track\.
+.
+.IP "\(bu" 4
+TASK_DURATION_HUMAN: Task Duration in human format\. See timr\-ftime(7)\.
+.
+.IP "\(bu" 4
+TASK_DURATION_SECONDS: Task Duration in seconds\.
+.
+.IP "\(bu" 4
+TASK_ESTIMATION_HUMAN
+.
+.IP "\(bu" 4
+TASK_ESTIMATION_SECONDS
+.
+.IP "\(bu" 4
+TASK_REMAINING_TIME_HUMAN
+.
+.IP "\(bu" 4
+TASK_REMAINING_TIME_SECONDS
+.
+.IP "\(bu" 4
+TASK_BILLED_DURATION_HUMAN: Billed Task Duration in human format\. See timr\-ftime(7)\.
+.
+.IP "\(bu" 4
+TASK_BILLED_DURATION_SECONDS: Billed Task Duration in seconds\.
+.
+.IP "\(bu" 4
+TASK_UNBILLED_DURATION_HUMAN: Unbilled Task Duration in human format\. See timr\-ftime(7)\.
+.
+.IP "\(bu" 4
+TASK_UNBILLED_DURATION_SECONDS: Unbilled Task Duration in seconds\.
+.
+.IP "\(bu" 4
+TASK_TRACK_COUNT: Task Track count\.
+.
+.IP "\(bu" 4
+TASK_BILLED_TRACK_COUNT: Task Billed Track count\.
+.
+.IP "\(bu" 4
+TASK_UNBILLED_TRACK_COUNT: Task Unbilled Track count\.
+.
+.IP "" 0
+.
+.SH "TRACK CSV COLUMNS"
+.
+.IP "\(bu" 4
+ROW_NO: Sequential CSV file row number\.
+.
+.IP "\(bu" 4
+TASK_ID: Task ID
+.
+.IP "\(bu" 4
+TASK_NAME: Task Name
+.
+.IP "\(bu" 4
+TRACK_ID: Track ID
+.
+.IP "\(bu" 4
+TRACK_TITLE: Track Title
+.
+.IP "\(bu" 4
+TRACK_BEGIN_DATETIME: Begin DateTime
+.
+.IP "\(bu" 4
+TRACK_END_DATETIME: End DateTime
+.
+.IP "\(bu" 4
+TRACK_DURATION_HUMAN: Track Duration in human format\. See timr\-ftime(7)\.
+.
+.IP "\(bu" 4
+TRACK_DURATION_SECONDS: Track Duration in seconds\.
+.
+.IP "\(bu" 4
+TRACK_BILLED_DURATION_HUMAN: Billed Track Duration in human format\. See timr\-ftime(7)\.
+.
+.IP "\(bu" 4
+TRACK_BILLED_DURATION_SECONDS: Billed Track Duration in seconds\.
+.
+.IP "\(bu" 4
+TRACK_UNBILLED_DURATION_HUMAN: Unbilled Track Duration in human format\. See timr\-ftime(7)\.
+.
+.IP "\(bu" 4
+TRACK_UNBILLED_DURATION_SECONDS: Unbilled Track Duration in seconds\.
+.
+.IP "\(bu" 4
+TRACK_IS_BILLED
+.
+.IP "" 0
+.
+.P
+The last row in CSV files is always the total sum\.
+.
+.SH "API REFERENCE"
+\fIhttps://timr\.fox21\.at/api/TheFox/Timr/Command/ReportCommand\.html\fR
+.
+.SH "SEE ALSO"
+timr\-log(1), timr\-ftime(7)
+.
+.SH "TIMR"
+This is part of timr(1)\.