add manpage
Signed-off-by: Nico Schottelius <nico@bento.schottelius.org>
This commit is contained in:
Nico Schottelius
parent
ab362be637
commit
7b83d22a08
4 changed files with 110 additions and 138 deletions
3
.gitignore
vendored
3
.gitignore
vendored
|
|
@ -1 +1,4 @@
|
|||
lib/ctt/__pycache__/
|
||||
|
||||
# Manpages
|
||||
*.1
|
||||
|
|
|
|||
8
Makefile
8
Makefile
|
|
@ -1,4 +1,12 @@
|
|||
all: ctt.1
|
||||
|
||||
clean:
|
||||
rm -f *.1
|
||||
|
||||
pub:
|
||||
git push --mirror
|
||||
git push --mirror github
|
||||
|
||||
|
||||
%.1: %.text
|
||||
a2x -f manpage --no-xmllint -a encoding=UTF-8 $<
|
||||
|
|
|
|||
139
README
139
README
|
|
@ -1,140 +1,3 @@
|
|||
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).
|
||||
Type "make" to generate the manpage.
|
||||
|
|
|
|||
98
ctt.text
Normal file
98
ctt.text
Normal file
|
|
@ -0,0 +1,98 @@
|
|||
ctt(1)
|
||||
======
|
||||
Nico Schottelius <nico-ctt--@--schottelius.org>
|
||||
|
||||
|
||||
NAME
|
||||
----
|
||||
ctt - time tracking for geeks
|
||||
|
||||
|
||||
SYNOPSIS
|
||||
--------
|
||||
ctt [-h] [-d] [-v] {listprojects,track,report} ...
|
||||
|
||||
ctt listprojects [-h] [-d] [-v]
|
||||
|
||||
ctt track [-h] [-d] [-v] [-s START] [-e END] [-n] project
|
||||
|
||||
ctt report [-h] [-d] [-v] [--sd START] [--ed END] [-e REGEXP] [-i]
|
||||
[-f OUTPUT_FORMAT]
|
||||
project
|
||||
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
|
||||
ctt tracks time while you are working and stores the values
|
||||
in a cconfig database.
|
||||
|
||||
GENERAL OPTIONS
|
||||
---------------
|
||||
-h, --help::
|
||||
show this help message and exit
|
||||
-d, --debug::
|
||||
set log level to debug
|
||||
-v, --verbose::
|
||||
set log level to info, be more verbose
|
||||
|
||||
|
||||
TRACK
|
||||
-----
|
||||
Tracking is started by using the **track** subcommand.
|
||||
It requires a project name to track time for.
|
||||
|
||||
Without any options it stays in the foreground and waits until
|
||||
enter is pressed and then prompts for a comment.
|
||||
|
||||
|
||||
-s START, --start START::
|
||||
start datetime (format: Y-m-d-HM)
|
||||
-e END, --end END::
|
||||
end datetime (format: Y-m-d-HM)
|
||||
-n, --no-comment::
|
||||
disable comment prompting after tracking
|
||||
|
||||
|
||||
REPORT
|
||||
------
|
||||
|
||||
LISTPROJECTS
|
||||
------------
|
||||
|
||||
EXAMPLES
|
||||
--------
|
||||
|
||||
--------------------------------------------------------------------------------
|
||||
# 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
|
||||
|
||||
--------------------------------------------------------------------------------
|
||||
|
||||
BUGS
|
||||
----
|
||||
ctt is made for geeks, so it should not stand in your way.
|
||||
If it does, raise a bug.
|
||||
|
||||
SEE ALSO
|
||||
---------
|
||||
|
||||
- cconfig: http://www.nico.schottelius.org/docs/cconfig/
|
||||
|
||||
|
||||
COPYING
|
||||
-------
|
||||
Copyright \(C) 2013 Nico Schottelius. Free use of this software is
|
||||
granted under the terms of the GNU General Public License version 3 (GPLv3).
|
||||
Loading…
Reference in a new issue