summaryrefslogtreecommitdiffstats
path: root/ledger/lib/balance
diff options
context:
space:
mode:
authortv <tv@nomic.retiolum>2013-09-11 20:14:06 +0200
committertv <tv@nomic.retiolum>2013-09-11 20:14:06 +0200
commit74961ef05afc5d06d0af192752912466021882c4 (patch)
tree8a00a0f2ce0c41a1a2cde9816db992eb150f62d1 /ledger/lib/balance
parent87b90098679c9daccd558d6df0fef508cf7a4a24 (diff)
ledger balance: add description and pipe-usage
Diffstat (limited to 'ledger/lib/balance')
-rwxr-xr-xledger/lib/balance17
1 files changed, 15 insertions, 2 deletions
diff --git a/ledger/lib/balance b/ledger/lib/balance
index f75410c3..77cb7f6d 100755
--- a/ledger/lib/balance
+++ b/ledger/lib/balance
@@ -1,7 +1,20 @@
#! /bin/awk -f
#
-# usage: [colorize=false] [scale=N] //ledger/lib/balance LEDGER_FILE...
-# see also: //cholerab/ledger-spec.markdown
+# ledger balance calculator
+#
+# usage:
+# [colorize=false] [scale=N] //ledger/lib/balance LEDGER_FILE...
+# [colorize=false] [scale=N] //ledger/lib/balance < LEDGER_FILE
+#
+# description:
+# The ledger balance calculator computes the balance of each account it
+# encounters in the provided ledger files.
+#
+# example:
+# //ledger/lib/balance < //cholerab/ledger-spec.markdown
+#
+# see also:
+# //cholerab/ledger-spec.markdown (ledger file format)
#
BEGIN {