timr 0.3.0 → 0.4.0

data/man/timr-stop.1

@@ -0,0 +1,75 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "TIMR\-STOP" "1" "April 2017" "FOX21.at" "Timr Manual"
+.
+.SH "NAME"
+\fBtimr\-stop\fR \- Stop the current running Track\.
+.
+.SH "SYNOPSIS"
+timr stop [\fIoptions\fR]
+.
+.SH "DESCRIPTION"
+Stopps the current running Track and removes it from the Stack\. When more then one Track is on the Stack the left Tracks will not be touched\.
+.
+.SH "TRACK OPTIONS"
+.
+.TP
+\-m, \-\-message \fImessage\fR
+Details about what you have done\. This overwrites the message set on \fBtimr start\fR\. Use \fB\-\-edit\fR option to edit the Start Track message\.
+.
+.TP
+\-\-edit
+Edit Track Message\. The EDITOR environment variable must be set\.
+.
+.TP
+\-\-sd, \-\-start\-date \fIdate\fR
+Overwrite the Start date\. See timr\-ftime(7)\.
+.
+.TP
+\-\-st, \-\-start\-time \fItime\fR
+Overwrite the Start time\. See timr\-ftime(7)\.
+.
+.TP
+\-\-ed, \-\-end\-date \fIdate\fR
+End Date\. Default: today\. See timr\-ftime(7)\.
+.
+.TP
+\-\-et, \-\-end\-time \fItime\fR
+End Time\. This is useful when you forgot to run the Stop command\. Default: now\. 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 stop
+timr stop \-\-message \'Hello World\'
+timr stop \-\-edit
+timr stop \-\-time 17:00 \-\-message \'Hello World\'
+timr stop \-\-start\-time 10:00 \-\-time 17:00 \e
+    \-\-message \'Hello World\'
+.
+.fi
+.
+.SH "API REFERENCE"
+\fIhttps://timr\.fox21\.at/api/TheFox/Timr/Command/StopCommand\.html\fR
+.
+.SH "SEE ALSO"
+timr\-start(1), timr\-pop(1), timr\-ftime(7)
+.
+.SH "TIMR"
+This is part of timr(1)\.

data/man/timr-stop.1.ronn

@@ -0,0 +1,60 @@
+timr-stop(1) -- Stop the current running Track.
+===
+
+## SYNOPSIS
+
+timr stop [<options>]
+
+## DESCRIPTION
+
+Stopps the current running Track and removes it from the Stack. When more then one Track is on the Stack the left Tracks will not be touched.
+
+## TRACK OPTIONS
+
+* -m, --message <message>:
+	Details about what you have done. This overwrites the message set on `timr start`. Use `--edit` option to edit the Start Track message.
+
+* --edit:
+	Edit Track Message. The EDITOR environment variable must be set.
+
+* --sd, --start-date <date>:
+	Overwrite the Start date. See timr-ftime(7).
+
+* --st, --start-time <time>:
+	Overwrite the Start time. See timr-ftime(7).
+
+* --ed, --end-date <date>:
+	End Date. Default: today. See timr-ftime(7).
+
+* --et, --end-time <time>:
+	End Time. This is useful when you forgot to run the Stop command. Default: now. 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 stop
+timr stop --message 'Hello World'
+timr stop --edit
+timr stop --time 17:00 --message 'Hello World'
+timr stop --start-time 10:00 --time 17:00 \
+	--message 'Hello World'
+```
+
+## API REFERENCE
+
+<https://timr.fox21.at/api/TheFox/Timr/Command/StopCommand.html>
+
+## SEE ALSO
+
+timr-start(1), timr-pop(1), timr-ftime(7)

data/man/timr-task.1

@@ -0,0 +1,147 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "TIMR\-TASK" "1" "April 2017" "FOX21.at" "Timr Manual"
+.
+.SH "NAME"
+\fBtimr\-task\fR \- Show, add, edit, or remove a Task\.
+.
+.SH "SYNOPSIS"
+timr task [show] [\fIoptions\fR] [\fIid\fR|\fItask_id\fR\.\.\.]
+.
+.P
+timr task add [\fIoptions\fR]
+.
+.P
+timr task set [\fIoptions\fR] \fIid\fR|\fItask_id\fR
+.
+.P
+timr task remove \fIid\fR|\fItask_id\fR\.\.\.
+.
+.SH "DESCRIPTION"
+This command takes several subcommands\. Per default, when providing a Task ID it displays details about this specific Task\. Without any arguments it lists all Tasks\.
+.
+.SH "SUBCOMMANDS"
+.
+.TP
+add
+Add a new Task\.
+.
+.TP
+set
+Edit an existing Task\.
+.
+.TP
+show
+Default when not providing a specific subcommand\.
+.
+.TP
+remove
+Delete a Task, all informations about this Task and all including Tracks\. This cannot be undone\.
+.
+.SH "ADD/SET 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 \fIname\fR
+Task Name\.
+.
+.TP
+\-\-desc, \-\-description \fIstr\fR
+Task Description\.
+.
+.TP
+\-e, \-\-est, \-\-estimation \fItime\fR
+Task Estimation\. See timr\-ftime(7)\.
+.
+.TP
+\-b, \-\-billed
+Mark Task as billed\.
+.
+.TP
+\-\-unbilled
+Mark Task as unbilled\.
+.
+.TP
+\-r, \-\-hourly\-rate \fIfloat\fR
+Set the Hourly Rate\.
+.
+.TP
+\-\-no\-hourly\-rate
+Unset Hourly Rate\.
+.
+.TP
+\-\-fr, \-\-flat\-rate, \-\-flat
+Has Task a Flat Rate?
+.
+.TP
+\-\-no\-flat\-rate, \-\-no\-flat
+Unset Flat Rate\.
+.
+.SH "SHOW OPTIONS"
+.
+.TP
+\-t, \-\-tracks
+Show a list of Track IDs for each Task\.
+.
+.SH "GENERAL OPTIONS"
+.
+.TP
+\-h, \-\-help
+Displays the help page\.
+.
+.SH "EXAMPLES"
+.
+.nf
+
+timr task
+timr task abcd12
+timr task show abcd12
+timr task set \-\-name \'task_x\' \-\-estimation \'2h 30m\'
+timr task set \-\-billed \-\-hourly\-rate 50 \-\-flat\-rate abcd12
+timr task set \-\-unbilled \-\-no\-hourly\-rate \-\-no\-flat\-rate abcd12
+timr task add \-\-name \'task_z\' \-\-estimation 4h \e
+    \-\-hourly\-rate 50 \-\-flat\-rate
+timr task add \-\-id T800 \-\-name \'Model 101\'
+timr task remove T800
+timr task remove abcd12
+.
+.fi
+.
+.SH "FOREIGN ID EXAMPLE"
+.
+.nf
+
+timr task add \-\-id t800 \-\-name Terminator1
+timr task set \-\-name Terminator2 t800
+timr task remove t800
+.
+.fi
+.
+.SH "MAN UNITS"
+.
+.IP "\(bu" 4
+8 hours are 1 man\-day\.
+.
+.IP "\(bu" 4
+5 man\-days are 1 man\-week, and so on\.
+.
+.IP "" 0
+.
+.SH "BILLED/UNBILLED"
+Set a Task as \fBbilled\fR or \fBunbilled\fR to know which Task you already billed a client\.
+.
+.P
+If a whole Task gets billed/unbilled all Tracks are changed to billed/unbilled\. Each Track has a flag \fBis_billed\fR\.
+.
+.SH "API REFERENCE"
+\fIhttps://timr\.fox21\.at/api/TheFox/Timr/Command/TaskCommand\.html\fR
+.
+.SH "SEE ALSO"
+timr\-track(1), timr\-ftime(7)
+.
+.SH "TIMR"
+This is part of timr(1)\.

data/man/timr-task.1.ronn

@@ -0,0 +1,115 @@
+timr-task(1) -- Show, add, edit, or remove a Task.
+===
+
+## SYNOPSIS
+
+timr task [show] [<options>] [<id>|<task_id>...]
+
+timr task add [<options>]
+
+timr task set [<options>] <id>|<task_id>
+
+timr task remove <id>|<task_id>...
+
+## DESCRIPTION
+
+This command takes several subcommands. Per default, when providing a Task ID it displays details about this specific Task. Without any arguments it lists all Tasks.
+
+## SUBCOMMANDS
+
+* add:
+	Add a new Task.
+
+* set:
+	Edit an existing Task.
+
+* show:
+	Default when not providing a specific subcommand.
+
+* remove:
+	Delete a Task, all informations about this Task and all including Tracks. This cannot be undone.
+
+## ADD/SET 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 <name>:
+	Task Name.
+
+* --desc, --description <str>:
+	Task Description.
+
+* -e, --est, --estimation <time>:
+	Task Estimation. See timr-ftime(7).
+
+* -b, --billed:
+	Mark Task as billed.
+
+* --unbilled:
+	Mark Task as unbilled.
+
+* -r, --hourly-rate <float>:
+	Set the Hourly Rate.
+
+* --no-hourly-rate:
+	Unset Hourly Rate.
+
+* --fr, --flat-rate, --flat:
+	Has Task a Flat Rate?
+
+* --no-flat-rate, --no-flat:
+	Unset Flat Rate.
+
+## SHOW OPTIONS
+
+* -t, --tracks:
+	Show a list of Track IDs for each Task.
+
+## GENERAL OPTIONS
+
+* -h, --help:
+	Displays the help page.
+
+## EXAMPLES
+
+```
+timr task
+timr task abcd12
+timr task show abcd12
+timr task set --name 'task_x' --estimation '2h 30m'
+timr task set --billed --hourly-rate 50 --flat-rate abcd12
+timr task set --unbilled --no-hourly-rate --no-flat-rate abcd12
+timr task add --name 'task_z' --estimation 4h \
+	--hourly-rate 50 --flat-rate
+timr task add --id T800 --name 'Model 101'
+timr task remove T800
+timr task remove abcd12
+```
+
+## FOREIGN ID EXAMPLE
+
+```
+timr task add --id t800 --name Terminator1
+timr task set --name Terminator2 t800
+timr task remove t800
+```
+
+## MAN UNITS
+
+- 8 hours are 1 man-day.
+- 5 man-days are 1 man-week, and so on.
+
+## BILLED/UNBILLED
+
+Set a Task as `billed` or `unbilled` to know which Task you already billed a client.
+
+If a whole Task gets billed/unbilled all Tracks are changed to billed/unbilled. Each Track has a flag `is_billed`.
+
+## API REFERENCE
+
+<https://timr.fox21.at/api/TheFox/Timr/Command/TaskCommand.html>
+
+## SEE ALSO
+
+timr-track(1), timr-ftime(7)

data/man/timr-track.1

@@ -0,0 +1,109 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "TIMR\-TRACK" "1" "April 2017" "FOX21.at" "Timr Manual"
+.
+.SH "NAME"
+\fBtimr\-track\fR \- Show, add, edit, move, or remove a Track\.
+.
+.SH "SYNOPSIS"
+timr track [show] [\fIoptions\fR] \fItrack_id\fR\.\.\.
+.
+.P
+timr track add [\fIoptions\fR]
+.
+.P
+timr track set [\fIoptions\fR] \fItrack_id\fR
+.
+.P
+timr track remove \fItrack_id\fR\.\.\.
+.
+.SH "DESCRIPTION"
+This command takes several subcommands\. Per default, when providing a Track ID it displays details about this specific Track\.
+.
+.SH "SUBCOMMANDS"
+.
+.TP
+add
+Add a new Track\.
+.
+.TP
+set
+Edit an existing Track\. To move a Track to another Task see \fB\-\-task\fR option in section SET OPTIONS\.
+.
+.TP
+show
+Default when not providing a specific subcommand\.
+.
+.TP
+remove
+Delete a Track and all informations about this Track\. This cannot be undone\.
+.
+.SH "ADD/SET OPTIONS"
+.
+.TP
+\-m, \-\-message \fImessage\fR
+Track Message\. Details about what you have done\.
+.
+.TP
+\-\-sd, \-\-start\-date \fIdate\fR
+Start Date\. See timr\-ftime(7)\.
+.
+.TP
+\-\-st, \-\-start\-time \fItime\fR
+Start Time\. See timr\-ftime(7)\.
+.
+.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
+\-b, \-\-billed
+Mark Track as billed\.
+.
+.TP
+\-\-unbilled
+Mark Track as unbilled\.
+.
+.SH "SET OPTIONS"
+\-\-task \fItask_id\fR: Move Track to another Task\. \fItask_id\fR can also be a Foreign ID\. See timr\-task(1)\.
+.
+.SH "SHOW OPTIONS"
+.
+.TP
+\-t, \-\-task
+Show Task of Track\. Same as \fBtimr task <task_id>\fR\.
+.
+.SH "GENERAL OPTIONS"
+.
+.TP
+\-h, \-\-help
+Displays the help page\.
+.
+.SH "EXAMPLES"
+.
+.nf
+
+timr track abcd12
+timr track show abcd12
+timr track set \-\-start\-date 2017\-01\-01 \-\-start\-time 10:00 \e
+    \-\-end\-date 2017\-01\-02 \-\-end\-time 15:30 abcd12
+timr track set \-\-track xyz345 abcd12
+timr track add \-\-start\-date 2017\-01\-02 \-\-start\-time 16:00 \e
+    \-\-end\-date 2017\-01\-02 \-\-end\-time 17:00 xyz345
+timr track remove abcd12
+.
+.fi
+.
+.SH "API REFERENCE"
+\fIhttps://timr\.fox21\.at/api/TheFox/Timr/Command/TrackCommand\.html\fR
+.
+.SH "SEE ALSO"
+timr\-task(1), timr\-ftime(7)
+.
+.SH "TIMR"
+This is part of timr(1)\.