docs: updates

This commit is contained in:
Simon Michael 2009-11-25 15:21:42 +00:00
parent 020c70928d
commit 5c6979c338

19
README
View File

@ -123,6 +123,7 @@ these commands and options::
-p, --period EXPR report on entries during the specified period -p, --period EXPR report on entries during the specified period
and/or with the specified reporting interval and/or with the specified reporting interval
-C, --cleared report only on cleared entries -C, --cleared report only on cleared entries
-U, --uncleared consider only uncleared transactions
-R, --real report only on real (non-virtual) transactions -R, --real report only on real (non-virtual) transactions
Output customization: Output customization:
@ -320,16 +321,21 @@ euro::
expenses:foreign currency €100 @ $1.35 expenses:foreign currency €100 @ $1.35
Alternatively, you can add "P" historical price records to declare a Alternatively, you can add "P" historical price records to declare a
commodity's unit price (rate) as of a particular date. Eg, on this date commodity's unit price (conversion rate) as of a particular date. Eg, on
the exchange rate for 1 us dollar was 12.8 mexican pesos:: this date the exchange rate for 1 us dollar was 12.8 mexican pesos::
P 2009/11/25 $ 12.8418 MXN P 2009/11/25 $ 12.8418 MXN
and the above price will apply to all dollar transactions made on or after and the above price will apply to all dollar transactions made on or after
that date (until a more recent price record is found.) Note, unlike c++ that date (until a more recent price record is found.)
ledger the rate is considered fixed as of the transaction date; this is
good for (eg) tracking foreign currency expenses, but not for tracking Unlike c++ ledger, we assume a fixed rate for each amount based on the
investments with fluctuating value and capital gains. posting date; this is good for (eg) tracking foreign currency expenses,
but not for tracking fluctuating investments and capital gains.
The print command shows all conversion rates in effect. Otherwise, rates
are not shown, but you can use the ``--cost`` or ``-B`` flag with any
report to convert all amounts to their total cost price.
Miscellaneous Tips Miscellaneous Tips
@ -360,7 +366,6 @@ entries, and the following options and commands::
Report filtering: Report filtering:
-c, --current show only current and past entries (not future) -c, --current show only current and past entries (not future)
--period-sort EXPR sort each report period's entries by EXPR --period-sort EXPR sort each report period's entries by EXPR
-U, --uncleared consider only uncleared transactions
-L, --actual consider only actual (non-automated) transactions -L, --actual consider only actual (non-automated) transactions
-r, --related calculate report using related transactions -r, --related calculate report using related transactions
--budget generate budget entries based on periodic entries --budget generate budget entries based on periodic entries