From 1f5ceb0db50df9ad0f9048ee02ad749507cbd737 Mon Sep 17 00:00:00 2001 From: John Wiegley Date: Sun, 25 Oct 2009 23:08:07 -0400 Subject: Added beginning draft of manual for 3.0 This is being kept in Scrivener format, for ease of writing. --- doc/Ledger.scriv/snapshots/169.snapshots | 535 +++++++++++++++++++++++++++++++ 1 file changed, 535 insertions(+) create mode 100644 doc/Ledger.scriv/snapshots/169.snapshots (limited to 'doc/Ledger.scriv/snapshots/169.snapshots') diff --git a/doc/Ledger.scriv/snapshots/169.snapshots b/doc/Ledger.scriv/snapshots/169.snapshots new file mode 100644 index 00000000..96893461 --- /dev/null +++ b/doc/Ledger.scriv/snapshots/169.snapshots @@ -0,0 +1,535 @@ + + + + + $archiver + NSKeyedArchiver + $objects + + $null + + $class + + CF$UID + 37 + + NS.objects + + + CF$UID + 2 + + + + + $class + + CF$UID + 33 + + NS.keys + + + CF$UID + 3 + + + CF$UID + 4 + + + CF$UID + 5 + + + NS.objects + + + CF$UID + 6 + + + CF$UID + 7 + + + CF$UID + 35 + + + + Title + Text + Date + Untitled Snapshot + + $class + + CF$UID + 34 + + NSAttributes + + CF$UID + 10 + + NSDelegate + + CF$UID + 0 + + NSString + + CF$UID + 8 + + + + $class + + CF$UID + 9 + + NS.string + @c -n, --collapse register: collapse transactions with multiple postings + +When multiple postings relate to a single transaction, they are reported +as part of that transaction. For example, in the case of @file{sample.dat}: + +@example +ledger reg -- book +@end example + +Reports: + +@smallexample +2004/05/29 Book Store Expenses:Books $20.00 $20.00 + Liabilities:MasterCard $-20.00 0 + (Liabilities:Taxes) $-2.00 $-2.00 +@end smallexample + +All three postings are part of one transaction, and as such the transaction +details are printed only once. To report every transaction on a single +line, use @option{-n} to collapse transactions with multiple postings: + +@example +ledger -n reg -- book +@end example + +Reports: + +@smallexample +2004/05/29 Book Store <Total> $-2.00 $-2.00 +@end smallexample + +In the balance report, @option{-n} causes the grand total not to be +displayed at the bottom of the report. + +@c -s, --subtotal balance: show sub-accounts; other: show subtotals + +If an account occurs more than once in a report, it is possible to +combine them all and report the total per-account, using @option{-s}. +For example, this command: + +@example +ledger -B reg ^assets +@end example + +Reports: + +@smallexample +2004/05/01 Checking balance Assets:Bank:Checking $1,000.00 $1,000.00 +2004/05/01 Investment balance Assets:Brokerage $1,500.00 $2,500.00 +2004/05/14 Pay day Assets:Bank:Checking $500.00 $3,000.00 +2004/05/27 Credit card company Assets:Bank:Checking $-20.00 $2,980.00 +@end smallexample + +But if the @option{-s} option is added, the result becomes: + +@smallexample +2004/05/01 - 2004/05/29 Assets:Bank:Checking $1,480.00 $1,480.00 + Assets:Brokerage $1,500.00 $2,980.00 +@end smallexample + +When account subtotaling is used, only one transaction is printed, and the +date and name reflect the range of the combined postings. + +@c -P, --by-payee show summarized totals by payee + +With @option{-P}, postings relating to the same payee are +combined. In this case, the date of the combined transaction is that of the +latest posting. + +@c -x, --comm-as-payee set commodity name as the payee, for reporting + +@option{-x} changes the payee name for each posting to be the same +as the commodity it uses. This can be especially useful combined with +other options, like @option{-P}. For example: + +@example +ledger -Px reg ^assets +@end example + +Reports: + +@smallexample +2004/05/29 $ Assets:Bank:Checking $1,480.00 $1,480.00 +2004/05/01 AAPL Assets:Brokerage 50 AAPL $1,480.00 + 50 AAPL +@end smallexample + +This reports shows the subtotal for each commodity held, and where it +is located. To see the basis cost, or initial investment, add +@option{-B}. Applied to the example above: + +@smallexample +2004/05/29 $ Assets:Bank:Checking $1,480.00 $1,480.00 +2004/05/01 AAPL Assets:Brokerage $1,500.00 $2,980.00 +@end smallexample + +@c -E, --empty balance: show accounts with zero balance + +The only other options which affect summarized totals is @option{-E}, +which works only in the balance report. In this case, it shows +matching accounts with a zero a balance, which are ordinarily +excluded. This can be useful to see all the accounts involved in a +report, even if some have no total. + + + $classes + + NSMutableString + NSString + NSObject + + $classname + NSMutableString + + + $class + + CF$UID + 33 + + NS.keys + + + CF$UID + 11 + + + CF$UID + 12 + + + NS.objects + + + CF$UID + 13 + + + CF$UID + 30 + + + + NSParagraphStyle + NSFont + + $class + + CF$UID + 29 + + NSAlignment + 4 + NSLineHeightMultiple + 1.1000000238418579 + NSTabStops + + CF$UID + 14 + + + + $class + + CF$UID + 28 + + NS.objects + + + CF$UID + 15 + + + CF$UID + 17 + + + CF$UID + 18 + + + CF$UID + 19 + + + CF$UID + 20 + + + CF$UID + 21 + + + CF$UID + 22 + + + CF$UID + 23 + + + CF$UID + 24 + + + CF$UID + 25 + + + CF$UID + 26 + + + CF$UID + 27 + + + + + $class + + CF$UID + 16 + + NSLocation + 28 + + + $classes + + NSTextTab + NSObject + + $classname + NSTextTab + + + $class + + CF$UID + 16 + + NSLocation + 56 + + + $class + + CF$UID + 16 + + NSLocation + 84 + + + $class + + CF$UID + 16 + + NSLocation + 112 + + + $class + + CF$UID + 16 + + NSLocation + 140 + + + $class + + CF$UID + 16 + + NSLocation + 168 + + + $class + + CF$UID + 16 + + NSLocation + 196 + + + $class + + CF$UID + 16 + + NSLocation + 224 + + + $class + + CF$UID + 16 + + NSLocation + 252 + + + $class + + CF$UID + 16 + + NSLocation + 280 + + + $class + + CF$UID + 16 + + NSLocation + 308 + + + $class + + CF$UID + 16 + + NSLocation + 336 + + + $classes + + NSArray + NSObject + + $classname + NSArray + + + $classes + + NSParagraphStyle + NSObject + + $classname + NSParagraphStyle + + + $class + + CF$UID + 32 + + NSName + + CF$UID + 31 + + NSSize + 14 + NSfFlags + 16 + + Courier + + $classes + + NSFont + NSObject + + $classname + NSFont + + + $classes + + NSDictionary + NSObject + + $classname + NSDictionary + + + $classes + + KBWordCountingTextStorage + NSTextStorage + NSMutableAttributedString + NSAttributedString + NSObject + + $classname + KBWordCountingTextStorage + + + $class + + CF$UID + 36 + + NS.time + 267380389.08146301 + + + $classes + + NSDate + NSObject + + $classname + NSDate + + + $classes + + NSMutableArray + NSArray + NSObject + + $classname + NSMutableArray + + + $top + + Snapshots + + CF$UID + 1 + + + $version + 100000 + + -- cgit v1.2.3