ctt/README
Nico Schottelius 8e1402190c update readme
Signed-off-by: Nico Schottelius <nico@brief.schottelius.org>
2012-10-31 18:10:20 +01:00

140 lines
2.7 KiB
Text

ctt - time tracking for geeks
Nico Schottelius, 2012
ctt is made for geeks, so it should not stand in your way.
ctt -t|--track
ctt --start "date"
ctt --start "date" --stop "otherdate"
Save to ~/.ctt/times/<project>/
Dateformat:
YYYY-MM-DD
Report:
ctt(1)
======
Nico Schottelius <nico-ctt--@--schottelius.org>
NAME
----
ctt - time tracking for geeks
SYNOPSIS
--------
ctt [-h] [-V]
ctt track [-h] [-d] [-v] [-s START] [-e END] project
ctt report [-h] [-d] [-v] [-s START] [-e END] project
TIME TRACKING
-------------
If you start ctt with a project name, ctt will begin right away to
track the time, until you stop it using Ctrl-C:
--------------------------------------------------------------------------------
ctt track myreport
--------------------------------------------------------------------------------
-h, --help::
Show the help screen
-V, --version::
Show version and exit
BANNER
-------
Displays the ctt banner.
CONFIG
------
Configure a system
-h, --help::
Show the help screen
-c CDIST_HOME, --ctt-home CDIST_HOME::
Instead of using the parent of the bin directory as ctt home,
use the specified directory
-d, --debug::
Enable debug output
-i MANIFEST, --initial-manifest MANIFEST::
Path to a ctt manifest or - to read from stdin
-p, --parallel::
Operate on multiple hosts in parallel
-s, --sequential::
Operate on multiple hosts sequentially
EXAMPLES
--------
--------------------------------------------------------------------------------
# Configure ikq05.ethz.ch with debug enabled
ctt config -d ikq05.ethz.ch
# Configure hosts in parallel and use a different home directory
ctt config -c ~/p/ctt-nutzung \
-p ikq02.ethz.ch ikq03.ethz.ch ikq04.ethz.ch
# Use custom remote exec / copy commands
ctt config --remote-exec /path/to/my/remote/exec \
--remote-copy /path/to/my/remote/copy \
-p ikq02.ethz.ch ikq03.ethz.ch ikq04.ethz.ch
# Display banner
ctt banner
# Show help
ctt --help
# Show Version
ctt --version
--------------------------------------------------------------------------------
ENVIRONMENT
-----------
TMPDIR, TEMP, TMP::
Setup the base directory for the temporary directory.
See http://docs.python.org/py3k/library/tempfile.html for
more information. This is rather useful, if the standard
directory used does not allow executables.
EXIT STATUS
-----------
The following exit values shall be returned:
0::
Successful completion
1::
One or more host configurations failed
SEE ALSO
--------
- ctt(7)
- ctt-reference(7)
COPYING
-------
Copyright \(C) 2011-2012 Nico Schottelius. Free use of this software is
granted under the terms of the GNU General Public License version 3 (GPLv3).