summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorCraig Earls <enderw88@gmail.com>2013-04-02 11:11:20 -0700
committerCraig Earls <enderw88@gmail.com>2013-04-02 11:11:20 -0700
commit70bbc81299704b57191b1313ea44bf955345079d (patch)
treeba7269f7a0dd7ed8c2f578175eca79979b80dd50 /doc
parenteed1d8e53ea3f75f0c6a84ab744f8310a4778981 (diff)
downloadfork-ledger-70bbc81299704b57191b1313ea44bf955345079d.tar.gz
fork-ledger-70bbc81299704b57191b1313ea44bf955345079d.tar.bz2
fork-ledger-70bbc81299704b57191b1313ea44bf955345079d.zip
Initial chapter on time-keeping in ledger3.texi
Diffstat (limited to 'doc')
-rw-r--r--doc/ledger3.texi34
1 files changed, 32 insertions, 2 deletions
diff --git a/doc/ledger3.texi b/doc/ledger3.texi
index 3382ab33..91dd794f 100644
--- a/doc/ledger3.texi
+++ b/doc/ledger3.texi
@@ -75,6 +75,7 @@ twinkling in their father's CRT.
* Reporting Commands::
* Command-line Syntax::
* Budgeting and Forecasting::
+* Time Keeping::
* Value Expressions::
* Format Strings::
* Extending with Python::
@@ -6389,7 +6390,7 @@ weekly last august
@end smallexample
-@node Budgeting and Forecasting, Value Expressions, Command-line Syntax, Top
+@node Budgeting and Forecasting, Time Keeping, Command-line Syntax, Top
@chapter Budgeting and Forecasting
@menu
@@ -6485,8 +6486,37 @@ only, and not against the running total:
ledger --forecast "d<[2010]" bal ^assets ^liabilities
@end example
+@node Time Keeping, Value Expressions, Budgeting and Forecasting, Top
+@chapter Time Keeping
-@node Value Expressions, Format Strings, Budgeting and Forecasting, Top
+
+Ledger directly supports ``timelog'' entries, which have this form:
+
+@smallexample
+ i 2013/03/28 22:13:00 ACCOUNT[ PAYEE]
+ o 2013/03/29 03:39:00
+@end smallexample
+
+This records a check-in to the given ACCOUNT, and a check-out. You can
+be checked-in to multiple accounts at a time, if you wish, and they can
+span multiple days (use @code{--day-break} to break them up in the
+report). The number of seconds between is accumulated as time to that
+ACCOUNT. If the checkout uses a capital ``O'', the transaction is marked
+``cleared''. You can use an optional PAYEE for whatever meaning you like.
+
+Now, there are a few ways to generate this information. You can use the
+@file{timeclock.el} package, which is part of Emacs. Or you can write a
+simple script in whichever language you prefer to emit similar
+information. Or you can use Org-mode's time-clocking abilities and the
+org2tc script developed by John Wiegly.
+
+These timelog entries can appear in a separate file, or directly in your
+main ledger file. The initial "i" and "o" count as Ledger "directives",
+and are accepted anywhere that ordinary transactions are.
+
+
+
+@node Value Expressions, Format Strings, Time Keeping, Top
@chapter Value Expressions
Ledger uses value expressions to make calculations for many different