File ctt.1 of Package ctt - j0ke.net Open Build Service

File ctt.1 of Package ctt (Revision 7f1f6e306a09cebd6e99645d1fa5d0fd)

Currently displaying revision 7f1f6e306a09cebd6e99645d1fa5d0fd, show latest

.\"     Title: ctt
.\"    Author: Nico Schottelius <nico-ctt--@--schottelius.org>
.\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
.\"      Date: 05/01/2013
.\"    Manual: \ \&
.\"    Source: \ \&
.\"  Language: English
.\"
.TH "CTT" "1" "05/01/2013" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * (re)Define some macros
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" toupper - uppercase a string (locale-aware)
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.de toupper
.tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
\\$*
.tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
..
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" SH-xref - format a cross-reference to an SH section
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.de SH-xref
.ie n \{\
.\}
.toupper \\$*
.el \{\
\\$*
.\}
..
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" SH - level-one heading that works better for non-TTY output
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.de1 SH
.\" put an extra blank line of space above the head in non-TTY output
.if t \{\
.sp 1
.\}
.sp \\n[PD]u
.nr an-level 1
.set-an-margin
.nr an-prevailing-indent \\n[IN]
.fi
.in \\n[an-margin]u
.ti 0
.HTML-TAG ".NH \\n[an-level]"
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
\." make the size of the head bigger
.ps +3
.ft B
.ne (2v + 1u)
.ie n \{\
.\" if n (TTY output), use uppercase
.toupper \\$*
.\}
.el \{\
.nr an-break-flag 0
.\" if not n (not TTY), use normal case (not uppercase)
\\$1
.in \\n[an-margin]u
.ti 0
.\" if not n (not TTY), put a border/line under subheading
.sp -.6
\l'\n(.lu'
.\}
..
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" SS - level-two heading that works better for non-TTY output
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.de1 SS
.sp \\n[PD]u
.nr an-level 1
.set-an-margin
.nr an-prevailing-indent \\n[IN]
.fi
.in \\n[IN]u
.ti \\n[SN]u
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.ps \\n[PS-SS]u
\." make the size of the head bigger
.ps +2
.ft B
.ne (2v + 1u)
.if \\n[.$] \&\\$*
..
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" BB/BE - put background/screen (filled box) around block of text
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.de BB
.if t \{\
.sp -.5
.br
.in +2n
.ll -2n
.gcolor red
.di BX
.\}
..
.de EB
.if t \{\
.if "\\$2"adjust-for-leading-newline" \{\
.sp -1
.\}
.br
.di
.in
.ll
.gcolor
.nr BW \\n(.lu-\\n(.i
.nr BH \\n(dn+.5v
.ne \\n(BHu+.5v
.ie "\\$2"adjust-for-leading-newline" \{\
\M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
.\}
.el \{\
\M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
.\}
.in 0
.sp -.5v
.nf
.BX
.in
.sp .5v
.fi
.\}
..
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" BM/EM - put colored marker in margin next to block of text
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.de BM
.if t \{\
.br
.ll -2n
.gcolor red
.di BX
.\}
..
.de EM
.if t \{\
.br
.di
.ll
.gcolor
.nr BH \\n(dn
.ne \\n(BHu
\M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
.in 0
.nf
.BX
.in
.fi
.\}
..
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "Name"
ctt \- time tracking for geeks
.SH "Synopsis"
.sp
ctt [\-h] [\-d] [\-v] {listprojects,track,report} \&...
.sp
ctt listprojects [\-h] [\-d] [\-v]
.sp
ctt track [\-h] [\-d] [\-v] [\-s START] [\-e END] [\-n] project
.sp
ctt report [\-h] [\-d] [\-v] [\-\-sd START] [\-\-ed END] [\-e REGEXP] [\-i] [\-f OUTPUT_FORMAT] project
.SH "DESCRIPTION"
.sp
ctt tracks time while you are working and stores the values in a cconfig database\&.
.SH "GENERAL OPTIONS"
.sp
The following parameters are available to all subcommands:
.PP
\-h, \-\-help
.RS 4
show this help message and exit
.RE
.PP
\-d, \-\-debug
.RS 4
set log level to debug
.RE
.PP
\-v, \-\-verbose
.RS 4
set log level to info, be more verbose
.RE
.SH "TRACK"
.sp
Tracking is started by using the \fBtrack\fR subcommand\&. It requires the project name to track time for\&.
.sp
Without any options it stays in the foreground and waits until enter is pressed and then prompts for a comment\&.
.sp
Available parameters:
.PP
\-\-sd START, \-\-start START
.RS 4
start date (default: first of this month, format: Y\-m\-d)
.RE
.PP
\-\-ed END, \-\-end END
.RS 4
end date (default: last of this month, format: Y\-m\-d)
.RE
.PP
\-n, \-\-no\-comment
.RS 4
disable comment prompting after tracking
.RE
.SH "REPORT"
.sp
Reporting is handled by the \fBreport\fR subcommand\&. It requires the project name to report time for\&. It supports to filter entries using regular expressions and also allows to use a custom output format\&.
.sp
Available parameters:
.PP
\-\-sd START, \-\-start START
.RS 4
start date (default: first of this month, format: Y\-m\-d)
.RE
.PP
\-\-ed END, \-\-end END
.RS 4
end date (default: last of this month, format: Y\-m\-d)
.RE
.PP
\-e REGEXP, \-\-regexp REGEXP
.RS 4
regular expression to match
.RE
.PP
\-i, \-\-ignore\-case
.RS 4
ignore case distinctions
.RE
.PP
\-f OUTPUT_FORMAT, \-\-format OUTPUT_FORMAT
.RS 4
.RE
.sp
Output format may reference the following fields:
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
start_datetime
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
end_datetime
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
delta
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
delta_seconds
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
delta_minutes
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
comment
.RE
.SH "LISTPROJECTS"
.sp
The \fBlistprojects\fR subcommand is used to list used projects\&. It does not expect any parameters\&.
.SH "EXAMPLES"
.sp
.if n \{\
.RS 4
.\}
.fam C
.ps -1
.nf
.BB lightgray
# Track some time
% ctt track test
Comment: Did some cool work

# Track for a given time range
% ctt track \-\-sd 2013\-04\-29\-1000 \-\-ed 2013\-05\-29\-1200 test
Comment: Long working period

# Track (keep running), but specify different start date
% ctt track \-\-sd 2013\-04\-29\-0800  test
Comment: Started early today

# Track without prompting for a comment
% ctt track \-n test

# List available projects
% ctt listprojects
[\&.\&.\&.]

# List all entries of this month for project test
% ctt report test
[\&.\&.\&.]

# List all entries from January
% ctt report \-\-sd 2013\-01\-01 \-\-ed 2013\-01\-31 test

# List all entries from January matching either rails ruby or cdist
% ctt report \-\-sd 2013\-01\-29 \-\-ed 2013\-04\-29 \-e "(rails|ruby|cdist)" test

# The same, but case insensitive
% ctt report \-\-sd 2013\-01\-29 \-\-ed 2013\-04\-29 \-e "(rails|ruby|cdist)" \-i test
.EB lightgray
.fi
.fam
.ps +1
.if n \{\
.RE
.\}
.SH "BUGS"
.sp
ctt is made for geeks, so it should not stand in your way\&. If it does, raise a bug\&.
.SH "SEE ALSO"
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
cconfig homepage:
http://www\&.nico\&.schottelius\&.org/docs/cconfig/
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
ctt homepage:
http://www\&.nico\&.schottelius\&.org/software/ctt/
.RE
.SH "COPYING"
.sp
Copyright (C) 2013 Nico Schottelius\&. Free use of this software is granted under the terms of the GNU General Public License version 3 (GPLv3)\&.
.SH "Author"
.PP
\fBNico Schottelius\fR <\&nico\-ctt\-\-@\-\-schottelius\&.org\&>
.RS 4
Author.
.RE