summaryrefslogtreecommitdiff
path: root/doc/Ledger.scriv/156.rtfd
diff options
context:
space:
mode:
authorJohn Wiegley <johnw@newartisans.com>2009-10-25 23:08:07 -0400
committerJohn Wiegley <johnw@newartisans.com>2009-10-25 23:11:30 -0400
commit1f5ceb0db50df9ad0f9048ee02ad749507cbd737 (patch)
treea8609fdcd28aa4d371aebf8a9867e43014e652f1 /doc/Ledger.scriv/156.rtfd
parent9dadaebfeb461ba795124281018d0f7eac200cf4 (diff)
downloadfork-ledger-1f5ceb0db50df9ad0f9048ee02ad749507cbd737.tar.gz
fork-ledger-1f5ceb0db50df9ad0f9048ee02ad749507cbd737.tar.bz2
fork-ledger-1f5ceb0db50df9ad0f9048ee02ad749507cbd737.zip
Added beginning draft of manual for 3.0
This is being kept in Scrivener format, for ease of writing.
Diffstat (limited to 'doc/Ledger.scriv/156.rtfd')
-rw-r--r--doc/Ledger.scriv/156.rtfd/TXT.rtf57
1 files changed, 57 insertions, 0 deletions
diff --git a/doc/Ledger.scriv/156.rtfd/TXT.rtf b/doc/Ledger.scriv/156.rtfd/TXT.rtf
new file mode 100644
index 00000000..e158cd8e
--- /dev/null
+++ b/doc/Ledger.scriv/156.rtfd/TXT.rtf
@@ -0,0 +1,57 @@
+{\rtf1\ansi\ansicpg1252\cocoartf949\cocoasubrtf460
+{\fonttbl\f0\fmodern\fcharset0 Courier;}
+{\colortbl;\red255\green255\blue255;}
+\pard\tx560\tx1120\tx1680\tx2240\tx2800\tx3360\tx3920\tx4480\tx5040\tx5600\tx6160\tx6720\sl264\slmult1\ql\qnatural\pardirnatural
+
+\f0\fs28 \cf0 The totals reported by the balance command are only the topmost parent\
+accounts. To see the totals of all child accounts as well, use the\
+@option\{-s\} option:\
+\
+@example\
+ledger --real -B -s bal\
+@end example\
+\
+This reports:\
+\
+@smallexample\
+ $2,980.00 Assets\
+ $1,480.00 Bank:Checking\
+ $1,500.00 Brokerage\
+ $-2,500.00 Equity:Opening Balances\
+ $20.00 Expenses:Books\
+ $-500.00 Income:Salary\
+@end smallexample\
+\
+This shows that the @samp\{Assets\} total is made up from two child\
+account, but that the total for each of the other accounts comes from\
+one child account.\
+\
+Sometimes you may have a lot of children, nested very deeply, but only\
+want to report the first two levels. This can be done with a display\
+predicate, using a value expression. In the value expression,\
+@code\{T\} represents the reported total, and @code\{l\} is the display\
+level for the account:\
+\
+@example\
+ledger --real -B -d "T&l<=2" bal\
+@end example\
+\
+This reports:\
+\
+@smallexample\
+ $2,980.00 Assets\
+ $1,480.00 Bank\
+ $1,500.00 Brokerage\
+ $-2,500.00 Equity:Opening Balances\
+ $20.00 Expenses:Books\
+ $-500.00 Income:Salary\
+@end smallexample\
+\
+Instead of reporting @samp\{Bank:Checking\} as a child of @samp\{Assets\},\
+it report only @samp\{Bank\}, since that account is a nesting level of\
+2, while @samp\{Checking\} is at level 3.\
+\
+To review the display predicate used---@code\{T&l<=2\}---this rather\
+terse expression means: Display an account only if it has a non-zero\
+total (@code\{T\}), and its nesting level is less than or equal to 2\
+(@code\{l<=2\}).} \ No newline at end of file