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/155.snapshots | 515 +++++++++++++++++++++++++++++++ 1 file changed, 515 insertions(+) create mode 100644 doc/Ledger.scriv/snapshots/155.snapshots (limited to 'doc/Ledger.scriv/snapshots/155.snapshots') diff --git a/doc/Ledger.scriv/snapshots/155.snapshots b/doc/Ledger.scriv/snapshots/155.snapshots new file mode 100644 index 00000000..8986d45e --- /dev/null +++ b/doc/Ledger.scriv/snapshots/155.snapshots @@ -0,0 +1,515 @@ + + + + + $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 + Ledger has seven basic commands, but by far the most often used are +@command{balance} and @command{register}. To see a summary balance of +all accounts, use: + +@example +ledger bal +@end example + +@command{bal} is a short-hand for @command{balance}. This command +prints out the summary totals of the five parent accounts used in +@file{sample.dat}: + +@smallexample + $1,480.00 + 50 AAPL Assets + $-2,500.00 Equity + $20.00 Expenses + $-500.00 Income + $-2.00 Liabilities +-------------------- + $-1,502.00 + 50 AAPL +@end smallexample + +None of the child accounts are shown, just the parent account totals. +We can see that in @samp{Assets} there is $1,480.00, and 50 shares of +Apple stock. There is also a negative grand total. Usually the grand +total is zero, which means that all accounts balance@footnote{It is +impossible for accounts not to balance in ledger; it reports an error +if a posting does not balance}. In this case, since the 50 shares +of Apple stock cost $1,500.00 dollars, then these two amounts balance +each other in the grand total. The extra $2.00 comes from a virtual +posting being added by the automatic transaction at the top of the file. +The transaction is virtual because the account name was surrounded by +parentheses in an automatic transaction. Automatic transactions will be +discussed later, but first let's remove the virtual posting from +the balance report by using the @option{--real} option: + +@example +ledger --real bal +@end example + +Now the report is: + +@smallexample + $1,480.00 + 50 AAPL Assets + $-2,500.00 Equity + $20.00 Expenses + $-500.00 Income +-------------------- + $-1,500.00 + 50 AAPL +@end smallexample + +Since the liability was a virtual posting, it has dropped from the +report and we see that final total is balanced. + +But we only know that it balances because @file{sample.dat} is quite +simple, and we happen to know that the 50 shares of Apple stock cost +$1,500.00. We can verify that things really balance by reporting the +Apple shares in terms of their cost, instead of their quantity. To do +this requires the @option{--basis}, or @option{-B}, option: + +@example +ledger --real -B bal +@end example + +This command reports: + +@smallexample + $2,980.00 Assets + $-2,500.00 Equity + $20.00 Expenses + $-500.00 Income +@end smallexample + +With the basis cost option, the grand total has disappeared, as it is +now zero. The confirms that the cost of everything balances to zero, +@emph{which must always be true}. Reporting the real basis cost +should never yield a remainder@footnote{If it ever does, then +generated postings are involved, which can be removed using +@option{--actual}}. + + + $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 + 267380388.96237299 + + + $classes + + NSDate + NSObject + + $classname + NSDate + + + $classes + + NSMutableArray + NSArray + NSObject + + $classname + NSMutableArray + + + $top + + Snapshots + + CF$UID + 1 + + + $version + 100000 + + -- cgit v1.2.3