summaryrefslogtreecommitdiff
path: root/doc/Ledger.scriv/141.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/141.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/141.rtfd')
-rw-r--r--doc/Ledger.scriv/141.rtfd/TXT.rtf54
1 files changed, 54 insertions, 0 deletions
diff --git a/doc/Ledger.scriv/141.rtfd/TXT.rtf b/doc/Ledger.scriv/141.rtfd/TXT.rtf
new file mode 100644
index 00000000..2af93d34
--- /dev/null
+++ b/doc/Ledger.scriv/141.rtfd/TXT.rtf
@@ -0,0 +1,54 @@
+{\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 These options affect how commodity values are displayed:\
+\
+@option\{--price-db FILE\} sets the file that is used for recording\
+downloaded commodity prices. It is always read on startup, to\
+determine historical prices. Other settings can be placed in this\
+file manually, to prevent downloading quotes for a specific, for\
+example. This is done by adding a line like the following:\
+\
+@example\
+; Don't download quotes for the dollar, or timelog values\
+N $\
+N h\
+@end example\
+\
+@option\{--price-exp MINS\} (@option\{-L MINS\}) sets the expected\
+freshness of price quotes, in minutes. That is, if the last known\
+quote for any commodity is older than this value---and if\
+@option\{--download\} is being used---then the Internet will be\
+consulted again for a newer price. Otherwise, the old price is still\
+considered to be fresh enough.\
+\
+@option\{--download\} (@option\{-Q\}) causes quotes to be automagically\
+downloaded, as needed, by running a script named @command\{getquote\}\
+and expecting that script to return a value understood by ledger. A\
+sample implementation of a @command\{getquote\} script, implemented in\
+Perl, is provided in the distribution. Downloaded quote price are\
+then appended to the price database, usually specified using the\
+environment variable @env\{LEDGER_PRICE_DB\}.\
+\
+There are several different ways that ledger can report the totals it\
+displays. The most flexible way to adjust them is by using value\
+expressions, and the @option\{-t\} and @option\{-T\} options. However,\
+there are also several ``default'' reports, which will satisfy most\
+users basic reporting needs:\
+\
+@table @code\
+@item -O, --quantity\
+Reports commodity totals (this is the default)\
+\
+@item -B, --basis\
+Reports the cost basis for all postings.\
+\
+@item -V, --market\
+Reports the last known market value for all commodities.\
+\
+@item -G --gain\
+Reports the net gain/loss for all commodities in the report that have\
+a price history.\
+@end table} \ No newline at end of file