hledger/hledger-lib/hledger_timeclock.5

93 lines
2.7 KiB
Groff
Raw Normal View History

2019-09-13 21:00:03 +03:00
.TH "hledger_timeclock" "5" "September 2019" "hledger 1.15.99" "hledger User Manuals"
.SH NAME
.PP
2019-05-24 08:26:43 +03:00
Timeclock - the time logging format of timeclock.el, as read by hledger
.SH DESCRIPTION
.PP
2016-04-13 07:10:02 +03:00
hledger can read timeclock files.
As with Ledger, these are (a subset of) timeclock.el\[aq]s format,
2019-05-24 08:26:43 +03:00
containing clock-in and clock-out entries as in the example below.
The date is a simple date.
2019-05-24 08:26:43 +03:00
The time format is HH:MM[:SS][+-ZZZZ].
Seconds and timezone are optional.
The timezone, if present, must be four digits and is ignored (currently
the time is always interpreted as a local time).
.IP
.nf
\f[C]
2019-05-24 08:26:43 +03:00
i 2015/03/30 09:00:00 some:account name optional description after two spaces
o 2015/03/30 09:20:00
i 2015/03/31 22:21:45 another account
o 2015/04/01 02:00:34
\f[R]
.fi
.PP
2019-05-24 08:26:43 +03:00
hledger treats each clock-in/clock-out pair as a transaction posting
some number of hours to an account.
Or if the session spans more than one day, it is split into several
transactions, one for each day.
2019-05-24 08:26:43 +03:00
For the above time log, \f[C]hledger print\f[R] generates these journal
entries:
.IP
.nf
\f[C]
2019-05-24 08:26:43 +03:00
$ hledger -f t.timeclock print
2015/03/30 * optional description after two spaces
(some:account name) 0.33h
2019-05-24 08:26:43 +03:00
2015/03/31 * 22:21-23:59
(another account) 1.64h
2019-05-24 08:26:43 +03:00
2015/04/01 * 00:00-02:00
(another account) 2.01h
\f[R]
.fi
.PP
2016-04-13 07:10:02 +03:00
Here is a sample.timeclock to download and some queries to try:
.IP
.nf
\f[C]
2019-05-24 08:26:43 +03:00
$ hledger -f sample.timeclock balance # current time balances
$ hledger -f sample.timeclock register -p 2009/3 # sessions in march 2009
$ hledger -f sample.timeclock register -p weekly --depth 1 --empty # time summary by week
\f[R]
.fi
.PP
To generate time logs, ie to clock in and clock out, you could:
.IP \[bu] 2
2019-05-24 08:26:43 +03:00
use emacs and the built-in timeclock.el, or the extended timeclock-x.el
and perhaps the extras in ledgerutils.el
.IP \[bu] 2
at the command line, use these bash aliases:
2019-05-24 08:26:43 +03:00
\f[C]shell alias ti=\[dq]echo i \[ga]date \[aq]+%Y-%m-%d %H:%M:%S\[aq]\[ga] \[rs]$* >>$TIMELOG\[dq] alias to=\[dq]echo o \[ga]date \[aq]+%Y-%m-%d %H:%M:%S\[aq]\[ga] >>$TIMELOG\[dq]\f[R]
.IP \[bu] 2
2019-05-24 08:26:43 +03:00
or use the old \f[C]ti\f[R] and \f[C]to\f[R] scripts in the ledger 2.x
repository.
2019-05-24 08:26:43 +03:00
These rely on a \[dq]timeclock\[dq] executable which I think is just the
ledger 2 executable renamed.
.SH "REPORTING BUGS"
Report bugs at http://bugs.hledger.org
(or on the #hledger IRC channel or hledger mail list)
.SH AUTHORS
Simon Michael <simon@joyful.com> and contributors
.SH COPYRIGHT
Copyright (C) 2007-2019 Simon Michael.
.br
2016-04-13 06:31:17 +03:00
Released under GNU GPL v3 or later.
.SH SEE ALSO
hledger(1), hledger\-ui(1), hledger\-web(1), hledger\-api(1),
2016-04-13 07:10:02 +03:00
hledger_csv(5), hledger_journal(5), hledger_timeclock(5), hledger_timedot(5),
ledger(1)
http://hledger.org